Skip to content

Commit

Permalink
Update OTLP SDK Config docs as per feedback (#1441)
Browse files Browse the repository at this point in the history
  • Loading branch information
cartermp authored Jun 13, 2022
1 parent 3c3feb3 commit 0aade2b
Showing 1 changed file with 52 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ endpoint for your traces, metrics, and logs.

### `OTEL_EXPORTER_OTLP_ENDPOINT`

A base endpoint URL for any signal type, with an optionall-specified port
A base endpoint URL for any signal type, with an optionally-specified port
number. Helpful for when you're sending more than one signal to the same
endpoint and want one environment variable to control the endpoint.

Expand All @@ -36,7 +36,7 @@ and logs, the following URLS are constructed from the example above:

### `OTEL_EXPORTER_OTLP_TRACES_ENDPOINT`

Endpoint URL for trace data only, with an optionall-specified port number. Must
Endpoint URL for trace data only, with an optionally-specified port number. Must
end with `v1/traces` if using OTLP/HTTP.

**Default value:**
Expand All @@ -51,7 +51,7 @@ end with `v1/traces` if using OTLP/HTTP.

### `OTEL_EXPORTER_OTLP_METRICS_ENDPOINT`

Endpoint URL for trace data only, with an optionall-specified port number. Must
Endpoint URL for trace data only, with an optionally-specified port number. Must
end with `v1/metrics` if using OTLP/HTTP.

**Default value:**
Expand All @@ -66,7 +66,7 @@ end with `v1/metrics` if using OTLP/HTTP.

### `OTEL_EXPORTER_OTLP_LOGS_ENDPOINT`

Endpoint URL for trace data only, with an optionall-specified port number. Must
Endpoint URL for trace data only, with an optionally-specified port number. Must
end with `v1/logs` if using OTLP/HTTP.

**Default value:**
Expand Down Expand Up @@ -170,3 +170,51 @@ The timeout value for all outgoing logs in milliseconds.
**Example:**

`export OTEL_EXPORTER_OTLP_LOGS_TIMEOUT=500`

### `OTEL_EXPORTER_OTLP_PROTOCOL`

Specifies the OTLP transport protocol to be used for all telemetry data.

**Default value:** SDK-dependent, but will typically be either `http/protobuf` or `grpc`.

**Example:**

`export OTEL_EXPORTER_OTLP_PROTOCOL=grpc`

Valid values are:

* `grpc` to use OTLP/gRPC
* `http/protobuf` to use OTLP/HTTP+protobuf
* `http/json` to use OTLP/HTTP+protobuf

### `OTEL_EXPORTER_OTLP_TRACES_PROTOCOL`

Specifies the OTLP transport protocol to be used for trace data.

**Default value:** SDK-dependent, but will typically be either `http/protobuf` or `grpc`.

**Example:**

`export OTEL_EXPORTER_OTLP_TRACES_PROTOCOL=grpc`

Valid values are:

* `grpc` to use OTLP/gRPC
* `http/protobuf` to use OTLP/HTTP+protobuf
* `http/json` to use OTLP/HTTP+protobuf

### `OTEL_EXPORTER_OTLP_METRICS_PROTOCOL`

Specifies the OTLP transport protocol to be used for metrics data.

**Default value:** SDK-dependent, but will typically be either `http/protobuf` or `grpc`.

**Example:**

`export OTEL_EXPORTER_OTLP_METRICS_PROTOCOL=grpc`

Valid values are:

* `grpc` to use OTLP/gRPC
* `http/protobuf` to use OTLP/HTTP+protobuf
* `http/json` to use OTLP/HTTP+protobuf

0 comments on commit 0aade2b

Please sign in to comment.