Struct Span

#[non_exhaustive]
pub struct Span {

    pub name: String,
    pub span_id: String,
    pub parent_span_id: String,
    pub display_name: Option<TruncatableString>,
    pub start_time: Option<Timestamp>,
    pub end_time: Option<Timestamp>,
    pub attributes: Option<Attributes>,
    pub stack_trace: Option<StackTrace>,
    pub time_events: Option<TimeEvents>,
    pub links: Option<Links>,
    pub status: Option<Status>,
    pub same_process_as_parent_span: Option<BoolValue>,
    pub child_span_count: Option<Int32Value>,
    pub span_kind: SpanKind,
}

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

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

span_id: String

Required. The [SPAN_ID] portion of the span’s resource name.

parent_span_id: String

The [SPAN_ID] of this span’s parent span. If this is a root span, then this field must be empty.

display_name: Option<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.

start_time: Option<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.

end_time: Option<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.

attributes: Option<Attributes>

A set of attributes on the span. You can have up to 32 attributes per span.

stack_trace: Option<StackTrace>

Stack trace captured at the start of the span.

time_events: Option<TimeEvents>

A set of time events. You can have up to 32 annotations and 128 message events per span.

links: Option<Links>

Links associated with the span. You can have up to 128 links per Span.

status: Option<Status>

Optional. The final status for this span.

same_process_as_parent_span: Option<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.

child_span_count: Option<Int32Value>

Optional. The number of child spans that were generated while this span was active. If set, allows implementation to detect missing child spans.

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

Implementations

impl Span

pub fn set_name<T: Into<String>>(self, v: T) -> Self

Sets the value of name.

pub fn set_span_id<T: Into<String>>(self, v: T) -> Self

Sets the value of span_id.

pub fn set_parent_span_id<T: Into<String>>(self, v: T) -> Self

Sets the value of parent_span_id.

pub fn set_display_name<T: Into<Option<TruncatableString>>>(self, v: T) -> Self

Sets the value of display_name.

pub fn set_start_time<T: Into<Option<Timestamp>>>(self, v: T) -> Self

Sets the value of start_time.

pub fn set_end_time<T: Into<Option<Timestamp>>>(self, v: T) -> Self

Sets the value of end_time.

pub fn set_attributes<T: Into<Option<Attributes>>>(self, v: T) -> Self

Sets the value of attributes.

pub fn set_stack_trace<T: Into<Option<StackTrace>>>(self, v: T) -> Self

Sets the value of stack_trace.

pub fn set_time_events<T: Into<Option<TimeEvents>>>(self, v: T) -> Self

Sets the value of time_events.

pub fn set_links<T: Into<Option<Links>>>(self, v: T) -> Self

Sets the value of links.

pub fn set_status<T: Into<Option<Status>>>(self, v: T) -> Self

Sets the value of status.

pub fn set_same_process_as_parent_span<T: Into<Option<BoolValue>>>( self, v: T, ) -> Self

Sets the value of same_process_as_parent_span.

pub fn set_child_span_count<T: Into<Option<Int32Value>>>(self, v: T) -> Self

Sets the value of child_span_count.

pub fn set_span_kind<T: Into<SpanKind>>(self, v: T) -> Self

Sets the value of span_kind.

Trait Implementations

impl Clone for Span

fn clone(&self) -> Span

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Span

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

Formats the value using the given formatter.

impl Default for Span

fn default() -> Span

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Span

where Span: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for Span

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Span

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Span

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Span