Struct StartOptions

pub struct StartOptions { /* private fields */ }

Additional options that are passed to Tracer::span.

These options specify initial attributes of a span. All values are optional.

Examples

extern crate opentracingrust;

use std::time::SystemTime;

use opentracingrust::StartOptions;
use opentracingrust::tracers::NoopTracer;


fn main() {
    let (tracer, _) = NoopTracer::new();
    let parent = tracer.span("parent");

    let now = SystemTime::now();
    let options = StartOptions::default()
        .child_of(parent.context().clone())
        .start_time(now);
    let span = tracer.span_with_options("test", options);
}

Implementations

impl StartOptions

pub fn child_of(self, parent: SpanContext) -> Self

Declares a ChildOf relationship for the Span to be.

Examples found in repository

examples/0-quickstart.rs (line 78)

fn fibonacci(n: u64, parent: SpanContext) -> u64 {
    // To create a new span for this operation set the parent span.
    let options = StartOptions::default().child_of(parent);
    if n <= 2 {
        // Since this is the base case we finish the span immediately.
        let span = GlobalTracer::get().span_with_options("fibonacci base case", options);
        span.finish().unwrap();
        1
    } else {
        // Since this is the iterative case we recourse passing the new span's
        // context as the new parent span.
        let span = GlobalTracer::get().span_with_options("fibonacci iterative case", options);
        let n1 = fibonacci(n - 1, span.context().clone());
        let n2 = fibonacci(n - 2, span.context().clone());
        // Once the recoursive operations terminate we can close the current span.
        span.finish().unwrap();
        n1 + n2
    }
}

pub fn follows(self, parent: SpanContext) -> Self

Declares a FollowsFrom relationship for the Span to be.

pub fn reference_span(self, reference: SpanReference) -> Self

Declares any of the SpanReferences for the Span to be.

pub fn start_time(self, start_time: SystemTime) -> Self

Sets the start time for the operation.

Trait Implementations

impl Default for StartOptions

fn default() -> StartOptions

Returns a default set of StartOptions.

By default the Span will:

• Have no references, which will make it a root span.
• Have have a start time of when Tracer::span is called.