opentelemetry_otlp/
metric.rs

1//! OTEL metric exporter
2//!
3//! Defines a [MetricExporter] to send metric data to backend via OTLP protocol.
4//!
5
6#[cfg(any(feature = "http-proto", feature = "http-json", feature = "grpc-tonic"))]
7use crate::HasExportConfig;
8
9#[cfg(any(feature = "http-proto", feature = "http-json"))]
10use crate::{exporter::http::HttpExporterBuilder, HasHttpConfig, HttpExporterBuilderSet};
11
12#[cfg(feature = "grpc-tonic")]
13use crate::{exporter::tonic::TonicExporterBuilder, HasTonicConfig, TonicExporterBuilderSet};
14
15use crate::{ExporterBuildError, NoExporterBuilderSet};
16
17use core::fmt;
18use opentelemetry_sdk::error::OTelSdkResult;
19
20use opentelemetry_sdk::metrics::{
21    data::ResourceMetrics, exporter::PushMetricExporter, Temporality,
22};
23use std::fmt::{Debug, Formatter};
24
25/// Target to which the exporter is going to send metrics, defaults to https://localhost:4317/v1/metrics.
26/// Learn about the relationship between this constant and default/spans/logs at
27/// <https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md#endpoint-urls-for-otlphttp>
28pub const OTEL_EXPORTER_OTLP_METRICS_ENDPOINT: &str = "OTEL_EXPORTER_OTLP_METRICS_ENDPOINT";
29/// Max waiting time for the backend to process each metrics batch, defaults to 10s.
30pub const OTEL_EXPORTER_OTLP_METRICS_TIMEOUT: &str = "OTEL_EXPORTER_OTLP_METRICS_TIMEOUT";
31/// Compression algorithm to use, defaults to none.
32pub const OTEL_EXPORTER_OTLP_METRICS_COMPRESSION: &str = "OTEL_EXPORTER_OTLP_METRICS_COMPRESSION";
33/// Key-value pairs to be used as headers associated with gRPC or HTTP requests
34/// for sending metrics.
35/// Example: `k1=v1,k2=v2`
36/// Note: this is only supported for HTTP.
37pub const OTEL_EXPORTER_OTLP_METRICS_HEADERS: &str = "OTEL_EXPORTER_OTLP_METRICS_HEADERS";
38
39#[derive(Debug, Default, Clone)]
40pub struct MetricExporterBuilder<C> {
41    client: C,
42    temporality: Temporality,
43}
44
45impl MetricExporterBuilder<NoExporterBuilderSet> {
46    pub fn new() -> Self {
47        MetricExporterBuilder::default()
48    }
49}
50
51impl<C> MetricExporterBuilder<C> {
52    #[cfg(feature = "grpc-tonic")]
53    pub fn with_tonic(self) -> MetricExporterBuilder<TonicExporterBuilderSet> {
54        MetricExporterBuilder {
55            client: TonicExporterBuilderSet(TonicExporterBuilder::default()),
56            temporality: self.temporality,
57        }
58    }
59
60    #[cfg(any(feature = "http-proto", feature = "http-json"))]
61    pub fn with_http(self) -> MetricExporterBuilder<HttpExporterBuilderSet> {
62        MetricExporterBuilder {
63            client: HttpExporterBuilderSet(HttpExporterBuilder::default()),
64            temporality: self.temporality,
65        }
66    }
67
68    pub fn with_temporality(self, temporality: Temporality) -> MetricExporterBuilder<C> {
69        MetricExporterBuilder {
70            client: self.client,
71            temporality,
72        }
73    }
74}
75
76#[cfg(feature = "grpc-tonic")]
77impl MetricExporterBuilder<TonicExporterBuilderSet> {
78    pub fn build(self) -> Result<MetricExporter, ExporterBuildError> {
79        let exporter = self.client.0.build_metrics_exporter(self.temporality)?;
80        opentelemetry::otel_debug!(name: "MetricExporterBuilt");
81        Ok(exporter)
82    }
83}
84
85#[cfg(any(feature = "http-proto", feature = "http-json"))]
86impl MetricExporterBuilder<HttpExporterBuilderSet> {
87    pub fn build(self) -> Result<MetricExporter, ExporterBuildError> {
88        let exporter = self.client.0.build_metrics_exporter(self.temporality)?;
89        Ok(exporter)
90    }
91}
92
93#[cfg(feature = "grpc-tonic")]
94impl HasExportConfig for MetricExporterBuilder<TonicExporterBuilderSet> {
95    fn export_config(&mut self) -> &mut crate::ExportConfig {
96        &mut self.client.0.exporter_config
97    }
98}
99
100#[cfg(any(feature = "http-proto", feature = "http-json"))]
101impl HasExportConfig for MetricExporterBuilder<HttpExporterBuilderSet> {
102    fn export_config(&mut self) -> &mut crate::ExportConfig {
103        &mut self.client.0.exporter_config
104    }
105}
106
107#[cfg(feature = "grpc-tonic")]
108impl HasTonicConfig for MetricExporterBuilder<TonicExporterBuilderSet> {
109    fn tonic_config(&mut self) -> &mut crate::TonicConfig {
110        &mut self.client.0.tonic_config
111    }
112}
113
114#[cfg(any(feature = "http-proto", feature = "http-json"))]
115impl HasHttpConfig for MetricExporterBuilder<HttpExporterBuilderSet> {
116    fn http_client_config(&mut self) -> &mut crate::exporter::http::HttpConfig {
117        &mut self.client.0.http_config
118    }
119}
120
121/// An interface for OTLP metrics clients
122pub(crate) trait MetricsClient: fmt::Debug + Send + Sync + 'static {
123    fn export(
124        &self,
125        metrics: &mut ResourceMetrics,
126    ) -> impl std::future::Future<Output = OTelSdkResult> + Send;
127    fn shutdown(&self) -> OTelSdkResult;
128}
129
130/// Export metrics in OTEL format.
131pub struct MetricExporter {
132    client: SupportedTransportClient,
133    temporality: Temporality,
134}
135
136#[derive(Debug)]
137enum SupportedTransportClient {
138    #[cfg(feature = "grpc-tonic")]
139    Tonic(crate::exporter::tonic::metrics::TonicMetricsClient),
140    #[cfg(any(feature = "http-proto", feature = "http-json"))]
141    Http(crate::exporter::http::OtlpHttpClient),
142}
143
144impl Debug for MetricExporter {
145    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
146        f.debug_struct("MetricExporter").finish()
147    }
148}
149
150impl PushMetricExporter for MetricExporter {
151    async fn export(&self, metrics: &mut ResourceMetrics) -> OTelSdkResult {
152        match &self.client {
153            #[cfg(feature = "grpc-tonic")]
154            SupportedTransportClient::Tonic(client) => client.export(metrics).await,
155            #[cfg(any(feature = "http-proto", feature = "http-json"))]
156            SupportedTransportClient::Http(client) => client.export(metrics).await,
157        }
158    }
159
160    fn force_flush(&self) -> OTelSdkResult {
161        // this component is stateless
162        Ok(())
163    }
164
165    fn shutdown(&self) -> OTelSdkResult {
166        match &self.client {
167            #[cfg(feature = "grpc-tonic")]
168            SupportedTransportClient::Tonic(client) => client.shutdown(),
169            #[cfg(any(feature = "http-proto", feature = "http-json"))]
170            SupportedTransportClient::Http(client) => client.shutdown(),
171        }
172    }
173
174    fn temporality(&self) -> Temporality {
175        self.temporality
176    }
177}
178
179impl MetricExporter {
180    /// Obtain a builder to configure a [MetricExporter].
181    pub fn builder() -> MetricExporterBuilder<NoExporterBuilderSet> {
182        MetricExporterBuilder::default()
183    }
184
185    #[cfg(feature = "grpc-tonic")]
186    pub(crate) fn from_tonic(
187        client: crate::exporter::tonic::metrics::TonicMetricsClient,
188        temporality: Temporality,
189    ) -> Self {
190        Self {
191            client: SupportedTransportClient::Tonic(client),
192            temporality,
193        }
194    }
195
196    #[cfg(any(feature = "http-proto", feature = "http-json"))]
197    pub(crate) fn from_http(
198        client: crate::exporter::http::OtlpHttpClient,
199        temporality: Temporality,
200    ) -> Self {
201        Self {
202            client: SupportedTransportClient::Http(client),
203            temporality,
204        }
205    }
206}
opentelemetry_otlp/metric.rs

opentelemetry_otlp/
metric.rs
