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

//! Error helpers for logging setup.

/// Result type returned by fallible logging setup APIs.
pub type LoggingResult<T> = rskit_errors::AppResult<T>;

#[cfg(feature = "setup")]
pub(crate) fn invalid_regex(
    pattern: impl Into<String>,
    cause: regex::Error,
) -> rskit_errors::AppError {
    use rskit_errors::{AppError, ErrorCode};
    let pattern = pattern.into();
    AppError::new(ErrorCode::InvalidFormat, "invalid masking regex pattern")
        .with_detail("pattern", pattern)
        .with_cause(cause)
}

#[cfg(feature = "setup")]
pub(crate) fn log_file_open(
    path: impl Into<String>,
    cause: std::io::Error,
) -> rskit_errors::AppError {
    let path = path.into();
    rskit_errors::AppError::from(cause)
        .context("open log output file")
        .with_detail("path", path)
}

#[cfg(feature = "otlp")]
pub(crate) fn invalid_protocol(protocol: impl Into<String>) -> rskit_errors::AppError {
    let protocol = protocol.into();
    rskit_errors::AppError::invalid_input("otlp.protocol", "expected `grpc` or `http`")
        .with_detail("protocol", protocol)
}

#[cfg(feature = "otlp")]
pub(crate) fn grpc_headers_not_supported() -> rskit_errors::AppError {
    rskit_errors::AppError::invalid_input(
        "otlp.headers",
        "custom headers are supported only with the `http` OTLP protocol",
    )
}

#[cfg(feature = "otlp")]
pub(crate) fn otlp_exporter(
    cause: impl std::error::Error + Send + Sync + 'static,
) -> rskit_errors::AppError {
    rskit_errors::AppError::external_service("otlp", cause)
}

#[cfg(feature = "otlp")]
pub(crate) fn otlp_shutdown(
    cause: impl std::error::Error + Send + Sync + 'static,
) -> rskit_errors::AppError {
    rskit_errors::AppError::external_service("otlp", cause).context("shutdown logging exporter")
}