OpenTelemetry.Exporter.Zipkin 1.11.2

Prefix Reserved
dotnet add package OpenTelemetry.Exporter.Zipkin --version 1.11.2
                    
NuGet\Install-Package OpenTelemetry.Exporter.Zipkin -Version 1.11.2
                    
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.2" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="OpenTelemetry.Exporter.Zipkin" Version="1.11.2" />
                    
Directory.Packages.props
<PackageReference Include="OpenTelemetry.Exporter.Zipkin" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add OpenTelemetry.Exporter.Zipkin --version 1.11.2
                    
#r "nuget: OpenTelemetry.Exporter.Zipkin, 1.11.2"
                    
#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.
#addin nuget:?package=OpenTelemetry.Exporter.Zipkin&version=1.11.2
                    
Install OpenTelemetry.Exporter.Zipkin as a Cake Addin
#tool nuget:?package=OpenTelemetry.Exporter.Zipkin&version=1.11.2
                    
Install OpenTelemetry.Exporter.Zipkin as a Cake Tool

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.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed. 
.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 (56)

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 (23)

Showing the top 20 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 9 Clean Architecture (Microservices, Modular Monolith, Monolith), Blazor, Angular 19, React 19, Vue 3.5, BFF with YARP, NextJs 15, Domain-Driven Design, CQRS, SOLID, Asp.Net Core Identity Custom Storage, OpenID Connect, EF Core, OpenTelemetry, SignalR, Background Services, Health Checks, Rate Limiting, Clouds (Azure, AWS, GCP), ..
Azure/durabletask
Durable Task Framework allows users to write long running persistent workflows in C# using the async/await capabilities.
thangchung/clean-architecture-dotnet
🕸 Yet Another .NET Clean Architecture, but for Microservices project. It uses Minimal Clean Architecture with DDD-lite, CQRS-lite, and just enough Cloud-native patterns apply on the simple eCommerce sample and run on Tye with Dapr extension 🍻
meysamhadeli/monolith-to-cloud-architecture
A practical architecture styles for migrating from monolith to modern cloud native application with the latest technologies and architectures like Vertical Slice Architecture, Event Sourcing, CQRS, DDD, gRpc, MongoDB, RabbitMq, and Masstransit in .Net 9.
colinin/abp-next-admin
这是基于vue-vben-admin 模板适用于abp vNext的前端管理项目
mehdihadeli/food-delivery-microservices
🍔 A practical and imaginary food delivery microservices, built with .Net 9, MassTransit, Domain-Driven Design, CQRS, Vertical Slice Architecture, Event-Driven Architecture, and the latest technologies.
MUnique/OpenMU
This project aims to create an easy to use, extendable and customizable server for a MMORPG called "MU Online".
davidfowl/Micronetes
Micronetes is a local orchestrator inspired by kubernetes that makes developing and testing microservices and distributed applications easier.
Aguafrommars/TheIdServer
OpenID/Connect, OAuth2, WS-Federation and SAML 2.0 server based on Duende IdentityServer and ITFoxtec Identity SAML 2.0 with its admin UI
b-editor/beutl
Cross-platform video editing (compositing) software.
SteeltoeOSS/Samples
Steeltoe samples and reference application collection
open-telemetry/opentelemetry-dotnet-contrib
This repository contains set of components extending functionality of the OpenTelemetry .NET SDK. Instrumentation libraries, exporters, and other components can find their home here.
Eventuous/eventuous
Event Sourcing library for .NET
newbe36524/Newbe.Claptrap
This is a frameworks with reactive, event sourcing and Actor pattern as basic theories. On top of this, developers can create "distributed", "scale out", and "easy to test" application more simply. Claptrap and it`s Minions is on the way.
mehdihadeli/vertical-slice-api-template
🍰 An asp.net core template based on .Net 9, Vertical Slice Architecture, CQRS, Minimal APIs, OpenTelemetry, API Versioning and OpenAPI.
cocosip/sharp-abp
Abp-vNext extension modules
Version Downloads Last updated
1.11.2 97,375 a month ago
1.11.1 181,923 3 months ago
1.11.0 46,854 3 months ago
1.11.0-rc.1 904 4 months ago
1.10.0 215,153 5 months ago
1.10.0-rc.1 1,405 5 months ago
1.10.0-beta.1 3,748 7 months ago
1.9.0 1,640,636 6/14/2024
1.9.0-rc.1 157 6/7/2024
1.9.0-alpha.1 1,126 5/20/2024
1.8.1 657,539 4/18/2024
1.8.0 263,680 4/3/2024
1.8.0-rc.1 267 3/27/2024
1.8.0-beta.1 5,219 3/14/2024
1.7.0 1,035,484 12/9/2023
1.7.0-rc.1 5,477 11/30/2023
1.7.0-alpha.1 9,954 10/17/2023
1.6.0 1,037,906 9/6/2023
1.6.0-rc.1 6,303 8/21/2023
1.6.0-alpha.1 12,512 7/12/2023
1.5.1 997,588 6/26/2023
1.5.0 84,195 6/6/2023 1.5.0 is deprecated.
1.5.0-rc.1 3,393 5/26/2023
1.5.0-alpha.2 64,079 4/1/2023
1.5.0-alpha.1 4,953 3/8/2023
1.4.0 668,464 2/24/2023
1.4.0-rc.4 25,473 2/11/2023
1.4.0-rc.3 12,572 2/2/2023
1.4.0-rc.2 23,964 1/9/2023
1.4.0-rc.1 30,254 12/12/2022
1.4.0-beta.3 85,936 11/7/2022
1.4.0-beta.2 35,827 10/17/2022
1.4.0-beta.1 20,579 9/30/2022
1.4.0-alpha.2 44,264 8/18/2022
1.4.0-alpha.1 59,329 8/3/2022
1.3.2 398,596 12/20/2022
1.3.1 612,319 9/8/2022
1.3.0 746,593 6/3/2022 1.3.0 is deprecated because it has critical bugs.
1.3.0-rc.2 979 6/1/2022
1.3.0-beta.2 8,302 5/17/2022
1.3.0-beta.1 9,752 4/20/2022
1.2.0 1,177,321 4/15/2022 1.2.0 is deprecated because it has critical bugs.
1.2.0-rc5 3,042 4/13/2022
1.2.0-rc4 9,038 3/30/2022
1.2.0-rc3 85,803 3/5/2022
1.2.0-rc2 80,448 2/3/2022
1.2.0-rc1 307,062 11/30/2021
1.2.0-beta2.1 85,318 11/19/2021
1.2.0-beta1 277,632 10/8/2021
1.2.0-alpha4 31,407 9/23/2021
1.2.0-alpha3 2,611 9/14/2021
1.2.0-alpha2 9,079 8/25/2021
1.1.0 551,449 7/13/2021 1.1.0 is deprecated because it has critical bugs.
1.1.0-rc1 5,764 6/26/2021
1.1.0-beta4 6,671 6/9/2021
1.1.0-beta3 1,825 5/12/2021
1.1.0-beta2 25,264 4/23/2021
1.1.0-beta1 81,883 3/19/2021
1.0.1 279,623 2/10/2021 1.0.1 is deprecated because it has critical bugs.
1.0.0-rc4 10,591 2/9/2021
1.0.0-rc3 1,377 2/5/2021
1.0.0-rc2 7,237 1/30/2021
1.0.0-rc1.1 176,051 11/18/2020
0.8.0-beta.1 8,714 11/5/2020
0.7.0-beta.1 2,027 10/16/2020
0.6.0-beta.1 13,956 9/16/2020
0.5.0-beta.2 1,850 8/28/2020
0.4.0-beta.2 41,734 7/25/2020
0.3.0-beta.1 1,348 7/23/2020
0.2.0-alpha.275 158,822 5/19/2020
0.2.0-alpha.220 443,301 5/19/2020
0.2.0-alpha.179 64,348 1/28/2020
0.2.0-alpha.100 11,319 11/5/2019
0.2.0-alpha.40 404 9/24/2019
0.2.0-alpha.5 599 8/3/2019