Struct TracingConfig 

pub struct TracingConfig {
    pub format: LogFormat,
    pub writer: WriterConfig,
    pub level_config: LevelConfig,
    pub features: FeatureSet,
    pub otel_config: OtelConfig,
    pub global_subscriber: bool,
}

Available on crate feature tracing_subscriber_ext only.

Main configuration builder for tracing setup Default create a new tracing configuration with sensible defaults

Fields

format: LogFormat

Output format configuration

writer: WriterConfig

Output destination configuration

level_config: LevelConfig

Level filtering configuration

features: FeatureSet

Optional features configuration

otel_config: OtelConfig

OpenTelemetry configuration

global_subscriber: bool

Whether to set the subscriber as global default

Implementations

impl TracingConfig

pub fn with_format(self, format: LogFormat) -> Self

Set the log format

pub fn with_pretty_format(self) -> Self

Use pretty formatted output (development style)

pub fn with_json_format(self) -> Self

Use JSON formatted output (production style)

pub fn with_full_format(self) -> Self

Use full formatted output

pub fn with_compact_format(self) -> Self

Use compact formatted output

pub fn with_logfmt_format(self) -> Self

Available on crate feature logfmt only.

Use logfmt formatted output (requires ‘logfmt’ feature)

pub fn with_writer(self, writer: WriterConfig) -> Self

Set the output writer

pub fn with_stdout(self) -> Self

Write logs to stdout

pub fn with_stderr(self) -> Self

Write logs to stderr

pub fn with_file<P: AsRef<Path>>(self, path: P) -> Self

Write logs to a file

pub fn with_log_directives(self, directives: impl Into<String>) -> Self

Set log directives (takes precedence over environment variables), for example if you want to set it from cli arguments (verbosity)

pub fn with_default_level(self, level: LevelFilter) -> Self

Set the default log level

pub fn with_env_fallback(self, env_var: impl Into<String>) -> Self

Add an environment variable fallback for log configuration

pub fn with_otel_trace_level(self, level: LevelFilter) -> Self

Set the OpenTelemetry trace level

pub fn with_file_names(self, enabled: bool) -> Self

Enable or disable file names in output

pub fn with_line_numbers(self, enabled: bool) -> Self

Enable or disable line numbers in output

pub fn with_thread_names(self, enabled: bool) -> Self

Enable or disable thread names in output

pub fn with_thread_ids(self, enabled: bool) -> Self

Enable or disable thread IDs in output

pub fn with_span_events(self, events: FmtSpan) -> Self

Configure span event logging

pub fn without_span_events(self) -> Self

Disable span event logging

pub fn with_uptime_timer(self, enabled: bool) -> Self

👎Deprecated: Use TracingConfig::with_timer instead

Enable or disable uptime timer (vs wall clock)

pub fn with_timer(self, timer: LogTimer) -> Self

Configure time logging (wall clock, uptime or none)

pub fn with_target_display(self, enabled: bool) -> Self

Enable or disable target display

pub fn with_otel(self, enabled: bool) -> Self

Enable or disable OpenTelemetry tracing

pub fn with_metrics(self, enabled: bool) -> Self

Enable or disable metrics collection

pub fn with_resource_config(self, config: DetectResource) -> Self

Set resource configuration for OpenTelemetry

pub fn with_global_subscriber(self, global: bool) -> Self

Set whether to initialize the subscriber as global default

When global is true (default), the subscriber is set as the global default. When false, the subscriber is set as thread-local default and the returned Guard must be kept alive to maintain the subscriber.

pub fn build_layer<S>( &self, ) -> Result<Box<dyn Layer<S> + Send + Sync + 'static>, Error>

where S: Subscriber + for<'a> LookupSpan<'a>,

Build a tracing layer with the current configuration

pub fn build_filter_layer(&self) -> Result<EnvFilter, Error>

Build a level filter layer with the current configuration

pub fn init_subscriber(self) -> Result<Guard, Error>

Initialize the tracing subscriber with this configuration

If global_subscriber is true, sets the subscriber as the global default. If false, returns a Guard that maintains the subscriber as the thread-local default.

When OpenTelemetry is disabled, the Guard will contain None for the OtelGuard.

pub fn init_subscriber_ext<F, SOut>(self, transform: F) -> Result<Guard, Error>

where SOut: Subscriber + for<'a> LookupSpan<'a> + Send + Sync, F: FnOnce(Registry) -> SOut,

transform parameter allow to customize the registry/subscriber before the setup of opentelemetry, log, logfilter.

let guard = TracingConfig::default()
   .with_json_format()
   .with_stderr()
   .init_subscriber_ext(|subscriber| subscriber.with(my_layer))?;

pub fn development() -> Self

Configuration preset for development environments

• Pretty formatting with colors
• Output to stderr
• Line numbers and thread names enabled
• Span events for NEW and CLOSE
• Full OpenTelemetry integration

pub fn production() -> Self

Configuration preset for production environments

• JSON formatting for structured logging
• Output to stdout
• Minimal metadata (no line numbers or thread names)
• No span events to reduce verbosity
• Full OpenTelemetry integration

pub fn debug() -> Self

Configuration preset for debugging

• Pretty formatting with full verbosity
• Output to stderr
• All metadata enabled
• Full span events
• Debug level logging
• Full OpenTelemetry integration

pub fn minimal() -> Self

Configuration preset for minimal logging

• Compact formatting
• Output to stdout
• No metadata or extra features
• OpenTelemetry disabled for minimal overhead

pub fn testing() -> Self

Configuration preset for testing environments

• Compact formatting for less noise
• Output to stderr to separate from test output
• Basic metadata
• OpenTelemetry disabled for speed
• non global registration (of subscriber)

Trait Implementations

impl Debug for TracingConfig

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

Formats the value using the given formatter.

impl Default for TracingConfig

fn default() -> Self

Returns the “default value” for a type.