rskit-logging 0.2.0-alpha.2

Structured logging setup using tracing — JSON in production, pretty in dev
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79

//! Structured logging setup using the [`tracing`](https://docs.rs/tracing) ecosystem.
//!
//! # Layers
//!
//! - **Vocabulary (always available)** —
//!   [`config::LoggingConfig`] / [`config::LogFormat`] / [`config::LogOutput`] describe logging declaratively
//!   and carry no `tracing` dependency,
//!   so configuration crates can compose them without linking the subscriber stack.
//! - **Setup (`setup` feature, default-on)** — `init_logging` and friends, the `LoggingGuard`, masking,
//!   sampling, per-module levels, and context helpers.
//!   Everything built on `tracing`/`tracing-subscriber` lives here.
//!
//! # Usage
//!
//! ```ignore
//! use rskit_logging::init_logging;
//!
//! let _guard = init_logging(&config.service.logging)?;
//! // _guard must stay alive for the duration of the program
//! tracing::info!(service = "my-svc", "started");
//! ```
//!
//! # Design
//!
//! There is intentionally no global logger registry (unlike gokit's `logger.Get(name)`).
//! Callers use `tracing` directly and scope context via spans + `#[tracing::instrument]`.
//! `init_logging` installs a scoped default subscriber;
//! the returned guard restores the previous subscriber on drop.

#![warn(missing_docs)]

/// Logging configuration vocabulary (tracing-free, always available).
pub mod config;
/// Error helpers for logging setup.
pub mod error;
/// Standard field name constants for the unified log schema.
pub mod fields;

/// Span-level context helpers — component tagging, request enrichment.
#[cfg(feature = "setup")]
pub mod context;
/// Sensitive data masking for log output.
#[cfg(feature = "setup")]
pub mod masking;
/// Per-module log level overrides from config.
#[cfg(feature = "setup")]
pub mod module_levels;
/// OpenTelemetry Logs bridge with OTLP export.
#[cfg(feature = "otlp")]
pub mod otlp;
/// Rate-based log sampling layer.
#[cfg(feature = "setup")]
pub mod sampling;
/// Subscriber setup — building and installing `tracing` subscribers.
#[cfg(feature = "setup")]
pub mod setup;

pub use config::{LogFormat, LogOutput, LoggingConfig};
pub use error::LoggingResult;

#[cfg(feature = "setup")]
pub use masking::{DefaultMasker, Masker, MaskingConfig, MaskingMakeWriter};
#[cfg(feature = "setup")]
pub use module_levels::{ModuleLevelsConfig, build_env_filter};
#[cfg(feature = "otlp")]
pub use otlp::{OtlpConfig, OtlpProvider};
#[cfg(feature = "setup")]
pub use sampling::SamplingConfig;
#[cfg(feature = "setup")]
pub use setup::{
    LoggingGuard, init_logging, init_logging_env, init_logging_with_masking,
    init_logging_with_options,
};
#[cfg(feature = "otlp")]
pub use setup::{LoggingSetup, init_logging_full};

// Logging macros exposed by this crate.
#[cfg(feature = "setup")]
pub use tracing::{debug, error, info, instrument, trace, warn};