opentelemetry-tide 0.12.0

OpenTelemetry integration for Tide
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
140
141

#![doc = include_str!("../README.md")]
#![doc(
    test(attr(allow(unused_variables), deny(warnings))),
    html_favicon_url = "https://raw.githubusercontent.com/asaaki/opentelemetry-tide/main/.assets/favicon.ico",
    html_logo_url = "https://raw.githubusercontent.com/asaaki/opentelemetry-tide/main/.assets/docs.png"
)]
#![forbid(unsafe_code)]
#![cfg_attr(feature = "docs", feature(doc_cfg))]
#![deny(clippy::unwrap_used)]
#![deny(missing_debug_implementations)]
#![deny(missing_docs)]
#![deny(unused_imports)]
#![deny(unused_results)]
#![warn(clippy::expect_used)]

use opentelemetry::global::BoxedTracer;
const CRATE_NAME: &str = env!("CARGO_CRATE_NAME");
const VERSION: &str = env!("CARGO_PKG_VERSION");

mod middlewares;

#[cfg(any(feature = "trace", doc))]
pub use middlewares::tracing::OpenTelemetryTracingMiddleware;

#[cfg(any(feature = "metrics", doc))]
pub use middlewares::metrics::{MetricsConfig, OpenTelemetryMetricsMiddleware};

/// this extension trait provides convenience methods for attaching middlewares of this crate
pub trait TideExt<S> {
    /**
    Attaches tracing middleware with provided tracer.

    See [OpenTelemetryTracingMiddleware::new] for details.
    */
    #[cfg(any(feature = "trace", doc))]
    fn with_tracing_middleware(&mut self, tracer: BoxedTracer) -> &mut Self
    where
        S: Clone + Send + Sync + 'static;

    /**
    Attaches tracing middleware with the global tracer as default.

    See [OpenTelemetryTracingMiddleware::new] for details.
    */
    #[cfg(any(feature = "trace", doc))]
    fn with_default_tracing_middleware(&mut self) -> &mut Self
    where
        S: Clone + Send + Sync + 'static;

    /**
    Attaches metrics middleware with provided MetricsConfig.

    See [OpenTelemetryMetricsMiddleware::new] for details.
    */
    #[cfg(any(feature = "metrics", doc))]
    fn with_metrics_middleware(&mut self, config: MetricsConfig) -> &mut Self
    where
        S: Clone + Send + Sync + 'static;

    /**
    Attaches metrics middleware with default MetricsConfig.

    See [OpenTelemetryMetricsMiddleware::new] for details.
    */
    #[cfg(any(feature = "metrics", doc))]
    fn with_default_metrics_middleware(&mut self) -> &mut Self
    where
        S: Clone + Send + Sync + 'static;

    /**
    Attaches both middlewares with provided tracer and MetricsConfig.

    See [OpenTelemetryTracingMiddleware::new] and [OpenTelemetryMetricsMiddleware::new] for details.
    */
    #[cfg(any(all(feature = "trace", feature = "metrics"), doc))]
    fn with_middlewares(&mut self, tracer: BoxedTracer, config: MetricsConfig) -> &mut Self
    where
        S: Clone + Send + Sync + 'static;

    /**
    Attaches both middlewares with their defaults.

    See [OpenTelemetryTracingMiddleware::default] and [OpenTelemetryMetricsMiddleware::default] for details.
    */
    #[cfg(any(all(feature = "trace", feature = "metrics"), doc))]
    fn with_default_middlewares(&mut self) -> &mut Self
    where
        S: Clone + Send + Sync + 'static;
}

impl<S> TideExt<S> for tide::Server<S> {
    #[cfg(any(feature = "trace", doc))]
    fn with_tracing_middleware(&mut self, tracer: BoxedTracer) -> &mut Self
    where
        S: Clone + Send + Sync + 'static,
    {
        self.with(OpenTelemetryTracingMiddleware::new(tracer))
    }

    #[cfg(any(feature = "trace", doc))]
    fn with_default_tracing_middleware(&mut self) -> &mut Self
    where
        S: Clone + Send + Sync + 'static,
    {
        self.with(OpenTelemetryTracingMiddleware::default())
    }

    #[cfg(any(feature = "metrics", doc))]
    fn with_metrics_middleware(&mut self, config: MetricsConfig) -> &mut Self
    where
        S: Clone + Send + Sync + 'static,
    {
        self.with(OpenTelemetryMetricsMiddleware::new(config))
    }

    #[cfg(any(feature = "metrics", doc))]
    fn with_default_metrics_middleware(&mut self) -> &mut Self
    where
        S: Clone + Send + Sync + 'static,
    {
        self.with(OpenTelemetryMetricsMiddleware::default())
    }

    #[cfg(any(all(feature = "trace", feature = "metrics"), doc))]
    fn with_middlewares(&mut self, tracer: BoxedTracer, config: MetricsConfig) -> &mut Self
    where
        S: Clone + Send + Sync + 'static,
    {
        self.with(OpenTelemetryTracingMiddleware::new(tracer))
            .with(OpenTelemetryMetricsMiddleware::new(config))
    }

    #[cfg(any(all(feature = "trace", feature = "metrics"), doc))]
    fn with_default_middlewares(&mut self) -> &mut Self
    where
        S: Clone + Send + Sync + 'static,
    {
        self.with(OpenTelemetryTracingMiddleware::default())
            .with(OpenTelemetryMetricsMiddleware::default())
    }
}