Struct google_api_proto::google::devtools::cloudtrace::v1::TraceSpan

pub struct TraceSpan {
    pub span_id: u64,
    pub kind: i32,
    pub name: String,
    pub start_time: Option<Timestamp>,
    pub end_time: Option<Timestamp>,
    pub parent_span_id: u64,
    pub labels: BTreeMap<String, String>,
}

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.

Fields

span_id: u64

Identifier for the span. Must be a 64-bit integer other than 0 and unique within a trace. For example, 2205310701640571284.

kind: i32

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.

name: 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.

start_time: Option<Timestamp>

Start time of the span in nanoseconds from the UNIX epoch.

end_time: Option<Timestamp>

End time of the span in nanoseconds from the UNIX epoch.

parent_span_id: u64

Optional. ID of the parent span, if any.

labels: BTreeMap<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

Implementations

impl TraceSpan

pub fn kind(&self) -> SpanKind

Returns the enum value of kind, or the default if the field is set to an invalid enum value.

pub fn set_kind(&mut self, value: SpanKind)

Sets kind to the provided enum value.

Trait Implementations

impl Clone for TraceSpan

fn clone(&self) -> TraceSpan

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TraceSpan

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for TraceSpan

fn default() -> Self

Returns the “default value” for a type.

impl Message for TraceSpan

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for TraceSpan

fn eq(&self, other: &TraceSpan) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for TraceSpan