From dcbfb6e9d30f8eaf309f41993018843c6fc9fe96 Mon Sep 17 00:00:00 2001 From: Alex Boten Date: Tue, 20 Sep 2022 12:24:10 -0700 Subject: [PATCH] add user agent to OTLP exporter spec (#2684) * add user agent to OTLP exporter spec The following PR adds a section to the OTLP exporter about setting a user agent. This was implemented in the otel collector and provides users with additional information to troubleshoot their telemetry pipelines with. --- CHANGELOG.md | 3 +++ specification/protocol/exporter.md | 12 ++++++++++++ 2 files changed, 15 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 319ea041152..006f8f87c2d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -26,6 +26,9 @@ release. ### OpenTelemetry Protocol +- Add user agent to OTLP exporter specification + ([#2684](https://github.com/open-telemetry/opentelemetry-specification/pull/2684)) + ### SDK Configuration ### Telemetry Schemas diff --git a/specification/protocol/exporter.md b/specification/protocol/exporter.md index a3361f4ad61..1404c33fd7c 100644 --- a/specification/protocol/exporter.md +++ b/specification/protocol/exporter.md @@ -160,4 +160,16 @@ Transient errors MUST be handled with a retry strategy. This retry strategy MUST For OTLP/HTTP, the errors `408 (Request Timeout)` and `5xx (Server Errors)` are defined as transient, detailed information about errors can be found in the [HTTP failures section](otlp.md#failures). For the OTLP/gRPC, the full list of the gRPC retryable status codes can be found in the [gRPC response section](otlp.md#otlpgrpc-response). +## User Agent + +OpenTelemetry protocol exporters SHOULD emit a User-Agent header to at a minimum identify the exporter, the language of its implementation, and the version of the exporter. For example, the Python OTLP exporter version 1.2.3 would report the following: + +``` +OTel OTLP Exporter Python/1.2.3 +``` + +The format of the header SHOULD follow [RFC 7231][rfc-7231]. The conventions used for specifying the OpenTelemetry SDK language and version are available in the [Resource semantic conventions][resource-semconv]. + +[resource-semconv]: ../resource/semantic_conventions/README.md#telemetry-sdk [otlphttp-req]: otlp.md#otlphttp-request +[rfc-7231]: https://datatracker.ietf.org/doc/html/rfc7231#section-5.5.3