Skip to content

Commit

Permalink
add user agent to OTLP exporter spec (open-telemetry#2684)
Browse files Browse the repository at this point in the history
* 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.
  • Loading branch information
Alex Boten authored Sep 20, 2022
1 parent de7b0bd commit dcbfb6e
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 0 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
12 changes: 12 additions & 0 deletions specification/protocol/exporter.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit dcbfb6e

Please sign in to comment.