oxigdal-observability 0.1.6

OpenTelemetry-based observability, monitoring, and alerting for OxiGDAL
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

//! Trace exporters (Jaeger, Zipkin, OTLP).

use crate::error::{ObservabilityError, Result};

/// Trace exporter configuration.
#[derive(Debug, Clone)]
pub enum ExporterConfig {
    /// Jaeger exporter.
    Jaeger {
        /// The Jaeger collector endpoint URL.
        endpoint: String,
    },

    /// Zipkin exporter.
    Zipkin {
        /// The Zipkin collector endpoint URL.
        endpoint: String,
    },

    /// OTLP exporter.
    Otlp {
        /// The OTLP collector endpoint URL.
        endpoint: String,
    },

    /// Stdout exporter (for development).
    Stdout,
}

impl ExporterConfig {
    /// Create Jaeger exporter configuration.
    pub fn jaeger(endpoint: impl Into<String>) -> Self {
        Self::Jaeger {
            endpoint: endpoint.into(),
        }
    }

    /// Create Zipkin exporter configuration.
    pub fn zipkin(endpoint: impl Into<String>) -> Self {
        Self::Zipkin {
            endpoint: endpoint.into(),
        }
    }

    /// Create OTLP exporter configuration.
    pub fn otlp(endpoint: impl Into<String>) -> Self {
        Self::Otlp {
            endpoint: endpoint.into(),
        }
    }

    /// Validate the exporter configuration.
    pub fn validate(&self) -> Result<()> {
        match self {
            ExporterConfig::Jaeger { endpoint } => {
                if endpoint.is_empty() {
                    return Err(ObservabilityError::InvalidConfig(
                        "Jaeger endpoint cannot be empty".to_string(),
                    ));
                }
            }
            ExporterConfig::Zipkin { endpoint } => {
                if endpoint.is_empty() {
                    return Err(ObservabilityError::InvalidConfig(
                        "Zipkin endpoint cannot be empty".to_string(),
                    ));
                }
            }
            ExporterConfig::Otlp { endpoint } => {
                if endpoint.is_empty() {
                    return Err(ObservabilityError::InvalidConfig(
                        "OTLP endpoint cannot be empty".to_string(),
                    ));
                }
            }
            ExporterConfig::Stdout => {}
        }
        Ok(())
    }
}

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

    #[test]
    fn test_exporter_config() {
        let config = ExporterConfig::jaeger("localhost:6831");
        assert!(config.validate().is_ok());

        let config = ExporterConfig::jaeger("");
        assert!(config.validate().is_err());
    }
}