rolly 0.16.0

Lightweight Rust observability. Hand-rolled OTLP protobuf over HTTP, built on tracing.
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

/// Span field name constants.
///
/// Use these when creating spans that OtlpLayer should capture.
/// In particular, a span field named `TRACE_ID` with a 32-char hex value
/// will be parsed by OtlpLayer's FieldCollector as the W3C trace ID.
pub mod fields {
    pub const TRACE_ID: &str = "trace_id";
    pub const SPAN_ID: &str = "span_id";
    pub const HTTP_METHOD: &str = "http.method";
    pub const HTTP_URI: &str = "http.uri";
    pub const HTTP_STATUS_CODE: &str = "http.status_code";
    pub const HTTP_LATENCY_MS: &str = "http.latency_ms";
    pub const CF_REQUEST_ID: &str = "cf.request_id";
    pub const OTEL_KIND: &str = "otel.kind";
    pub const OTEL_STATUS_CODE: &str = "otel.status_code";
    pub const OTEL_STATUS_MESSAGE: &str = "otel.status_message";
}

/// Default values for config structs.
pub mod defaults {
    pub const SERVICE_NAME: &str = "unknown_service";
    pub const SERVICE_VERSION: &str = "0.0.0";
    pub const ENVIRONMENT: &str = "development";
}

/// Default instrumentation scope values for exported OTLP data.
pub mod scope {
    pub const DEFAULT_NAME: &str = "rolly";
    pub const DEFAULT_VERSION: &str = env!("CARGO_PKG_VERSION");
}

/// Metric event name constants.
///
/// Used in `tracing::info!` events with `metric`, `type`, and `value` fields.
/// These are converted to actual metrics downstream by Vector's `log_to_metric` transform.
pub mod metrics {
    pub const REQUEST_DURATION: &str = "http.server.request.duration";
    pub const REQUEST_COUNT: &str = "http.server.request.count";
    pub const ERROR_COUNT: &str = "http.server.error.count";
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    #[allow(clippy::const_is_empty)]
    fn field_constants_are_non_empty() {
        assert!(!fields::TRACE_ID.is_empty());
        assert!(!fields::SPAN_ID.is_empty());
        assert!(!fields::HTTP_METHOD.is_empty());
        assert!(!fields::HTTP_URI.is_empty());
        assert!(!fields::HTTP_STATUS_CODE.is_empty());
        assert!(!fields::HTTP_LATENCY_MS.is_empty());
        assert!(!fields::CF_REQUEST_ID.is_empty());
        assert!(!fields::OTEL_KIND.is_empty());
        assert!(!fields::OTEL_STATUS_CODE.is_empty());
        assert!(!fields::OTEL_STATUS_MESSAGE.is_empty());
    }

    #[test]
    #[allow(clippy::const_is_empty)]
    fn metric_constants_are_non_empty() {
        assert!(!metrics::REQUEST_DURATION.is_empty());
        assert!(!metrics::REQUEST_COUNT.is_empty());
        assert!(!metrics::ERROR_COUNT.is_empty());
    }

    #[test]
    fn trace_id_constant_matches_field_collector() {
        // FieldCollector in otlp_layer.rs uses the literal "trace_id"
        assert_eq!(fields::TRACE_ID, "trace_id");
    }
}