OpenTelemetry.Exporter.Zipkin 1.11.0-rc.1

Prefix Reserved
.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. .NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher. .NET Framework 4.6.2 This package targets .NET Framework 4.6.2. The package is compatible with this framework or higher.
This is a prerelease version of OpenTelemetry.Exporter.Zipkin. 
dotnet add package OpenTelemetry.Exporter.Zipkin --version 1.11.0-rc.1                

                    
                

            
NuGet\Install-Package OpenTelemetry.Exporter.Zipkin -Version 1.11.0-rc.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="OpenTelemetry.Exporter.Zipkin" Version="1.11.0-rc.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add OpenTelemetry.Exporter.Zipkin --version 1.11.0-rc.1                

                    
                

            
#r "nuget: OpenTelemetry.Exporter.Zipkin, 1.11.0-rc.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install OpenTelemetry.Exporter.Zipkin as a Cake Addin
#addin nuget:?package=OpenTelemetry.Exporter.Zipkin&version=1.11.0-rc.1&prerelease

// Install OpenTelemetry.Exporter.Zipkin as a Cake Tool
#tool nuget:?package=OpenTelemetry.Exporter.Zipkin&version=1.11.0-rc.1&prerelease

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 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

  • BatchExportProcessorOptions: Configuration options for the batch exporter. Only used if ExportProcessorType is set to Batch.

  • Endpoint: URI address to receive telemetry (default http://localhost:9411/api/v2/spans).

  • ExportProcessorType: Whether the exporter should use Batch or Simple exporting processor.

  • HttpClientFactory: A factory function called to create the HttpClient instance that will be used at runtime to transmit spans over HTTP. See Configure HttpClient for more details.

  • MaxPayloadSizeInBytes: Maximum payload size of UTF8 JSON chunks sent to Zipkin (default 4096).

  • 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.

  • UseShortTraceIds: Whether the trace's ID should be shortened before sending to Zipkin (default false).

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

Configure HttpClient

The HttpClientFactory option is provided on ZipkinExporterOptions for users who want to configure the HttpClient used by the ZipkinExporter. Simply replace the function with your own implementation if you want to customize the generated HttpClient:

services.AddOpenTelemetry()
    .WithTracing(builder => builder
        .AddZipkinExporter(o => o.HttpClientFactory = () =>
        {
            HttpClient client = new HttpClient();
            client.DefaultRequestHeaders.Add("X-MyCustomHeader", "value");
            return client;
        }));

For users using IHttpClientFactory you may also customize the named "ZipkinExporter" HttpClient using the built-in AddHttpClient extension:

services.AddHttpClient(
    "ZipkinExporter",
     configureClient: (client) =>
        client.DefaultRequestHeaders.Add("X-MyCustomHeader", "value"));

Note: The single instance returned by HttpClientFactory is reused by all export requests.

Troubleshooting

This component uses an EventSource with the name "OpenTelemetry-Exporter-Zipkin" for its internal logging. Please refer to SDK troubleshooting for instructions on seeing these internal logs.

References

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 is compatible. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 is compatible.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (48)

Showing the top 5 NuGet packages that depend on OpenTelemetry.Exporter.Zipkin:

Package Downloads
OpenTelemetry.AutoInstrumentation.Runtime.Managed

Managed components used by the OpenTelemetry.AutoInstrumentation project.
MyJetWallet.Sdk.Service

Package Description
devprime.stack.observability

DevPrime Observability
FCMicroservices

a boilerplate microservice framework
Jakar.Database

Package Description

GitHub repositories (22)

Showing the top 5 popular GitHub repositories that depend on OpenTelemetry.Exporter.Zipkin:

Repository Stars
dotnet/tye
Tye is a tool that makes developing, testing, and deploying microservices and distributed applications easier. Project Tye includes a local orchestrator to make developing microservices easier and the ability to deploy microservices to Kubernetes with minimal configuration.
grpc/grpc-dotnet
gRPC for .NET
dotnet/samples
Sample code referenced by the .NET documentation
Squidex/squidex
Headless CMS and Content Managment Hub
phongnguyend/Practical.CleanArchitecture
Full-stack .Net 8 Clean Architecture (Microservices, Modular Monolith, Monolith), Blazor, Angular 18, React 18, Vue 3, BFF with YARP, Domain-Driven Design, CQRS, SOLID, Asp.Net Core Identity Custom Storage, OpenID Connect, Entity Framework Core, OpenTelemetry, SignalR, Hosted Services, Health Checks, Rate Limiting, Cloud Services (Azure, AWS, GCP).
Version Downloads Last updated
1.11.0-rc.1 88 12/12/2024
1.10.0 46,334 11/12/2024
1.10.0-rc.1 1,377 11/1/2024
1.10.0-beta.1 3,714 9/30/2024
1.9.0 945,499 6/14/2024
1.9.0-rc.1 144 6/7/2024
1.9.0-alpha.1 1,112 5/20/2024
1.8.1 487,265 4/18/2024
1.8.0 200,458 4/3/2024
1.8.0-rc.1 247 3/27/2024
1.8.0-beta.1 5,053 3/14/2024
1.7.0 873,797 12/9/2023
1.7.0-rc.1 5,372 11/30/2023
1.7.0-alpha.1 9,529 10/17/2023
1.6.0 888,216 9/6/2023
1.6.0-rc.1 5,450 8/21/2023
1.6.0-alpha.1 10,913 7/12/2023
1.5.1 945,791 6/26/2023
1.5.0 73,827 6/6/2023 1.5.0 is deprecated.
1.5.0-rc.1 3,153 5/26/2023
1.5.0-alpha.2 61,372 4/1/2023
1.5.0-alpha.1 4,902 3/8/2023
1.4.0 632,527 2/24/2023
1.4.0-rc.4 24,485 2/11/2023
1.4.0-rc.3 12,021 2/2/2023
1.4.0-rc.2 23,574 1/9/2023
1.4.0-rc.1 28,413 12/12/2022
1.4.0-beta.3 84,754 11/7/2022
1.4.0-beta.2 34,015 10/17/2022
1.4.0-beta.1 20,450 9/30/2022
1.4.0-alpha.2 44,154 8/18/2022
1.4.0-alpha.1 51,309 8/3/2022
1.3.2 371,733 12/20/2022
1.3.1 587,706 9/8/2022
1.3.0 695,257 6/3/2022 1.3.0 is deprecated because it has critical bugs.
1.3.0-rc.2 953 6/1/2022
1.3.0-beta.2 8,260 5/17/2022
1.3.0-beta.1 9,719 4/20/2022
1.2.0 1,111,550 4/15/2022 1.2.0 is deprecated because it has critical bugs.
1.2.0-rc5 3,019 4/13/2022
1.2.0-rc4 8,987 3/30/2022
1.2.0-rc3 84,925 3/5/2022
1.2.0-rc2 70,723 2/3/2022
1.2.0-rc1 304,610 11/30/2021
1.2.0-beta2.1 74,606 11/19/2021
1.2.0-beta1 273,480 10/8/2021
1.2.0-alpha4 29,275 9/23/2021
1.2.0-alpha3 2,582 9/14/2021
1.2.0-alpha2 8,881 8/25/2021
1.1.0 543,087 7/13/2021 1.1.0 is deprecated because it has critical bugs.
1.1.0-rc1 5,601 6/26/2021
1.1.0-beta4 6,561 6/9/2021
1.1.0-beta3 1,796 5/12/2021
1.1.0-beta2 24,831 4/23/2021
1.1.0-beta1 79,392 3/19/2021
1.0.1 273,456 2/10/2021 1.0.1 is deprecated because it has critical bugs.
1.0.0-rc4 10,546 2/9/2021
1.0.0-rc3 1,336 2/5/2021
1.0.0-rc2 7,196 1/30/2021
1.0.0-rc1.1 173,255 11/18/2020
0.8.0-beta.1 8,660 11/5/2020
0.7.0-beta.1 1,985 10/16/2020
0.6.0-beta.1 13,848 9/16/2020
0.5.0-beta.2 1,809 8/28/2020
0.4.0-beta.2 41,542 7/25/2020
0.3.0-beta.1 1,149 7/23/2020
0.2.0-alpha.275 156,771 5/19/2020
0.2.0-alpha.220 434,459 5/19/2020
0.2.0-alpha.179 63,594 1/28/2020
0.2.0-alpha.100 10,987 11/5/2019
0.2.0-alpha.40 366 9/24/2019
0.2.0-alpha.5 559 8/3/2019

For highlights and announcements see: https://github.com/open-telemetry/opentelemetry-dotnet/blob/core-1.11.0-rc.1/RELEASENOTES.md.

       For detailed changes see: https://github.com/open-telemetry/opentelemetry-dotnet/blob/core-1.11.0-rc.1/src/OpenTelemetry.Exporter.Zipkin/CHANGELOG.md.