From 5066600110b0c312cd6c9c75f8afa43252f4fba7 Mon Sep 17 00:00:00 2001 From: Austin Tan Date: Thu, 19 Nov 2020 13:27:14 -0800 Subject: [PATCH] Updating ReadMEs for Jaeger, Zipkin, OTLP exporters (#1591) * 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 * base exporter to exporting processor Co-authored-by: Cijo Thomas --- src/OpenTelemetry.Exporter.Jaeger/README.md | 14 ++++++++++---- .../README.md | 8 ++++++-- src/OpenTelemetry.Exporter.Zipkin/README.md | 9 +++++++-- 3 files changed, 23 insertions(+), 8 deletions(-) diff --git a/src/OpenTelemetry.Exporter.Jaeger/README.md b/src/OpenTelemetry.Exporter.Jaeger/README.md index 19da08bdff4..be234c74d24 100644 --- a/src/OpenTelemetry.Exporter.Jaeger/README.md +++ b/src/OpenTelemetry.Exporter.Jaeger/README.md @@ -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) diff --git a/src/OpenTelemetry.Exporter.OpenTelemetryProtocol/README.md b/src/OpenTelemetry.Exporter.OpenTelemetryProtocol/README.md index c7cdbd70b13..25cacd5113d 100644 --- a/src/OpenTelemetry.Exporter.OpenTelemetryProtocol/README.md +++ b/src/OpenTelemetry.Exporter.OpenTelemetryProtocol/README.md @@ -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) diff --git a/src/OpenTelemetry.Exporter.Zipkin/README.md b/src/OpenTelemetry.Exporter.Zipkin/README.md index 2f19f4c28cc..5e427eedbe2 100644 --- a/src/OpenTelemetry.Exporter.Zipkin/README.md +++ b/src/OpenTelemetry.Exporter.Zipkin/README.md @@ -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 @@ -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)