Class: Google::Devtools::Cloudtrace::V1::TraceSpan
- Inherits:
-
Object
- Object
- Google::Devtools::Cloudtrace::V1::TraceSpan
- Defined in:
- lib/google/cloud/trace/v1/doc/google/devtools/cloudtrace/v1/trace.rb
Overview
A span represents a single timed event within a trace. Spans can be nested and form a trace tree. Often, a trace contains a root span that describes the end-to-end latency of an operation and, optionally, one or more subspans for its suboperations. Spans do not need to be contiguous. There may be gaps between spans in a trace.
Defined Under Namespace
Modules: SpanKind
Instance Attribute Summary collapse
-
#end_time ⇒ Google::Protobuf::Timestamp
End time of the span in nanoseconds from the UNIX epoch.
-
#kind ⇒ Google::Devtools::Cloudtrace::V1::TraceSpan::SpanKind
Distinguishes between spans generated in a particular context.
-
#labels ⇒ Hash{String => String}
Collection of labels associated with the span.
-
#name ⇒ String
Name of the trace.
-
#parent_span_id ⇒ Integer
ID of the parent span, if any.
-
#span_id ⇒ Integer
Identifier for the span.
-
#start_time ⇒ Google::Protobuf::Timestamp
Start time of the span in nanoseconds from the UNIX epoch.
Instance Attribute Details
#end_time ⇒ Google::Protobuf::Timestamp
Returns End time of the span in nanoseconds from the UNIX epoch.
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 |
# File 'lib/google/cloud/trace/v1/doc/google/devtools/cloudtrace/v1/trace.rb', line 74 class TraceSpan # Type of span. Can be used to specify additional relationships between spans # in addition to a parent/child relationship. module SpanKind # Unspecified. SPAN_KIND_UNSPECIFIED = 0 # Indicates that the span covers server-side handling of an RPC or other # remote network request. RPC_SERVER = 1 # Indicates that the span covers the client-side wrapper around an RPC or # other remote request. RPC_CLIENT = 2 end end |
#kind ⇒ Google::Devtools::Cloudtrace::V1::TraceSpan::SpanKind
Returns Distinguishes between spans generated in a particular context. For example, two spans with the same name may be distinguished using +RPC_CLIENT+ and +RPC_SERVER+ to identify queueing latency associated with the span.
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 |
# File 'lib/google/cloud/trace/v1/doc/google/devtools/cloudtrace/v1/trace.rb', line 74 class TraceSpan # Type of span. Can be used to specify additional relationships between spans # in addition to a parent/child relationship. module SpanKind # Unspecified. SPAN_KIND_UNSPECIFIED = 0 # Indicates that the span covers server-side handling of an RPC or other # remote network request. RPC_SERVER = 1 # Indicates that the span covers the client-side wrapper around an RPC or # other remote request. RPC_CLIENT = 2 end end |
#labels ⇒ Hash{String => String}
Returns Collection of labels associated with the span.
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 |
# File 'lib/google/cloud/trace/v1/doc/google/devtools/cloudtrace/v1/trace.rb', line 74 class TraceSpan # Type of span. Can be used to specify additional relationships between spans # in addition to a parent/child relationship. module SpanKind # Unspecified. SPAN_KIND_UNSPECIFIED = 0 # Indicates that the span covers server-side handling of an RPC or other # remote network request. RPC_SERVER = 1 # Indicates that the span covers the client-side wrapper around an RPC or # other remote request. RPC_CLIENT = 2 end end |
#name ⇒ String
Returns Name of the trace. The trace name is sanitized and displayed in the Stackdriver Trace tool in the Google Developers Console. The name may be a method name or some other per-call site name. For the same executable and the same call point, a best practice is to use a consistent name, which makes it easier to correlate cross-trace spans.
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 |
# File 'lib/google/cloud/trace/v1/doc/google/devtools/cloudtrace/v1/trace.rb', line 74 class TraceSpan # Type of span. Can be used to specify additional relationships between spans # in addition to a parent/child relationship. module SpanKind # Unspecified. SPAN_KIND_UNSPECIFIED = 0 # Indicates that the span covers server-side handling of an RPC or other # remote network request. RPC_SERVER = 1 # Indicates that the span covers the client-side wrapper around an RPC or # other remote request. RPC_CLIENT = 2 end end |
#parent_span_id ⇒ Integer
Returns ID of the parent span, if any. Optional.
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 |
# File 'lib/google/cloud/trace/v1/doc/google/devtools/cloudtrace/v1/trace.rb', line 74 class TraceSpan # Type of span. Can be used to specify additional relationships between spans # in addition to a parent/child relationship. module SpanKind # Unspecified. SPAN_KIND_UNSPECIFIED = 0 # Indicates that the span covers server-side handling of an RPC or other # remote network request. RPC_SERVER = 1 # Indicates that the span covers the client-side wrapper around an RPC or # other remote request. RPC_CLIENT = 2 end end |
#span_id ⇒ Integer
Returns Identifier for the span. Must be a 64-bit integer other than 0 and unique within a trace.
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 |
# File 'lib/google/cloud/trace/v1/doc/google/devtools/cloudtrace/v1/trace.rb', line 74 class TraceSpan # Type of span. Can be used to specify additional relationships between spans # in addition to a parent/child relationship. module SpanKind # Unspecified. SPAN_KIND_UNSPECIFIED = 0 # Indicates that the span covers server-side handling of an RPC or other # remote network request. RPC_SERVER = 1 # Indicates that the span covers the client-side wrapper around an RPC or # other remote request. RPC_CLIENT = 2 end end |
#start_time ⇒ Google::Protobuf::Timestamp
Returns Start time of the span in nanoseconds from the UNIX epoch.
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 |
# File 'lib/google/cloud/trace/v1/doc/google/devtools/cloudtrace/v1/trace.rb', line 74 class TraceSpan # Type of span. Can be used to specify additional relationships between spans # in addition to a parent/child relationship. module SpanKind # Unspecified. SPAN_KIND_UNSPECIFIED = 0 # Indicates that the span covers server-side handling of an RPC or other # remote network request. RPC_SERVER = 1 # Indicates that the span covers the client-side wrapper around an RPC or # other remote request. RPC_CLIENT = 2 end end |