otex 0.4.3

Macros and minimal wrappers over the opentelemetry api.
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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139

use opentelemetry::trace::{TraceContextExt, Tracer};
use opentelemetry_sdk as sdk;

pub(crate) fn init_tracing() -> sdk::trace::SdkTracerProvider {
    let mut builder = sdk::trace::TracerProviderBuilder::default();

    let export_enabled: bool = std::env::var("OTEX_EXPORT")
        .map(|s| s.to_lowercase())
        .unwrap_or("true".to_string())
        .parse()
        .unwrap_or(true);

    if export_enabled {
        let exporter = opentelemetry_otlp::SpanExporterBuilder::default()
            .with_http()
            .build()
            .expect("failed to build exporter");

        builder = builder.with_batch_exporter(exporter);
    }

    #[cfg(feature = "stdout")]
    {
        let stdout_exporter = opentelemetry_stdout::SpanExporter::default();
        builder = builder.with_batch_exporter(stdout_exporter);
    }

    builder.build()
}

/// Creates a new span with the current context as its parent
pub fn new_span(
    name: &str,
    kind: opentelemetry::trace::SpanKind,
    attributes: &[opentelemetry::KeyValue],
) -> opentelemetry::Context {
    let tracer = crate::init::tracer();
    let span_builder = tracer
        .span_builder(name.to_string())
        .with_kind(kind)
        .with_attributes(attributes.to_owned());

    let span = tracer.build(span_builder);
    opentelemetry::Context::current_with_span(span)
}

/// Creates a new span with an explicit parent context.
///
/// Use this when you need to continue a trace from an incoming request's
/// trace context (e.g., from W3C traceparent header).
///
/// # Arguments
/// * `name` - The name of the span
/// * `kind` - The kind of span (Server, Client, Internal, etc.)
/// * `attributes` - Initial attributes for the span
/// * `parent_context` - The parent context to use (e.g., from extract_context_from_headers)
///
/// # Example
/// ```ignore
/// let parent_ctx = otex::propagation::extract_context_from_headers(headers);
/// let ctx = otex::new_span_with_parent(
///     "http_request",
///     opentelemetry::trace::SpanKind::Server,
///     &[],
///     parent_ctx,
/// );
/// ```
pub fn new_span_with_parent(
    name: &str,
    kind: opentelemetry::trace::SpanKind,
    attributes: &[opentelemetry::KeyValue],
    parent_context: opentelemetry::Context,
) -> opentelemetry::Context {
    let tracer = crate::init::tracer();
    let span_builder = tracer
        .span_builder(name.to_string())
        .with_kind(kind)
        .with_attributes(attributes.to_owned());

    let span = tracer.build_with_context(span_builder, &parent_context);
    parent_context.with_span(span)
}

pub fn new_event(name: &str, attributes: &[opentelemetry::KeyValue]) {
    let context = opentelemetry::Context::current();
    context
        .span()
        .add_event(name.to_string(), attributes.to_vec());
}

pub fn new_error_event(name: &str, description: &str, attributes: &[opentelemetry::KeyValue]) {
    let context = opentelemetry::Context::current();
    context
        .span()
        .add_event(name.to_string(), attributes.to_vec());

    context.span().set_status(opentelemetry::trace::Status::error(description.to_string()));
}

#[cfg(test)]
mod test {

    use crate::{FutureExt, event, context};

    #[test]
    fn span_macro() {
        let otex = crate::init();
        {
            let parent = context!("hello", crate::trace::SpanKind::Internal, test_attr = "value");
            event!("parent event");

            let child_attr = 123;
            let mut child = context!("world", crate::trace::SpanKind::Internal, child_attr);

            event!("child event");
        }
        otex.shutdown();
    }

    #[tokio::test]
    async fn async_span() {
        let otex = crate::init();
        {
            let _parent = context!("hello", crate::trace::SpanKind::Internal, test_attr = "value").attach();
            event!("parent event");

            let child_attr = 123;
            let child = context!("world", crate::trace::SpanKind::Internal, child_attr);

            let task = async {
                event!("child event", child_name = "childevent");
            }
            .with_context(child);

            tokio::spawn(task).await.unwrap();
        }
        otex.shutdown();
    }
}