Struct TraceSpan 

#[non_exhaustive]
pub struct TraceSpan {
    pub span_id: u64,
    pub kind: SpanKind,
    pub name: String,
    pub start_time: Option<Timestamp>,
    pub end_time: Option<Timestamp>,
    pub parent_span_id: u64,
    pub labels: HashMap<String, String>,
    /* private fields */
}

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 (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.

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

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: HashMap<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 new() -> Self

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

Sets the value of span_id.

Example

let x = TraceSpan::new().set_span_id(42_u32);

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

Sets the value of kind.

Example

use google_cloud_trace_v1::model::trace_span::SpanKind;
let x0 = TraceSpan::new().set_kind(SpanKind::RpcServer);
let x1 = TraceSpan::new().set_kind(SpanKind::RpcClient);

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

Sets the value of name.

Example

let x = TraceSpan::new().set_name("example");

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

where T: Into<Timestamp>,

Sets the value of start_time.

Example

use wkt::Timestamp;
let x = TraceSpan::new().set_start_time(Timestamp::default()/* use setters */);

pub fn set_or_clear_start_time<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of start_time.

Example

use wkt::Timestamp;
let x = TraceSpan::new().set_or_clear_start_time(Some(Timestamp::default()/* use setters */));
let x = TraceSpan::new().set_or_clear_start_time(None::<Timestamp>);

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

where T: Into<Timestamp>,

Sets the value of end_time.

Example

use wkt::Timestamp;
let x = TraceSpan::new().set_end_time(Timestamp::default()/* use setters */);

pub fn set_or_clear_end_time<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of end_time.

Example

use wkt::Timestamp;
let x = TraceSpan::new().set_or_clear_end_time(Some(Timestamp::default()/* use setters */));
let x = TraceSpan::new().set_or_clear_end_time(None::<Timestamp>);

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

Sets the value of parent_span_id.

Example

let x = TraceSpan::new().set_parent_span_id(42_u32);

pub fn set_labels<T, K, V>(self, v: T) -> Self

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Sets the value of labels.

Example

let x = TraceSpan::new().set_labels([
    ("key0", "abc"),
    ("key1", "xyz"),
]);

Trait Implementations

impl Clone for TraceSpan

fn clone(&self) -> TraceSpan

Returns a duplicate 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() -> TraceSpan

Returns the “default value” for a type.

impl Message for TraceSpan

fn typename() -> &'static str

The typename of this message.

impl PartialEq for TraceSpan

fn eq(&self, other: &TraceSpan) -> 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 StructuralPartialEq for TraceSpan