Struct TelemetrySettings 

pub struct TelemetrySettings {
    pub enabled: bool,
    pub endpoint: Option<String>,
    pub service_name: String,
    pub sample_ratio: f64,
    pub log_format: LogFormat,
}

What the configuration says about tracing.

Fields

enabled: bool

Whether to join and propagate trace context.

endpoint: Option<String>

The OTLP collector, if spans should be exported.

service_name: String

What this service calls itself.

sample_ratio: f64

What fraction of locally started traces to record.

log_format: LogFormat

The shape of a log line.

Implementations

impl TelemetrySettings

pub fn from_config(config: &Config) -> Self

Read them from config.

pub fn middleware(&self) -> Option<Trace>

The middleware, or None when tracing is off.

pub fn exports(&self) -> bool

Whether spans should be exported, as opposed to only propagated.

Propagating without exporting is a perfectly good configuration — the trace id reaches every log line, which is most of the value — so an endpoint is what distinguishes the two.

impl TelemetrySettings

pub fn install_logging(&self, environment: &str, filter: &str) -> bool

Install a global subscriber in this format.

Returns whether it installed one. false means a subscriber was already set — by the application, or by an earlier boot in the same test binary — and that one is left alone, because replacing somebody else’s logging configuration is worse than not installing yours.

filter is an EnvFilter directive, usually RUST_LOG. One that does not parse falls back to info rather than refusing to log at all.

Trait Implementations

impl Clone for TelemetrySettings

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TelemetrySettings

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

Formats the value using the given formatter.

impl PartialEq for TelemetrySettings

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for TelemetrySettings