Struct opentelemetry::trace::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<OrderMap<Key, Value, RandomState>>,
    pub events: Option<Vec<Event, Global>>,
    pub links: Option<Vec<Link, Global>>,
    pub status: Status,
    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_api::{
    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<OrderMap<Key, Value, RandomState>>

Span attributes

events: Option<Vec<Event, Global>>

Span events

links: Option<Vec<Link, Global>>

Span Links

status: Status

Span status

sampling_result: Option<SamplingResult>

Sampling result

Implementations

impl SpanBuilder

SpanBuilder methods

pub fn from_name<T>(name: T) -> SpanBuilderwhere
    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) -> SpanBuilderwhere
    T: Into<SystemTime>,

Assign span start time

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

Assign span end time

pub fn with_attributes<I>(self, attributes: I) -> SpanBuilderwhere
    I: IntoIterator<Item = KeyValue>,

Assign span attributes from an iterable.

Check out SpanBuilder::with_attributes_map to assign span attributes via an OrderMap instance.

pub fn with_attributes_map(
    self,
    attributes: OrderMap<Key, Value, RandomState>
) -> SpanBuilder

Assign span attributes.

Check out SpanBuilder::with_attributes to assign span attributes from an iterable of KeyValues.

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

Assign events

pub fn with_links(self, links: Vec<Link, Global>) -> 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>::Spanwhere
    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>::Spanwhere
    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.