OpenTelemetry.Exporter.Zipkin 1.10.0-rc.1

Prefix Reserved

.NET 8.0 .NET Standard 2.0 .NET Framework 4.6.2

This is a prerelease version of OpenTelemetry.Exporter.Zipkin.

dotnet add package OpenTelemetry.Exporter.Zipkin --version 1.10.0-rc.1

NuGet\Install-Package OpenTelemetry.Exporter.Zipkin -Version 1.10.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.10.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.10.0-rc.1

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: OpenTelemetry.Exporter.Zipkin, 1.10.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.10.0-rc.1&prerelease

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

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Zipkin Exporter for OpenTelemetry .NET

Prerequisite

Get Zipkin

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.

.NETFramework 4.6.2
- OpenTelemetry (>= 1.10.0-rc.1)
- System.Text.Encodings.Web (>= 4.7.2)
- System.Text.Json (>= 4.7.2)
.NETStandard 2.0
- OpenTelemetry (>= 1.10.0-rc.1)
- System.Text.Encodings.Web (>= 4.7.2)
- System.Text.Json (>= 4.7.2)
net8.0
- OpenTelemetry (>= 1.10.0-rc.1)
- System.Text.Json (>= 8.0.5)
net9.0
- OpenTelemetry (>= 1.10.0-rc.1)

NuGet packages (47)

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.	783.9K
MyJetWallet.Sdk.Service Package Description	468.7K
devprime.stack.observability DevPrime Observability	203.0K
FCMicroservices a boilerplate microservice framework	22.2K
Jakar.Database Package Description	17.7K

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.	5.3K
grpc/grpc-dotnet gRPC for .NET	4.2K
dotnet/samples Sample code referenced by the .NET documentation	3.4K
Squidex/squidex Headless CMS and Content Managment Hub	2.3K
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).	2.1K

Version	Downloads	Last updated
1.10.0-rc.1	352	11/1/2024
1.10.0-beta.1	3,686	9/30/2024
1.9.0	626,015	6/14/2024
1.9.0-rc.1	137	6/7/2024
1.9.0-alpha.1	1,105	5/20/2024
1.8.1	418,646	4/18/2024
1.8.0	171,836	4/3/2024
1.8.0-rc.1	241	3/27/2024
1.8.0-beta.1	4,912	3/14/2024
1.7.0	797,419	12/9/2023
1.7.0-rc.1	5,141	11/30/2023
1.7.0-alpha.1	9,190	10/17/2023
1.6.0	831,155	9/6/2023
1.6.0-rc.1	4,999	8/21/2023
1.6.0-alpha.1	9,949	7/12/2023
1.5.1	922,099	6/26/2023
1.5.0	71,340	6/6/2023
1.5.0-rc.1	3,104	5/26/2023
1.5.0-alpha.2	60,423	4/1/2023
1.5.0-alpha.1	4,889	3/8/2023
1.4.0	614,740	2/24/2023
1.4.0-rc.4	23,771	2/11/2023
1.4.0-rc.3	11,908	2/2/2023
1.4.0-rc.2	23,214	1/9/2023
1.4.0-rc.1	27,899	12/12/2022
1.4.0-beta.3	84,462	11/7/2022
1.4.0-beta.2	33,391	10/17/2022
1.4.0-beta.1	20,428	9/30/2022
1.4.0-alpha.2	43,940	8/18/2022
1.4.0-alpha.1	48,846	8/3/2022
1.3.2	363,021	12/20/2022
1.3.1	576,724	9/8/2022
1.3.0	679,870	6/3/2022
1.3.0-rc.2	948	6/1/2022
1.3.0-beta.2	8,253	5/17/2022
1.3.0-beta.1	9,709	4/20/2022
1.2.0	1,085,586	4/15/2022
1.2.0-rc5	3,013	4/13/2022
1.2.0-rc4	8,963	3/30/2022
1.2.0-rc3	84,676	3/5/2022
1.2.0-rc2	68,364	2/3/2022
1.2.0-rc1	303,394	11/30/2021
1.2.0-beta2.1	71,251	11/19/2021
1.2.0-beta1	270,155	10/8/2021
1.2.0-alpha4	28,647	9/23/2021
1.2.0-alpha3	2,575	9/14/2021
1.2.0-alpha2	8,770	8/25/2021
1.1.0	539,611	7/13/2021
1.1.0-rc1	5,591	6/26/2021
1.1.0-beta4	6,514	6/9/2021
1.1.0-beta3	1,786	5/12/2021
1.1.0-beta2	24,783	4/23/2021
1.1.0-beta1	78,501	3/19/2021
1.0.1	271,699	2/10/2021
1.0.0-rc4	10,533	2/9/2021
1.0.0-rc3	1,331	2/5/2021
1.0.0-rc2	7,184	1/30/2021
1.0.0-rc1.1	172,228	11/18/2020
0.8.0-beta.1	8,652	11/5/2020
0.7.0-beta.1	1,981	10/16/2020
0.6.0-beta.1	13,822	9/16/2020
0.5.0-beta.2	1,801	8/28/2020
0.4.0-beta.2	41,394	7/25/2020
0.3.0-beta.1	1,065	7/23/2020
0.2.0-alpha.275	153,216	5/19/2020
0.2.0-alpha.220	430,899	5/19/2020
0.2.0-alpha.179	63,283	1/28/2020
0.2.0-alpha.100	10,962	11/5/2019
0.2.0-alpha.40	359	9/24/2019
0.2.0-alpha.5	549	8/3/2019

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

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