Struct TelemetryConfig

pub struct TelemetryConfig {
    pub enable_otlp_tracing: bool,
    pub tokio_console: bool,
    pub json_log_output: bool,
    pub log_file: Option<String>,
    pub log_string: Option<String>,
    pub span_level: Option<Level>,
    pub panic_hook: bool,
    pub crash_on_panic: bool,
    pub prom_registry: Option<Registry>,
    pub sample_rate: f64,
    pub trace_target: Option<Vec<String>>,
}

Configuration for different logging/tracing options

• json_log_output: Output JSON logs to stdout only.
• log_file: If defined, write output to a file starting with this name, ex app.log
• log_level: error/warn/info/debug/trace, defaults to info

Fields

enable_otlp_tracing: bool

tokio_console: bool

Enables Tokio Console debugging on port 6669

json_log_output: bool

Output JSON logs.

log_file: Option<String>

If defined, write output to a file starting with this name, ex app.log

log_string: Option<String>

Log level to set, defaults to info

span_level: Option<Level>

Span level - what level of spans should be created. Note this is not same as logging level If set to None, then defaults to INFO

panic_hook: bool

Set a panic hook

crash_on_panic: bool

Crash on panic

prom_registry: Option<Registry>

Optional Prometheus registry - if present, all enabled span latencies are measured

sample_rate: f64

trace_target: Option<Vec<String>>

Add directive to include trace logs with provided target

Implementations

impl TelemetryConfig

pub fn new() -> Self

pub fn with_json(self) -> Self

pub fn with_log_level(self, log_string: &str) -> Self

pub fn with_span_level(self, span_level: Level) -> Self

pub fn with_log_file(self, filename: &str) -> Self

pub fn with_prom_registry(self, registry: &Registry) -> Self

pub fn with_sample_rate(self, rate: f64) -> Self

pub fn with_trace_target(self, target: &str) -> Self

pub fn with_env(self) -> Self

pub fn init(self) -> (TelemetryGuards, TracingHandle)

Trait Implementations

impl Clone for TelemetryConfig

fn clone(&self) -> TelemetryConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TelemetryConfig

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

Formats the value using the given formatter.

impl Default for TelemetryConfig

fn default() -> TelemetryConfig

Returns the “default value” for a type.