Cloud Trace V2 API - Class Google::Cloud::Trace::V2::Span (v1.1.0)

Reference documentation and code samples for the Cloud Trace V2 API class Google::Cloud::Trace::V2::Span.

A span represents a single operation within a trace. Spans can be nested to form a trace tree. Often, a trace contains a root span that describes the end-to-end latency, and one or more subspans for its sub-operations.

A trace can also contain multiple root spans, or none at all. Spans do not need to be contiguous. There might be gaps or overlaps between spans in a trace.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#attributes

def attributes() -> ::Google::Cloud::Trace::V2::Span::Attributes
Returns

#attributes=

def attributes=(value) -> ::Google::Cloud::Trace::V2::Span::Attributes
Parameter
Returns

#child_span_count

def child_span_count() -> ::Google::Protobuf::Int32Value
Returns
  • (::Google::Protobuf::Int32Value) — Optional. The number of child spans that were generated while this span was active. If set, allows implementation to detect missing child spans.

#child_span_count=

def child_span_count=(value) -> ::Google::Protobuf::Int32Value
Parameter
  • value (::Google::Protobuf::Int32Value) — Optional. The number of child spans that were generated while this span was active. If set, allows implementation to detect missing child spans.
Returns
  • (::Google::Protobuf::Int32Value) — Optional. The number of child spans that were generated while this span was active. If set, allows implementation to detect missing child spans.

#display_name

def display_name() -> ::Google::Cloud::Trace::V2::TruncatableString
Returns
  • (::Google::Cloud::Trace::V2::TruncatableString) — Required. A description of the span's operation (up to 128 bytes). Cloud Trace displays the description in the Cloud console. For example, the display name can be a qualified method name or a file name and a line number where the operation is called. A best practice is to use the same display name within an application and at the same call point. This makes it easier to correlate spans in different traces.

#display_name=

def display_name=(value) -> ::Google::Cloud::Trace::V2::TruncatableString
Parameter
  • value (::Google::Cloud::Trace::V2::TruncatableString) — Required. A description of the span's operation (up to 128 bytes). Cloud Trace displays the description in the Cloud console. For example, the display name can be a qualified method name or a file name and a line number where the operation is called. A best practice is to use the same display name within an application and at the same call point. This makes it easier to correlate spans in different traces.
Returns
  • (::Google::Cloud::Trace::V2::TruncatableString) — Required. A description of the span's operation (up to 128 bytes). Cloud Trace displays the description in the Cloud console. For example, the display name can be a qualified method name or a file name and a line number where the operation is called. A best practice is to use the same display name within an application and at the same call point. This makes it easier to correlate spans in different traces.

#end_time

def end_time() -> ::Google::Protobuf::Timestamp
Returns
  • (::Google::Protobuf::Timestamp) — Required. The end time of the span. On the client side, this is the time kept by the local machine where the span execution ends. On the server side, this is the time when the server application handler stops running.

#end_time=

def end_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
  • value (::Google::Protobuf::Timestamp) — Required. The end time of the span. On the client side, this is the time kept by the local machine where the span execution ends. On the server side, this is the time when the server application handler stops running.
Returns
  • (::Google::Protobuf::Timestamp) — Required. The end time of the span. On the client side, this is the time kept by the local machine where the span execution ends. On the server side, this is the time when the server application handler stops running.

#links

def links() -> ::Google::Cloud::Trace::V2::Span::Links
Returns

#links=

def links=(value) -> ::Google::Cloud::Trace::V2::Span::Links
Parameter
Returns

#name

def name() -> ::String
Returns
  • (::String) — Required. The resource name of the span in the following format:

    • projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/[SPAN_ID]

    [TRACE_ID] is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array. It should not be zero.

    [SPAN_ID] is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array. It should not be zero. .

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Required. The resource name of the span in the following format:

    • projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/[SPAN_ID]

    [TRACE_ID] is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array. It should not be zero.

    [SPAN_ID] is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array. It should not be zero. .

Returns
  • (::String) — Required. The resource name of the span in the following format:

    • projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/[SPAN_ID]

    [TRACE_ID] is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array. It should not be zero.

    [SPAN_ID] is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array. It should not be zero. .

#parent_span_id

def parent_span_id() -> ::String
Returns
  • (::String) — The [SPAN_ID] of this span's parent span. If this is a root span, then this field must be empty.

#parent_span_id=

def parent_span_id=(value) -> ::String
Parameter
  • value (::String) — The [SPAN_ID] of this span's parent span. If this is a root span, then this field must be empty.
Returns
  • (::String) — The [SPAN_ID] of this span's parent span. If this is a root span, then this field must be empty.

#same_process_as_parent_span

def same_process_as_parent_span() -> ::Google::Protobuf::BoolValue
Returns
  • (::Google::Protobuf::BoolValue) — Optional. Set this parameter to indicate whether this span is in the same process as its parent. If you do not set this parameter, Trace is unable to take advantage of this helpful information.

#same_process_as_parent_span=

def same_process_as_parent_span=(value) -> ::Google::Protobuf::BoolValue
Parameter
  • value (::Google::Protobuf::BoolValue) — Optional. Set this parameter to indicate whether this span is in the same process as its parent. If you do not set this parameter, Trace is unable to take advantage of this helpful information.
Returns
  • (::Google::Protobuf::BoolValue) — Optional. Set this parameter to indicate whether this span is in the same process as its parent. If you do not set this parameter, Trace is unable to take advantage of this helpful information.

#span_id

def span_id() -> ::String
Returns
  • (::String) — Required. The [SPAN_ID] portion of the span's resource name.

#span_id=

def span_id=(value) -> ::String
Parameter
  • value (::String) — Required. The [SPAN_ID] portion of the span's resource name.
Returns
  • (::String) — Required. The [SPAN_ID] portion of the span's resource name.

#span_kind

def span_kind() -> ::Google::Cloud::Trace::V2::Span::SpanKind
Returns
  • (::Google::Cloud::Trace::V2::Span::SpanKind) — Optional. Distinguishes between spans generated in a particular context. For example, two spans with the same name may be distinguished using CLIENT (caller) and SERVER (callee) to identify an RPC call.

#span_kind=

def span_kind=(value) -> ::Google::Cloud::Trace::V2::Span::SpanKind
Parameter
  • value (::Google::Cloud::Trace::V2::Span::SpanKind) — Optional. Distinguishes between spans generated in a particular context. For example, two spans with the same name may be distinguished using CLIENT (caller) and SERVER (callee) to identify an RPC call.
Returns
  • (::Google::Cloud::Trace::V2::Span::SpanKind) — Optional. Distinguishes between spans generated in a particular context. For example, two spans with the same name may be distinguished using CLIENT (caller) and SERVER (callee) to identify an RPC call.

#stack_trace

def stack_trace() -> ::Google::Cloud::Trace::V2::StackTrace
Returns

#stack_trace=

def stack_trace=(value) -> ::Google::Cloud::Trace::V2::StackTrace
Parameter
Returns

#start_time

def start_time() -> ::Google::Protobuf::Timestamp
Returns
  • (::Google::Protobuf::Timestamp) — Required. The start time of the span. On the client side, this is the time kept by the local machine where the span execution starts. On the server side, this is the time when the server's application handler starts running.

#start_time=

def start_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
  • value (::Google::Protobuf::Timestamp) — Required. The start time of the span. On the client side, this is the time kept by the local machine where the span execution starts. On the server side, this is the time when the server's application handler starts running.
Returns
  • (::Google::Protobuf::Timestamp) — Required. The start time of the span. On the client side, this is the time kept by the local machine where the span execution starts. On the server side, this is the time when the server's application handler starts running.

#status

def status() -> ::Google::Rpc::Status
Returns

#status=

def status=(value) -> ::Google::Rpc::Status
Parameter
Returns

#time_events

def time_events() -> ::Google::Cloud::Trace::V2::Span::TimeEvents
Returns

#time_events=

def time_events=(value) -> ::Google::Cloud::Trace::V2::Span::TimeEvents
Parameter
Returns