Struct Builder

pub struct Builder<R> { /* private fields */ }

Builds Honeycomb Telemetry with custom configuration values.

Methods can be chained in order to set the configuration values. The TelemetryLayer is constructed by calling build.

New instances of Builder are obtained via Builder::new_libhoney or Builder::new_stdout.

Builder::new_stdout is useful when instrumenting e.g. AWS Lambda functions. See more at AWS Lambda Instrumentation. For almost all other use cases you are probably looking for Builder::new_libhoney.

Implementations

impl Builder<StdoutReporter>

pub fn new_stdout(service_name: &'static str) -> Self

Returns a new Builder that reports data to stdout

impl Builder<LibhoneyReporter>

pub fn new_libhoney(service_name: &'static str, config: Config) -> Self

Returns a new Builder that reports data to a libhoney::Client

impl<R: Reporter> Builder<R>

pub fn with_trace_sampling(self, sample_rate: u32) -> Self

Enables sampling for the telemetry layer.

The sample_rate on the libhoney::Config is different from this in an important way. libhoney samples Event data, which is individual spans on each trace. This means that using the sampling logic in libhoney may result in missing event data or incomplete traces. Calling this function provides trace-level sampling, meaning sampling decisions are based on a modulo of the traceID, and events in a single trace will not be sampled differently. If the trace is sampled, then all spans under it will be sent to honeycomb. If a trace is not sampled, no spans or events under it will be sent. When using this trace-level sampling, when using a LibhoneyReporter the sample_rate parameter on the libhoney::Config should be set to 1, which is the default.

pub fn build(self) -> TelemetryLayer<HoneycombTelemetry<R>, SpanId, TraceId>

Constructs the configured TelemetryLayer

Trait Implementations

impl<R: Debug> Debug for Builder<R>

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

Formats the value using the given formatter.