Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
pellared committed Jul 12, 2021
1 parent 72e9c4e commit c82e761
Showing 1 changed file with 21 additions and 6 deletions.
27 changes: 21 additions & 6 deletions src/OpenTelemetry.Exporter.Jaeger/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,24 +29,39 @@ dotnet add package OpenTelemetry.Exporter.Jaeger
## Configuration

You can configure the `JaegerExporter` through `JaegerExporterOptions`
and environment variables. The `JaegerExporterOptions` setters
take precedence over the environment variables.

## Options Properties

The `JaegerExporter` can be configuring using the `JaegerExporterOptions`
properties:

* `AgentHost`: Usually `localhost` since an agent should usually be running on
the same machine as your application or service.
* `AgentPort`: The compact thrift protocol port of the Jaeger Agent (default
`6831`).
* `AgentHost`: The Jaeger Agent host (default `localhost`).
* `AgentPort`: The compact thrift protocol UDP port of the Jaeger Agent
(default `6831`).
* `MaxPayloadSizeInBytes`: The maximum size of each UDP packet that gets
sent to the agent. (default `4096`).
sent to the agent (default `4096`).
* `ExportProcessorType`: Whether the exporter should use
[Batch or Simple exporting processor](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/sdk.md#built-in-span-processors)
.
(default `ExportProcessorType.Batch`).
* `BatchExportProcessorOptions`: Configuration options for the batch exporter.
Only used if ExportProcessorType is set to Batch.

See the
[`TestJaegerExporter.cs`](../../examples/Console/TestJaegerExporter.cs)
for an example of how to use the exporter.

## Environment Variables

The following environment variables can be used to override the default
values of the `JaegerExporterOptions`.

| Environment variable | `JaegerExporterOptions` property |
| --------------------------------- | -------------------------------- |
| `OTEL_EXPORTER_JAEGER_AGENT_HOST` | `AgentHost` |
| `OTEL_EXPORTER_JAEGER_AGENT_PORT` | `AgentPort` |

## References

* [Jaeger](https://www.jaegertracing.io)
Expand Down

0 comments on commit c82e761

Please sign in to comment.