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_code: Option<StatusCode>,
    pub status_message: Option<Cow<'static, str>>,
    pub sampling_result: Option<SamplingResult>,
}

Available on crate feature trace 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

events: Option<Vec<Event>>

Span events

links: Option<Vec<Link>>

Span Links

status_code: Option<StatusCode>

Span status code

status_message: Option<Cow<'static, str>>

Span status message

sampling_result: Option<SamplingResult>

Sampling result

Implementations

impl SpanBuilder

SpanBuilder methods

pub fn from_name<T: Into<Cow<'static, str>>>(name: T) -> Self

Create a new span builder from a span name

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

Specify trace id to use if no parent context exists

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

Assign span id

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

Assign span kind

pub fn with_start_time<T: Into<SystemTime>>(self, start_time: T) -> Self

Assign span start time

pub fn with_end_time<T: Into<SystemTime>>(self, end_time: T) -> Self

Assign span end time

pub fn with_attributes(self, attributes: Vec<KeyValue>) -> Self

Assign span attributes

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

Assign events

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

Assign links

pub fn with_status_code(self, code: StatusCode) -> Self

Assign status code

pub fn with_status_message<T: Into<Cow<'static, str>>>(self, message: T) -> Self

Assign status message

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

Assign sampling result

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

Builds a span with the given tracer from this configuration.

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

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

Trait Implementations

impl Clone for SpanBuilder

fn clone(&self) -> SpanBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SpanBuilder

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

Formats the value using the given formatter.

impl Default for SpanBuilder

fn default() -> SpanBuilder

Returns the “default value” for a type.