Skip to content

Latest commit

 

History

History
71 lines (50 loc) · 2.71 KB

README.md

File metadata and controls

71 lines (50 loc) · 2.71 KB

Zipkin Exporter for OpenTelemetry .NET

NuGet NuGet

Prerequisite

Installation

dotnet add package OpenTelemetry.Exporter.Zipkin

Enable/Add Zipkin as a tracing exporter

You can enable the the ZipkinExporter with the AddZipkinExporter() extension method on TracerProviderBuilder.

Configuration

You can configure the ZipkinExporter through ZipkinExporterOptions and environment variables. The ZipkinExporterOptions setters take precedence over the environment variables.

Configuration using Properties

  • ServiceName: Name of the service reporting telemetry. If the Resource associated with the telemetry has "service.name" defined, then it'll be preferred over this option.
  • Endpoint: URI address to receive telemetry (default http://localhost:9411/api/v2/spans).
  • UseShortTraceIds: Whether the trace's ID should be shortened before 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 .
  • BatchExportProcessorOptions: Configuration options for the batch exporter. Only used if ExportProcessorType is set to Batch.

See TestZipkinExporter.cs for example use.

Configuration using Dependency Injection

This exporter allows easy configuration of ZipkinExporterOptions from dependency injection container, when used in conjunction with OpenTelemetry.Extensions.Hosting.

See the Startup class of the ASP.NET Core application for example use.

Configuration using Environment Variables

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

Environment variable ZipkinExporterOptions property
OTEL_EXPORTER_ZIPKIN_ENDPOINT Endpoint

FormatException is thrown in case of an invalid value for any of the supported environment variables.

References