Skip to content

Commit

Permalink
otlptrace: Document supported environment variables (#2222)
Browse files Browse the repository at this point in the history
  • Loading branch information
pellared committed Sep 7, 2021
1 parent 4bfa003 commit 7aae2a0
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions exporters/otlp/otlptrace/README.md
Expand Up @@ -28,3 +28,20 @@ The `otlptracegrpc` package implements a client for the span exporter that sends
## [`otlptracehttp`](https://pkg.go.dev/go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp)

The `otlptracehttp` package implements a client for the span exporter that sends trace telemetry data to the collector using HTTP with protobuf-encoded payloads.

## Configuration

### Environment Variables

The following environment variables can be used
(instead of options objects) to override the default configuration.

| Environment variable | Option | Default value |
| ------------------------------------------------------------------------ |------------------------------ | ----------------------------------- |
| `OTEL_EXPORTER_OTLP_ENDPOINT` `OTEL_EXPORTER_OTLP_TRACES_ENDPOINT` | `WithEndpoint` `WithInsecure` | `https://localhost:4317` |
| `OTEL_EXPORTER_OTLP_CERTIFICATE` `OTEL_EXPORTER_OTLP_TRACES_CERTIFICATE` | `WithTLSClientConfig` | |
| `OTEL_EXPORTER_OTLP_HEADERS` `OTEL_EXPORTER_OTLP_TRACES_HEADERS` | `WithHeaders` | |
| `OTEL_EXPORTER_OTLP_COMPRESSION` `OTEL_EXPORTER_OTLP_TRACES_COMPRESSION` | `WithCompression` | |
| `OTEL_EXPORTER_OTLP_TIMEOUT` `OTEL_EXPORTER_OTLP_TRACES_TIMEOUT` | `WithTimeout` | `10s` |

Configuration using options have precedence over the environment variables.

0 comments on commit 7aae2a0

Please sign in to comment.