rs-zero 0.2.3

Rust-first microservice framework inspired by go-zero engineering practices
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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99

use crate::core::logging::{redaction::RedactionConfig, writer::LogWriterConfig};

/// Log output format.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum LogFormat {
    /// Human-readable text logs.
    Text,
    /// Structured JSON logs.
    Json,
}

/// Span lifecycle events emitted by the formatter.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum LogSpanEvents {
    /// Do not emit span lifecycle events.
    None,
    /// Emit span close events.
    Close,
    /// Emit span creation and close events.
    NewAndClose,
    /// Emit all supported span lifecycle events.
    Full,
}

/// Logging configuration for rs-zero services.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct LogConfig {
    /// Env filter directive, for example `info,tower_http=debug`.
    pub filter: String,
    /// Whether ANSI colors should be emitted for terminal writers.
    pub ansi: bool,
    /// Output format.
    pub format: LogFormat,
    /// Whether tracing targets should be emitted.
    pub with_target: bool,
    /// Whether the current span should be included in JSON logs.
    pub include_current_span: bool,
    /// Whether the full span list should be included in JSON logs.
    pub include_span_list: bool,
    /// Span lifecycle event verbosity.
    pub span_events: LogSpanEvents,
    /// Optional logical service name.
    pub service: Option<String>,
    /// Writer configuration.
    pub writer: LogWriterConfig,
    /// Subscriber-layer redaction applied before records reach the writer.
    pub redaction: RedactionConfig,
}

impl Default for LogConfig {
    fn default() -> Self {
        Self {
            filter: "info".to_string(),
            ansi: true,
            format: LogFormat::Text,
            with_target: true,
            include_current_span: true,
            include_span_list: false,
            span_events: LogSpanEvents::Close,
            service: None,
            writer: LogWriterConfig::Stdout,
            redaction: RedactionConfig::default(),
        }
    }
}

impl LogConfig {
    /// Returns a config using `RUST_LOG` when available, otherwise `info`.
    pub fn from_env() -> Self {
        Self {
            filter: std::env::var("RUST_LOG").unwrap_or_else(|_| "info".to_string()),
            ..Self::default()
        }
    }

    /// Sets the output format.
    pub fn with_format(mut self, format: LogFormat) -> Self {
        self.format = format;
        self
    }

    /// Sets the logical service name.
    pub fn with_service(mut self, service: impl Into<String>) -> Self {
        self.service = Some(service.into());
        self
    }

    /// Sets the log writer.
    pub fn with_writer(mut self, writer: LogWriterConfig) -> Self {
        self.writer = writer;
        self
    }

    /// Sets subscriber-layer redaction.
    pub fn with_redaction(mut self, redaction: RedactionConfig) -> Self {
        self.redaction = redaction;
        self
    }
}