rs-zero 0.1.0

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
100
101
102

use std::{collections::BTreeMap, time::Duration};

use crate::observability::{ObservabilityError, ObservabilityResult};

/// OTLP transport protocol.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum OtlpProtocol {
    /// gRPC OTLP.
    Grpc,
    /// HTTP/protobuf OTLP.
    HttpProtobuf,
}

/// OTLP traces exporter configuration.
#[derive(Debug, Clone, PartialEq)]
pub struct OtlpTraceConfig {
    /// Collector endpoint.
    pub endpoint: String,
    /// Transport protocol.
    pub protocol: OtlpProtocol,
    /// Request headers.
    pub headers: BTreeMap<String, String>,
    /// Resource attributes.
    pub resource: BTreeMap<String, String>,
    /// Sampling ratio in `[0.0, 1.0]`.
    pub sampling_ratio: f64,
    /// Export timeout.
    pub timeout: Duration,
}

impl Default for OtlpTraceConfig {
    fn default() -> Self {
        Self {
            endpoint: "http://127.0.0.1:4317".to_string(),
            protocol: OtlpProtocol::Grpc,
            headers: BTreeMap::new(),
            resource: BTreeMap::new(),
            sampling_ratio: 1.0,
            timeout: Duration::from_secs(5),
        }
    }
}

/// Handle used to flush and shut down tracing exporters.
#[derive(Debug, Clone, Default)]
pub struct TraceShutdownHandle {
    installed: bool,
}

impl TraceShutdownHandle {
    /// Creates a handle representing an installed exporter.
    pub fn installed() -> Self {
        Self { installed: true }
    }

    /// Returns whether this handle owns an installed exporter.
    pub fn is_installed(&self) -> bool {
        self.installed
    }

    /// Flushes pending spans. The default build has no external collector.
    pub fn flush(&self) -> ObservabilityResult<()> {
        Ok(())
    }

    /// Shuts down the exporter. The default build has no external collector.
    pub fn shutdown(self) -> ObservabilityResult<()> {
        Ok(())
    }
}

/// Validates and normalizes OTLP trace config.
pub fn build_otlp_trace_config(config: OtlpTraceConfig) -> ObservabilityResult<OtlpTraceConfig> {
    if config.endpoint.trim().is_empty() {
        return Err(ObservabilityError::MissingOtlpEndpoint);
    }
    Ok(config)
}

#[cfg(test)]
mod tests {
    use super::{OtlpTraceConfig, TraceShutdownHandle, build_otlp_trace_config};
    use crate::observability::ObservabilityError;

    #[test]
    fn otlp_config_requires_endpoint() {
        let error = build_otlp_trace_config(OtlpTraceConfig {
            endpoint: String::new(),
            ..OtlpTraceConfig::default()
        })
        .expect_err("endpoint");
        assert_eq!(error, ObservabilityError::MissingOtlpEndpoint);
    }

    #[test]
    fn shutdown_handle_flushes_without_collector() {
        let handle = TraceShutdownHandle::installed();
        assert!(handle.is_installed());
        handle.flush().expect("flush");
        handle.shutdown().expect("shutdown");
    }
}