Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add OTLP http metrics export #4842

Merged
merged 3 commits into from
Apr 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions .changesets/feat_bryn_enable_otelp_http_metrics.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
### Add OTLP http metrics export ([Issue #4559](https://github.com/apollographql/router/issues/4559))

Users can now export metrics via OTLP Http in addition to the existing OTLP Grpc

Activate this by setting the `protocol` to `http` in your your `router.yaml`:

```
telemetry:
exporters:
metrics:
otlp:
enabled: true
protocol: http
```

By [@BrynCooke](https://github.com/BrynCooke) in https://github.com/apollographql/router/pull/4842
112 changes: 99 additions & 13 deletions Cargo.lock
Original file line number Diff line number Diff line change
Expand Up @@ -325,13 +325,14 @@ dependencies = [
"nu-ansi-term 0.49.0",
"num-traits",
"once_cell",
"opentelemetry",
"opentelemetry 0.20.0",
"opentelemetry-aws",
"opentelemetry-datadog",
"opentelemetry-http",
"opentelemetry-jaeger",
"opentelemetry-otlp",
"opentelemetry-prometheus",
"opentelemetry-proto 0.5.0",
"opentelemetry-semantic-conventions",
"opentelemetry-stdout",
"opentelemetry-zipkin",
Expand Down Expand Up @@ -3011,6 +3012,12 @@ dependencies = [
"url",
]

[[package]]
name = "glob"
version = "0.3.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "d2fabcfbdc87f4758337ca535fb41a6d701b65693ce38287d856d1674551ec9b"

[[package]]
name = "globset"
version = "0.4.13"
Expand Down Expand Up @@ -4427,7 +4434,22 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "9591d937bc0e6d2feb6f71a559540ab300ea49955229c347a517a28d27784c54"
dependencies = [
"opentelemetry_api",
"opentelemetry_sdk",
"opentelemetry_sdk 0.20.0",
]

[[package]]
name = "opentelemetry"
version = "0.22.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "900d57987be3f2aeb70d385fff9b27fb74c5723cc9a52d904d4f9c807a0667bf"
dependencies = [
"futures-core",
"futures-sink",
"js-sys",
"once_cell",
"pin-project-lite",
"thiserror",
"urlencoding",
]

[[package]]
Expand All @@ -4451,7 +4473,7 @@ dependencies = [
"indexmap 1.9.3",
"itertools 0.10.5",
"once_cell",
"opentelemetry",
"opentelemetry 0.20.0",
"opentelemetry-http",
"opentelemetry-semantic-conventions",
"reqwest",
Expand Down Expand Up @@ -4484,7 +4506,7 @@ dependencies = [
"futures-util",
"headers",
"http 0.2.11",
"opentelemetry",
"opentelemetry 0.20.0",
"opentelemetry-http",
"opentelemetry-semantic-conventions",
"reqwest",
Expand All @@ -4502,10 +4524,10 @@ dependencies = [
"futures-core",
"http 0.2.11",
"opentelemetry-http",
"opentelemetry-proto",
"opentelemetry-proto 0.3.0",
"opentelemetry-semantic-conventions",
"opentelemetry_api",
"opentelemetry_sdk",
"opentelemetry_sdk 0.20.0",
"prost 0.11.9",
"reqwest",
"thiserror",
Expand All @@ -4521,7 +4543,7 @@ checksum = "c7d81bc254e2d572120363a2b16cdb0d715d301b5789be0cfc26ad87e4e10e53"
dependencies = [
"once_cell",
"opentelemetry_api",
"opentelemetry_sdk",
"opentelemetry_sdk 0.20.0",
"prometheus",
"protobuf",
]
Expand All @@ -4533,18 +4555,32 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "b1e3f814aa9f8c905d0ee4bde026afd3b2577a97c10e1699912e3e44f0c4cbeb"
dependencies = [
"opentelemetry_api",
"opentelemetry_sdk",
"opentelemetry_sdk 0.20.0",
"prost 0.11.9",
"tonic 0.9.2",
]

[[package]]
name = "opentelemetry-proto"
version = "0.5.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "3a8fddc9b68f5b80dae9d6f510b88e02396f006ad48cac349411fbecc80caae4"
dependencies = [
"hex",
"opentelemetry 0.22.0",
"opentelemetry_sdk 0.22.1",
"prost 0.12.3",
"serde",
"tonic 0.11.0",
]

[[package]]
name = "opentelemetry-semantic-conventions"
version = "0.12.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "73c9f9340ad135068800e7f1b24e9e09ed9e7143f5bf8518ded3d3ec69789269"
dependencies = [
"opentelemetry",
"opentelemetry 0.20.0",
]

[[package]]
Expand All @@ -4555,7 +4591,7 @@ checksum = "8bd550321bc0f9d3f6dcbfe5c75262789de5b3e2776da2cbcfd2392aa05db0c6"
dependencies = [
"futures-util",
"opentelemetry_api",
"opentelemetry_sdk",
"opentelemetry_sdk 0.20.0",
"ordered-float 3.9.2",
"serde",
"serde_json",
Expand All @@ -4571,7 +4607,7 @@ dependencies = [
"futures-core",
"http 0.2.11",
"once_cell",
"opentelemetry",
"opentelemetry 0.20.0",
"opentelemetry-http",
"opentelemetry-semantic-conventions",
"reqwest",
Expand Down Expand Up @@ -4621,6 +4657,26 @@ dependencies = [
"tokio-stream",
]

[[package]]
name = "opentelemetry_sdk"
version = "0.22.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "9e90c7113be649e31e9a0f8b5ee24ed7a16923b322c3c5ab6367469c049d6b7e"
dependencies = [
"async-trait",
"crossbeam-channel",
"futures-channel",
"futures-executor",
"futures-util",
"glob",
"once_cell",
"opentelemetry 0.22.0",
"ordered-float 4.2.0",
"percent-encoding",
"rand 0.8.5",
"thiserror",
]

[[package]]
name = "option-ext"
version = "0.2.0"
Expand All @@ -4645,6 +4701,15 @@ dependencies = [
"num-traits",
]

[[package]]
name = "ordered-float"
version = "4.2.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "a76df7075c7d4d01fdcb46c912dd17fba5b60c78ea480b475f2b6ab6f666584e"
dependencies = [
"num-traits",
]

[[package]]
name = "outref"
version = "0.5.1"
Expand Down Expand Up @@ -7062,6 +7127,27 @@ dependencies = [
"tracing",
]

[[package]]
name = "tonic"
version = "0.11.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "76c4eb7a4e9ef9d4763600161f12f5070b92a578e1b634db88a6887844c91a13"
dependencies = [
"async-trait",
"base64 0.21.7",
"bytes",
"http 0.2.11",
"http-body",
"percent-encoding",
"pin-project",
"prost 0.12.3",
"tokio",
"tokio-stream",
"tower-layer",
"tower-service",
"tracing",
]

[[package]]
name = "tonic-build"
version = "0.9.2"
Expand Down Expand Up @@ -7219,8 +7305,8 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "75327c6b667828ddc28f5e3f169036cb793c3f588d83bf0f262a7f062ffed3c8"
dependencies = [
"once_cell",
"opentelemetry",
"opentelemetry_sdk",
"opentelemetry 0.20.0",
"opentelemetry_sdk 0.20.0",
"smallvec",
"tracing",
"tracing-core",
Expand Down
1 change: 1 addition & 0 deletions apollo-router/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -295,6 +295,7 @@ num-traits = "0.2.18"
once_cell = "1.19.0"
opentelemetry-stdout = { version = "0.1.0", features = ["trace"] }
opentelemetry = { version = "0.20.0", features = ["testing"] }
opentelemetry-proto = { version="0.5.0", features = ["metrics", "trace", "gen-tonic-messages", "with-serde"] }
p256 = "0.13.2"
rand_core = "0.6.4"
reqwest = { version = "0.11.24", default-features = false, features = [
Expand Down
69 changes: 20 additions & 49 deletions apollo-router/src/plugins/telemetry/metrics/otlp.rs
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
use opentelemetry::runtime;
use opentelemetry::sdk::metrics::PeriodicReader;
use opentelemetry::sdk::metrics::View;
use opentelemetry_otlp::HttpExporterBuilder;
use opentelemetry_otlp::MetricsExporterBuilder;
use opentelemetry_otlp::TonicExporterBuilder;
use tower::BoxError;

use crate::plugins::telemetry::config::MetricsCommon;
Expand All @@ -12,27 +10,6 @@ use crate::plugins::telemetry::metrics::MetricsBuilder;
use crate::plugins::telemetry::metrics::MetricsConfigurator;
use crate::plugins::telemetry::otlp::TelemetryDataKind;

// TODO Remove MetricExporterBuilder once upstream issue is fixed
// This has to exist because Http is not currently supported for metrics export
// https://github.com/open-telemetry/opentelemetry-rust/issues/772
struct MetricExporterBuilder {
exporter: Option<TonicExporterBuilder>,
}

impl From<TonicExporterBuilder> for MetricExporterBuilder {
fn from(exporter: TonicExporterBuilder) -> Self {
Self {
exporter: Some(exporter),
}
}
}

impl From<HttpExporterBuilder> for MetricExporterBuilder {
fn from(_exporter: HttpExporterBuilder) -> Self {
Self { exporter: None }
}
}

impl MetricsConfigurator for super::super::otlp::Config {
fn enabled(&self) -> bool {
self.enabled
Expand All @@ -43,36 +20,30 @@ impl MetricsConfigurator for super::super::otlp::Config {
mut builder: MetricsBuilder,
metrics_config: &MetricsCommon,
) -> Result<MetricsBuilder, BoxError> {
let exporter: MetricExporterBuilder = self.exporter(TelemetryDataKind::Metrics)?;
if !self.enabled {
return Ok(builder);
}
match exporter.exporter {
Some(exporter) => {
let exporter = MetricsExporterBuilder::Tonic(exporter).build_metrics_exporter(
(&self.temporality).into(),
Box::new(
CustomAggregationSelector::builder()
.boundaries(metrics_config.buckets.clone())
.build(),
),
)?;
let exporter_builder: MetricsExporterBuilder = self.exporter(TelemetryDataKind::Metrics)?;
let exporter = exporter_builder.build_metrics_exporter(
(&self.temporality).into(),
Box::new(
CustomAggregationSelector::builder()
.boundaries(metrics_config.buckets.clone())
.build(),
),
)?;

builder.public_meter_provider_builder =
builder.public_meter_provider_builder.with_reader(
PeriodicReader::builder(exporter, runtime::Tokio)
.with_interval(self.batch_processor.scheduled_delay)
.with_timeout(self.batch_processor.max_export_timeout)
.build(),
);
for metric_view in metrics_config.views.clone() {
let view: Box<dyn View> = metric_view.try_into()?;
builder.public_meter_provider_builder =
builder.public_meter_provider_builder.with_view(view);
}
Ok(builder)
}
None => Err("otlp metric export does not support http yet".into()),
builder.public_meter_provider_builder = builder.public_meter_provider_builder.with_reader(
PeriodicReader::builder(exporter, runtime::Tokio)
.with_interval(self.batch_processor.scheduled_delay)
.with_timeout(self.batch_processor.max_export_timeout)
.build(),
);
for metric_view in metrics_config.views.clone() {
let view: Box<dyn View> = metric_view.try_into()?;
builder.public_meter_provider_builder =
builder.public_meter_provider_builder.with_view(view);
}
Ok(builder)
}
}
Loading
Loading