Skip to content

Commit

Permalink
Describe OTLP exporter usage (#350)
Browse files Browse the repository at this point in the history
* Describe OTLP exporter usage

* Update USAGE.md

* Update USAGE.md
  • Loading branch information
pellared authored Feb 8, 2022
1 parent 0b528d3 commit d741e31
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion docs/USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,16 @@ The exporter is used to output the telemetry.
| `OTEL_EXPORTER_OTLP_ENDPOINT` | Target endpoint for OTLP exporter. More details [here](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md). | `http://localhost:4318` |
| `OTEL_EXPORTER_OTLP_HEADERS` | Key-value pairs to be used as headers associated with gRPC or HTTP requests. More details [here](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md). | |
| `OTEL_EXPORTER_OTLP_TIMEOUT` | Maximum time the OTLP exporter will wait for each batch export. | `1000` (ms) |
| `OTEL_EXPORTER_OTLP_PROTOCOL` | The transport protocol. Supported values: `grpc`, `http/protobuf`. | `grpc` |
| `OTEL_EXPORTER_OTLP_PROTOCOL` | The OTLP expoter transport protocol. Supported values: `grpc`, `http/protobuf`. [1] | `grpc` |
| `OTEL_EXPORTER_ZIPKIN_ENDPOINT` | Zipkin URL. | `http://localhost:8126` |

**[1]**: `OTEL_EXPORTER_OTLP_PROTOCOL` remarks:

- On .NET 5 and later, using the `grpc` OTLP exporter protocol requires the application
to reference [`Grpc.Net.Client`](https://www.nuget.org/packages/Grpc.Net.Client/).
E.g. by adding `<PackageReference Include="Grpc.Net.Client" Version="2.32.0" />` to the `.csproj` file.
- On .NET Framework, using the `grpc` OTLP exporter protocol is not supported.

### Batch Span Processor

The Batch Span Processor batches of finished spans before they are send by the exporter.
Expand Down

0 comments on commit d741e31

Please sign in to comment.