Skip to content

Commit

Permalink
add user agent to OTLP exporter spec
Browse files Browse the repository at this point in the history
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 committed Jul 21, 2022
1 parent 42081e0 commit 707b95f
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions specification/protocol/exporter.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,4 +160,15 @@ 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:

```
OpenTelemetry Exporter Python/1.2.3
```

The conventions used for specifying the 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

0 comments on commit 707b95f

Please sign in to comment.