Cloud Trace V1 API - Class Google::Cloud::Trace::V1::TraceSpan (v1.2.0)

Reference documentation and code samples for the Cloud Trace V1 API class Google::Cloud::Trace::V1::TraceSpan.

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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#end_time

def end_time() -> ::Google::Protobuf::Timestamp
Returns

#end_time=

def end_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
Returns

#kind

def kind() -> ::Google::Cloud::Trace::V1::TraceSpan::SpanKind
Returns
  • (::Google::Cloud::Trace::V1::TraceSpan::SpanKind) — 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.

#kind=

def kind=(value) -> ::Google::Cloud::Trace::V1::TraceSpan::SpanKind
Parameter
  • value (::Google::Cloud::Trace::V1::TraceSpan::SpanKind) — 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.
Returns
  • (::Google::Cloud::Trace::V1::TraceSpan::SpanKind) — 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.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) —

    Collection of labels associated with the span. Label keys must be less than 128 bytes. Label values must be less than 16 kilobytes (10MB for /stacktrace values).

    Some predefined label keys exist, or you may create your own. When creating your own, we recommend the following formats:

    • /category/product/key for agents of well-known products (e.g. /db/mongodb/read_size).
    • short_host/path/key for domain-specific keys (e.g. foo.com/myproduct/bar)

    Predefined labels include:

    • /agent
    • /component
    • /error/message
    • /error/name
    • /http/client_city
    • /http/client_country
    • /http/client_protocol
    • /http/client_region
    • /http/host
    • /http/method
    • /http/path
    • /http/redirected_url
    • /http/request/size
    • /http/response/size
    • /http/route
    • /http/status_code
    • /http/url
    • /http/user_agent
    • /pid
    • /stacktrace
    • /tid

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) —

    Collection of labels associated with the span. Label keys must be less than 128 bytes. Label values must be less than 16 kilobytes (10MB for /stacktrace values).

    Some predefined label keys exist, or you may create your own. When creating your own, we recommend the following formats:

    • /category/product/key for agents of well-known products (e.g. /db/mongodb/read_size).
    • short_host/path/key for domain-specific keys (e.g. foo.com/myproduct/bar)

    Predefined labels include:

    • /agent
    • /component
    • /error/message
    • /error/name
    • /http/client_city
    • /http/client_country
    • /http/client_protocol
    • /http/client_region
    • /http/host
    • /http/method
    • /http/path
    • /http/redirected_url
    • /http/request/size
    • /http/response/size
    • /http/route
    • /http/status_code
    • /http/url
    • /http/user_agent
    • /pid
    • /stacktrace
    • /tid
Returns
  • (::Google::Protobuf::Map{::String => ::String}) —

    Collection of labels associated with the span. Label keys must be less than 128 bytes. Label values must be less than 16 kilobytes (10MB for /stacktrace values).

    Some predefined label keys exist, or you may create your own. When creating your own, we recommend the following formats:

    • /category/product/key for agents of well-known products (e.g. /db/mongodb/read_size).
    • short_host/path/key for domain-specific keys (e.g. foo.com/myproduct/bar)

    Predefined labels include:

    • /agent
    • /component
    • /error/message
    • /error/name
    • /http/client_city
    • /http/client_country
    • /http/client_protocol
    • /http/client_region
    • /http/host
    • /http/method
    • /http/path
    • /http/redirected_url
    • /http/request/size
    • /http/response/size
    • /http/route
    • /http/status_code
    • /http/url
    • /http/user_agent
    • /pid
    • /stacktrace
    • /tid

#name

def name() -> ::String
Returns
  • (::String) — Name of the span. Must be less than 128 bytes. The span name is sanitized and displayed in the Stackdriver Trace tool in the Google Cloud Platform 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.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Name of the span. Must be less than 128 bytes. The span name is sanitized and displayed in the Stackdriver Trace tool in the Google Cloud Platform 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.
Returns
  • (::String) — Name of the span. Must be less than 128 bytes. The span name is sanitized and displayed in the Stackdriver Trace tool in the Google Cloud Platform 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.

#parent_span_id

def parent_span_id() -> ::Integer
Returns
  • (::Integer) — Optional. ID of the parent span, if any.

#parent_span_id=

def parent_span_id=(value) -> ::Integer
Parameter
  • value (::Integer) — Optional. ID of the parent span, if any.
Returns
  • (::Integer) — Optional. ID of the parent span, if any.

#span_id

def span_id() -> ::Integer
Returns
  • (::Integer) — Identifier for the span. Must be a 64-bit integer other than 0 and unique within a trace. For example, 2205310701640571284.

#span_id=

def span_id=(value) -> ::Integer
Parameter
  • value (::Integer) — Identifier for the span. Must be a 64-bit integer other than 0 and unique within a trace. For example, 2205310701640571284.
Returns
  • (::Integer) — Identifier for the span. Must be a 64-bit integer other than 0 and unique within a trace. For example, 2205310701640571284.

#start_time

def start_time() -> ::Google::Protobuf::Timestamp
Returns

#start_time=

def start_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
Returns