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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117

//! Span creation and management for distributed tracing.

use opentelemetry::trace::{SpanKind, Status, TraceContextExt, Tracer};
use opentelemetry::{Context, KeyValue};

/// Span builder for creating custom spans with a specific tracer.
pub struct SpanBuilder<T>
where
    T: Tracer,
    T::Span: Send + Sync + 'static,
{
    tracer: T,
    name: String,
    kind: SpanKind,
    attributes: Vec<KeyValue>,
    parent_context: Option<Context>,
}

impl<T> SpanBuilder<T>
where
    T: Tracer,
    T::Span: Send + Sync + 'static,
{
    /// Create a new span builder.
    pub fn new(tracer: T, name: impl Into<String>) -> Self {
        Self {
            tracer,
            name: name.into(),
            kind: SpanKind::Internal,
            attributes: Vec::new(),
            parent_context: None,
        }
    }

    /// Set the span kind.
    pub fn with_kind(mut self, kind: SpanKind) -> Self {
        self.kind = kind;
        self
    }

    /// Add an attribute to the span.
    pub fn with_attribute(mut self, key: impl Into<String>, value: impl Into<String>) -> Self {
        self.attributes
            .push(KeyValue::new(key.into(), value.into()));
        self
    }

    /// Set the parent context.
    pub fn with_parent_context(mut self, context: Context) -> Self {
        self.parent_context = Some(context);
        self
    }

    /// Build and start the span, returning only the context.
    pub fn start(self) -> Context {
        let mut builder = self.tracer.span_builder(self.name);
        builder.span_kind = Some(self.kind);
        builder.attributes = Some(self.attributes);

        let span = if let Some(parent) = self.parent_context {
            self.tracer.build_with_context(builder, &parent)
        } else {
            builder.start(&self.tracer)
        };

        Context::current().with_span(span)
    }
}

/// Span recorder for recording events and attributes on active spans.
pub struct SpanRecorder;

impl SpanRecorder {
    /// Record an event on the current span.
    pub fn record_event(name: impl Into<String>, attributes: Vec<KeyValue>) {
        let cx = Context::current();
        let span = cx.span();
        span.add_event(name.into(), attributes);
    }

    /// Record an error on the current span.
    pub fn record_error(error: &dyn std::error::Error) {
        let cx = Context::current();
        let span = cx.span();

        span.set_status(Status::error(error.to_string()));
        span.add_event(
            "exception",
            vec![
                KeyValue::new("exception.type", std::any::type_name_of_val(error)),
                KeyValue::new("exception.message", error.to_string()),
            ],
        );
    }

    /// Record success on the current span.
    pub fn record_success() {
        let cx = Context::current();
        let span = cx.span();
        span.set_status(Status::Ok);
    }
}

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

    #[test]
    fn test_span_builder() {
        let tracer = global::tracer("test");
        let _context = SpanBuilder::new(tracer, "test_span")
            .with_kind(SpanKind::Server)
            .with_attribute("key1", "value1")
            .start();
    }
}