Struct SpanBuilder

pub struct SpanBuilder {
    pub trace_id: Option<TraceId>,
    pub span_id: Option<SpanId>,
    pub span_kind: Option<SpanKind>,
    pub name: Cow<'static, str>,
    pub start_time: Option<SystemTime>,
    pub end_time: Option<SystemTime>,
    pub attributes: Option<Vec<KeyValue>>,
    pub events: Option<Vec<Event>>,
    pub links: Option<Vec<Link>>,
    pub status: Status,
    pub sampling_result: Option<SamplingResult>,
}

Available on crate feature opentelemetry only.

SpanBuilder allows span attributes to be configured before the span has started.

use opentelemetry::{
    global,
    trace::{TracerProvider, SpanBuilder, SpanKind, Tracer},
};

let tracer = global::tracer("example-tracer");

// The builder can be used to create a span directly with the tracer
let _span = tracer.build(SpanBuilder {
    name: "example-span-name".into(),
    span_kind: Some(SpanKind::Server),
    ..Default::default()
});

// Or used with builder pattern
let _span = tracer
    .span_builder("example-span-name")
    .with_kind(SpanKind::Server)
    .start(&tracer);

Fields

trace_id: Option<TraceId>

Trace id, useful for integrations with external tracing systems.

span_id: Option<SpanId>

Span id, useful for integrations with external tracing systems.

span_kind: Option<SpanKind>

Span kind

name: Cow<'static, str>

Span name

start_time: Option<SystemTime>

Span start time

end_time: Option<SystemTime>

Span end time

attributes: Option<Vec<KeyValue>>

Span attributes that are provided at the span creation time. More attributes can be added afterwards. Providing duplicate keys will result in multiple attributes with the same key, as there is no de-duplication performed.

events: Option<Vec<Event>>

Span events

links: Option<Vec<Link>>

Span Links

status: Status

Span status

sampling_result: Option<SamplingResult>

Sampling result

Implementations

impl SpanBuilder

SpanBuilder methods

pub fn from_name<T>(name: T) -> SpanBuilder

where T: Into<Cow<'static, str>>,

Create a new span builder from a span name

pub fn with_trace_id(self, trace_id: TraceId) -> SpanBuilder

Specify trace id to use if no parent context exists

pub fn with_span_id(self, span_id: SpanId) -> SpanBuilder

Assign span id

pub fn with_kind(self, span_kind: SpanKind) -> SpanBuilder

Assign span kind

pub fn with_start_time<T>(self, start_time: T) -> SpanBuilder

where T: Into<SystemTime>,

Assign span start time

pub fn with_end_time<T>(self, end_time: T) -> SpanBuilder

where T: Into<SystemTime>,

Assign span end time

pub fn with_attributes<I>(self, attributes: I) -> SpanBuilder

where I: IntoIterator<Item = KeyValue>,

Assign span attributes from an iterable. Providing duplicate keys will result in multiple attributes with the same key, as there is no de-duplication performed.

pub fn with_events(self, events: Vec<Event>) -> SpanBuilder

Assign events

pub fn with_links(self, links: Vec<Link>) -> SpanBuilder

Assign links

pub fn with_status(self, status: Status) -> SpanBuilder

Assign status code

pub fn with_sampling_result( self, sampling_result: SamplingResult, ) -> SpanBuilder

Assign sampling result

pub fn start<T>(self, tracer: &T) -> <T as Tracer>::Span

where T: Tracer,

Builds a span with the given tracer from this configuration.

pub fn start_with_context<T>( self, tracer: &T, parent_cx: &Context, ) -> <T as Tracer>::Span

where T: Tracer,

Builds a span with the given tracer from this configuration and parent.

Trait Implementations

impl Clone for SpanBuilder

fn clone(&self) -> SpanBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SpanBuilder

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

Formats the value using the given formatter.

impl Default for SpanBuilder

fn default() -> SpanBuilder

Returns the “default value” for a type.