Skip to content

Commit 325922a

Browse files
committed
fix(otel): enable gzip and https OTLP export
Signed-off-by: Eric Curtin <[email protected]>
1 parent eeba0e7 commit 325922a

7 files changed

Lines changed: 111 additions & 12 deletions

File tree

‎Cargo.lock‎

Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎Cargo.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ tracing-appender = "0.2"
7070
# tonic 0.14 / prost 0.14 via opentelemetry-proto's `grpc-tonic` feature.
7171
opentelemetry = "0.32"
7272
opentelemetry_sdk = { version = "0.32", features = ["rt-tokio"] }
73-
opentelemetry-otlp = { version = "0.32", default-features = false, features = ["grpc-tonic", "trace"] }
73+
opentelemetry-otlp = { version = "0.32", default-features = false, features = ["grpc-tonic", "gzip-tonic", "tls-aws-lc", "tls-roots", "trace"] }
7474
tracing-opentelemetry = { version = "0.33", default-features = false, features = ["tracing-log"] }
7575

7676
# Metrics

‎crates/openshell-otel-test-support/Cargo.toml‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,13 @@ openshell-otel = { path = "../openshell-otel" }
1515
opentelemetry-proto = { version = "0.32", default-features = false, features = ["gen-tonic", "trace"] }
1616
tokio = { workspace = true }
1717
tokio-stream = { workspace = true }
18-
tonic = { workspace = true }
18+
tonic = { workspace = true, features = ["gzip", "tls-aws-lc"] }
1919
tracing = { workspace = true }
2020
tracing-subscriber = { workspace = true }
2121

22+
[dev-dependencies]
23+
rcgen = { workspace = true }
24+
tempfile = "3"
25+
2226
[lints]
2327
workspace = true

‎crates/openshell-otel-test-support/src/lib.rs‎

Lines changed: 33 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@ pub struct ReceivedTraces {
7171
pub service_names: Vec<String>,
7272
pub gateway_names: Vec<String>,
7373
pub compute_drivers: Vec<String>,
74+
pub encodings: Vec<String>,
7475
}
7576

7677
#[derive(Clone)]
@@ -90,6 +91,13 @@ impl TraceService for Collector {
9091
.received
9192
.lock()
9293
.unwrap_or_else(std::sync::PoisonError::into_inner);
94+
if let Some(encoding) = request
95+
.metadata()
96+
.get("grpc-encoding")
97+
.and_then(|value| value.to_str().ok())
98+
{
99+
received.encodings.push(encoding.to_string());
100+
}
93101
for resource_span in request.into_inner().resource_spans {
94102
if let Some(resource) = resource_span.resource {
95103
for attribute in resource.attributes {
@@ -133,20 +141,42 @@ pub struct OtlpTestServer {
133141

134142
impl OtlpTestServer {
135143
pub async fn start() -> Self {
144+
Self::start_with(None).await
145+
}
146+
147+
/// Serve over TLS at `https://localhost:<port>` using `identity`.
148+
pub async fn start_tls(identity: tonic::transport::Identity) -> Self {
149+
Self::start_with(Some(identity)).await
150+
}
151+
152+
async fn start_with(identity: Option<tonic::transport::Identity>) -> Self {
136153
let received = Arc::new(Mutex::new(ReceivedTraces::default()));
137154
let exported = Arc::new(tokio::sync::Notify::new());
138155
let listener = tokio::net::TcpListener::bind("127.0.0.1:0")
139156
.await
140157
.expect("OTLP test collector should bind a loopback listener");
141-
let endpoint = format!("http://{}", listener.local_addr().unwrap());
158+
let port = listener.local_addr().unwrap().port();
159+
let endpoint = if identity.is_some() {
160+
format!("https://localhost:{port}")
161+
} else {
162+
format!("http://127.0.0.1:{port}")
163+
};
142164
let collector = Collector {
143165
received: Arc::clone(&received),
144166
exported: Arc::clone(&exported),
145167
};
168+
let mut server = tonic::transport::Server::builder();
169+
if let Some(identity) = identity {
170+
server = server
171+
.tls_config(tonic::transport::ServerTlsConfig::new().identity(identity))
172+
.expect("OTLP test collector should accept its TLS identity");
173+
}
174+
let service = TraceServiceServer::new(collector)
175+
.accept_compressed(tonic::codec::CompressionEncoding::Gzip);
146176
let (shutdown, shutdown_rx) = tokio::sync::oneshot::channel();
147177
let task = tokio::spawn(async move {
148-
tonic::transport::Server::builder()
149-
.add_service(TraceServiceServer::new(collector))
178+
server
179+
.add_service(service)
150180
.serve_with_incoming_shutdown(
151181
tokio_stream::wrappers::TcpListenerStream::new(listener),
152182
async {
Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
// SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
2+
// SPDX-License-Identifier: Apache-2.0
3+
4+
//! The shared exporter delivers gzip-compressed spans to a collector over TLS.
5+
6+
use openshell_otel::{OtlpTraceConfig, ServiceName, provider_for};
7+
use openshell_otel_test_support::OtlpTestServer;
8+
use rcgen::{BasicConstraints, CertificateParams, ExtendedKeyUsagePurpose, IsCa, KeyPair};
9+
use tonic::transport::Identity;
10+
use tracing_subscriber::layer::SubscriberExt as _;
11+
12+
#[tokio::test(flavor = "multi_thread")]
13+
#[allow(unsafe_code)]
14+
async fn gzip_spans_reach_a_collector_trusted_through_platform_roots() {
15+
let ca_key = KeyPair::generate().unwrap();
16+
let mut ca_params = CertificateParams::new(Vec::<String>::new()).unwrap();
17+
ca_params.is_ca = IsCa::Ca(BasicConstraints::Unconstrained);
18+
let ca = ca_params.self_signed(&ca_key).unwrap();
19+
20+
let server_key = KeyPair::generate().unwrap();
21+
let mut server_params = CertificateParams::new(vec!["localhost".to_string()]).unwrap();
22+
server_params.extended_key_usages = vec![ExtendedKeyUsagePurpose::ServerAuth];
23+
let server_cert = server_params.signed_by(&server_key, &ca, &ca_key).unwrap();
24+
25+
let roots = tempfile::NamedTempFile::new().unwrap();
26+
std::fs::write(roots.path(), ca.pem()).unwrap();
27+
// This binary has one test, so nothing else reads the environment.
28+
unsafe {
29+
std::env::set_var("SSL_CERT_FILE", roots.path());
30+
std::env::set_var("OTEL_EXPORTER_OTLP_COMPRESSION", "gzip");
31+
}
32+
33+
let collector = OtlpTestServer::start_tls(Identity::from_pem(
34+
server_cert.pem(),
35+
server_key.serialize_pem(),
36+
))
37+
.await;
38+
let (provider, error) = provider_for(Some(OtlpTraceConfig {
39+
endpoint: collector.endpoint(),
40+
service_name: ServiceName::Fixed("tls-test"),
41+
service_version: None,
42+
resource_attributes: Vec::new(),
43+
}));
44+
assert!(error.is_none(), "{error:?}");
45+
let provider = provider.unwrap();
46+
let subscriber =
47+
tracing_subscriber::registry().with(openshell_otel::layer(&provider, "tls-test"));
48+
tracing::subscriber::with_default(subscriber, || drop(tracing::info_span!("tls.span")));
49+
provider.force_flush().unwrap();
50+
collector.wait_for_export().await;
51+
provider.shutdown().unwrap();
52+
let received = collector.shutdown().await;
53+
54+
assert!(received.spans.iter().any(|span| span.name == "tls.span"));
55+
assert_eq!(received.encodings, ["gzip"]);
56+
}

‎crates/openshell-otel/src/lib.rs‎

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,8 @@ pub use propagation::{
2525

2626
use opentelemetry::KeyValue;
2727
use opentelemetry::trace::TracerProvider as _;
28-
use opentelemetry_otlp::{SpanExporter, WithExportConfig};
28+
use opentelemetry_otlp::tonic_types::transport::ClientTlsConfig;
29+
use opentelemetry_otlp::{SpanExporter, WithExportConfig, WithTonicConfig};
2930
use opentelemetry_sdk::Resource;
3031
use opentelemetry_sdk::trace::SdkTracer;
3132
pub use opentelemetry_sdk::trace::SdkTracerProvider;
@@ -189,17 +190,19 @@ pub fn build_provider(config: &OtlpTraceConfig<'_>) -> Result<SdkTracerProvider,
189190
if endpoint.is_empty() {
190191
return Err(SetupError::EmptyEndpoint);
191192
}
192-
endpoint
193+
let uri = endpoint
193194
.parse::<http::Uri>()
194195
.map_err(|source| SetupError::InvalidEndpoint {
195196
endpoint: endpoint.to_string(),
196197
source,
197198
})?;
198199

199-
let exporter = SpanExporter::builder()
200-
.with_tonic()
201-
.with_endpoint(endpoint)
202-
.build()?;
200+
let mut builder = SpanExporter::builder().with_tonic().with_endpoint(endpoint);
201+
if uri.scheme() == Some(&http::uri::Scheme::HTTPS) {
202+
// Tonic trusts nothing by default, so enable the platform roots.
203+
builder = builder.with_tls_config(ClientTlsConfig::new().with_enabled_roots());
204+
}
205+
let exporter = builder.build()?;
203206

204207
Ok(SdkTracerProvider::builder()
205208
.with_batch_exporter(exporter)

‎docs/how-it-works/gateways/configuration.mdx‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -381,6 +381,8 @@ service_name = "openshell-gateway"
381381

382382
The transport is **OTLP over gRPC only**. HTTP/protobuf and HTTP/JSON are not supported, and `OTEL_EXPORTER_OTLP_PROTOCOL` has no effect. Point `endpoint` at a collector's gRPC receiver, conventionally port `4317`, not the HTTP receiver on `4318`. A URI alone cannot distinguish the two, so an HTTP endpoint is accepted at startup and then fails on export.
383383

384+
Use an `https://` endpoint for TLS. The gateway verifies the collector certificate against the system trust roots.
385+
384386
The OpenTelemetry SDK logs export failures after startup. Spans in a failed batch are dropped rather than retried.
385387

386388
`service_name` sets the gateway's `service.name` resource attribute and defaults to `openshell-gateway`. The gateway also reports `service.version`, `openshell.gateway.name` from the gateway's configured `name`, and `openshell.gateway.compute_driver`.
@@ -426,7 +428,8 @@ This table decides whether and where to export. How the SDK exports is controlle
426428
| `OTEL_BSP_SCHEDULE_DELAY`, `OTEL_BSP_MAX_QUEUE_SIZE`, `OTEL_BSP_MAX_EXPORT_BATCH_SIZE`, `OTEL_BSP_EXPORT_TIMEOUT` | Batch span processor tuning. |
427429
| `OTEL_RESOURCE_ATTRIBUTES` | Additional resource attributes, such as `deployment.environment=prod`. |
428430
| `OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT`, `OTEL_SPAN_EVENT_COUNT_LIMIT`, `OTEL_SPAN_LINK_COUNT_LIMIT` | Per-span limits. |
429-
| `OTEL_EXPORTER_OTLP_HEADERS`, `OTEL_EXPORTER_OTLP_COMPRESSION`, `OTEL_EXPORTER_OTLP_TIMEOUT` | Exporter transport tuning. |
431+
| `OTEL_EXPORTER_OTLP_HEADERS`, `OTEL_EXPORTER_OTLP_TIMEOUT` | Exporter transport tuning. |
432+
| `OTEL_EXPORTER_OTLP_COMPRESSION` | Set to `gzip` to compress exports. `zstd` is not supported. |
430433
| `OTEL_EXPORTER_OTLP_PROTOCOL` | No effect. The gateway is built with the gRPC exporter only. |
431434

432435
To sample 10% of traces:

0 commit comments

Comments
 (0)