Skip to content

Commit

Permalink
Updating ReadMEs for Jaeger, Zipkin, OTLP exporters (#1591)
Browse files Browse the repository at this point in the history
* Adding new options to the ReadMes

* Remove spaces for markdownlint

* Updating link to better represent processors

* Zipkin clarifying processor name - about to update Jaeger and Otlp

Co-authored-by: Cijo Thomas <[email protected]>

* base exporter to exporting processor

Co-authored-by: Cijo Thomas <[email protected]>
  • Loading branch information
Austin-Tan and cijothomas authored Nov 19, 2020
1 parent e17b459 commit 5066600
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 8 deletions.
14 changes: 10 additions & 4 deletions src/OpenTelemetry.Exporter.Jaeger/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,21 @@ dotnet add package OpenTelemetry.Exporter.Jaeger

## Configuration

You can configure the `JaegerExporter` by following the directions below:
You can configure the `JaegerExporter` through `JaegerExporterOptions`
properties:

* `ServiceName`: The name of your application or service.
* `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`).
* `MaxPacketSize`: The maximum size of each UDP packet that gets sent to the
agent. (default `65000`).
* `MaxPayloadSizeInBytes`: The maximum size of each UDP packet that gets
sent to the agent. (default `65000`).
* `ProcessTags`: Which tags should be sent with telemetry.
* `ExportProcessorType`: Whether the exporter should use
[Batch or Simple exporting processor](https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/trace/sdk.md#built-in-span-processors)
.
* `BatchExportProcessorOptions`: Configuration options for the batch exporter.
Only used if ExportProcessorType is set to Batch.

See the
[`TestJaegerExporter.cs`](../../examples/Console/TestJaegerExporter.cs)
Expand Down
8 changes: 6 additions & 2 deletions src/OpenTelemetry.Exporter.OpenTelemetryProtocol/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,17 @@ dotnet add package OpenTelemetry.Exporter.OpenTelemetryProtocol

## Configuration

You can configure the `OtlpExporter` by following the directions below:
You can configure the `OtlpExporter` through `OtlpExporterOptions` properties:

* `ServiceName`: Name of the service reporting telemetry.
* `Endpoint`: Target to which the exporter is going to send traces or metrics.
* `Credentials`: Client-side channel credentials.
* `Headers`: Optional headers for the connection.
* `ChannelOptions`: gRPC channel options.
* `ExportProcessorType`: Whether the exporter should use
[Batch or Simple exporting processor](https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/trace/sdk.md#built-in-span-processors)
.
* `BatchExportProcessorOptions`: Configuration options for the batch exporter.
Only used if ExportProcessorType is set to Batch.

See the
[`TestOtlpExporter.cs`](../../examples/Console/TestOtlpExporter.cs)
Expand Down
9 changes: 7 additions & 2 deletions src/OpenTelemetry.Exporter.Zipkin/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ dotnet add package OpenTelemetry.Exporter.Zipkin

## Configuration

You can configure the `ZipkinExporter` with the following options
in `ZipkinExporterOptions`:
You can configure the `ZipkinExporter` through
`ZipkinExporterOptions` properties:

* `ServiceName`: Name of the service reporting telemetry. If the `Resource`
associated with the telemetry has "service.name" defined, then it'll be
Expand All @@ -26,6 +26,11 @@ in `ZipkinExporterOptions`:
sending to Zipkin (default false).
* `MaxPayloadSizeInBytes`: Maximum payload size - for .NET versions
**other** than 4.5.2 (default 4096).
* `ExportProcessorType`: Whether the exporter should use
[Batch or Simple exporting processor](https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/trace/sdk.md#built-in-span-processors)
.
* `BatchExportProcessorOptions`: Configuration options for the batch exporter.
Only used if ExportProcessorType is set to Batch.

See
[`TestZipkinExporter.cs`](../../examples/Console/TestZipkinExporter.cs)
Expand Down

0 comments on commit 5066600

Please sign in to comment.