Struct LoggingConfig 

pub struct LoggingConfig { /* private fields */ }

Typed configuration for Nidus logging helpers.

LoggingConfig builds tracing-subscriber subscribers and structured service/request spans. It does not install HTTP middleware by itself; pair it with tower_http::trace::TraceLayer and StructuredMakeSpan for request spans.

use nidus_http::logging::{LoggingConfig, StructuredMakeSpan};
use tower_http::trace::TraceLayer;

let logging = LoggingConfig::production("users-api")
    .version("1.2.3")
    .environment("production")
    .level_filter("info,tower_http=debug")
    .redact_header("authorization");

logging.init()?;
let trace_layer = TraceLayer::new_for_http()
    .make_span_with(StructuredMakeSpan::new(logging));

Implementations

impl LoggingConfig

pub fn production(service_name: impl Into<String>) -> Self

Creates production JSON logging config for a service.

Defaults to JSON output, info filtering, and no redacted headers.

pub fn development(service_name: impl Into<String>) -> Self

Creates development pretty logging config for a service.

This keeps the same service metadata defaults as production but uses pretty text formatting.

pub fn service_name(&self) -> &str

Returns the service name.

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

Sets the service version.

The version is included in Self::service_span and StructuredMakeSpan fields.

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

Sets the deployment environment.

The environment is included in Self::service_span and StructuredMakeSpan fields.

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

Sets the logging format.

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

Sets the tracing level filter directive.

pub fn redact_header(self, header: impl AsRef<str>) -> Self

Marks a header as redacted for application log code.

This stores redaction policy for callers via Self::redacts_header. The built-in StructuredMakeSpan does not log arbitrary request headers, so there is no automatic header scrubber to install.

pub fn redacts_header(&self, header: impl AsRef<str>) -> bool

Returns whether the config redacts a header name.

pub const fn output_format(&self) -> LoggingFormat

Returns the configured output format.

pub const fn format(&self) -> LoggingFormat

Returns the configured output format.

pub fn service_span(&self) -> Span

Creates a root service span carrying stable deployment attributes.

pub fn init(&self) -> Result<(), TryInitError>

Installs this config as the process-global tracing subscriber.

Like other tracing-subscriber global installs, this usually succeeds once per process. Tests often prefer Self::subscriber_with_writer to avoid global state.

pub fn subscriber_with_writer<W>( &self, writer: W, ) -> impl Subscriber + Send + Sync + 'static

where W: for<'writer> MakeWriter<'writer> + Clone + Send + Sync + 'static,

Builds a JSON subscriber using a caller-provided writer.

pub fn pretty_subscriber_with_writer<W>( &self, writer: W, ) -> impl Subscriber + Send + Sync + 'static

where W: for<'writer> MakeWriter<'writer> + Clone + Send + Sync + 'static,

Builds a pretty subscriber using a caller-provided writer.

Trait Implementations

impl Clone for LoggingConfig

fn clone(&self) -> LoggingConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LoggingConfig

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

Formats the value using the given formatter.