Struct opentracingrust::AutoFinishingSpan

pub struct AutoFinishingSpan(_);

A Span wrapper that finishes a span when dropped.

Panics

If the inner span fails to Span::finish correctly the AutoFinishingSpan will cause the current thread to panic when it is dropped.

Methods

impl AutoFinishingSpan

pub fn context(&self) -> &SpanContext

Access the SpanContext for the inner Span.

pub fn log(&mut self, log: Log)

Attach a log event to the span.

Methods from Deref<Target = Span>

pub fn child_of(&mut self, parent: SpanContext)

Marks this span as a child of the given context.

pub fn context(&self) -> &SpanContext

Access the SpanContext of this span.

pub fn finish_time(&mut self, finish_time: SystemTime)

Set the span finish time.

This method allows to set the finish time of an operation explicitly and still manipulate the span further. This allows to time the operation first and the populate the span with any available detail without obfuscating the duration of the real operation.

pub fn follows(&mut self, parent: SpanContext)

Marks this span as a follower of the given context.

pub fn get_baggage_item(&self, key: &str) -> Option<&String>

Attempt to fetch a baggage item by key.

If there is no item with the given key this method returns None.

pub fn log(&mut self, log: Log)

Attach a log event to the span.

pub fn operation_name(&self) -> &str

Returns the operation name.

pub fn reference_span(&mut self, reference: SpanReference)

Adds a reference to a SpanContext.

pub fn references(&self) -> &[SpanReference]

Access all referenced span contexts and their relationship.

pub fn set_baggage_item(&mut self, key: &str, value: &str)

Adds or updates the baggage items with the given key/value pair.

Baggage items are forwarded to Spans that reference this Span and all the Spans that reference them.

Baggage items are NOT propagated backwards to Spans that reference this Span.

pub fn set_operation_name(&mut self, name: &str)

Updates the operation name.

pub fn tag<TV: Into<TagValue>>(&mut self, tag: &str, value: TV)

Append a tag to the span.

Examples

extern crate opentracingrust;

use opentracingrust::tracers::NoopTracer;


fn main() {
    let (tracer, _) = NoopTracer::new();
    let mut span = tracer.span("some_work");
    span.tag("client.name", "some-tracing-client");
    span.tag("client.version", 3.4);
    // ... snip ...
}

Trait Implementations

impl Drop for AutoFinishingSpan

fn drop(&mut self)

Executes the destructor for this type.

impl AsMut<Span> for AutoFinishingSpan

fn as_mut(&mut self) -> &mut Span

Performs the conversion.

impl DerefMut for AutoFinishingSpan

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Deref for AutoFinishingSpan

type Target = Span

The resulting type after dereferencing.

fn deref(&self) -> &Span

Dereferences the value.

impl Debug for AutoFinishingSpan

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

Formats the value using the given formatter.