Skip to content

Commit c1dd1ea

Browse files
authored
Deprecate Zipkin exporter (#4681)
1 parent 6f72b3e commit c1dd1ea

File tree

5 files changed

+9
-2
lines changed

5 files changed

+9
-2
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ This component adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.h
2727
### Deprecated
2828

2929
- Deprecate support for `OpenTracing`.
30+
- Deprecate support for Zipkin exporter. Use OTLP exporter instead.
3031

3132
### Removed
3233

docs/config.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -283,10 +283,12 @@ Exporters output the telemetry.
283283

284284
| Environment variable | Description | Default value | Status |
285285
|-------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|-----------------------------------------------------------------------------------------------------------------------------|
286-
| `OTEL_TRACES_EXPORTER` | Comma-separated list of exporters. Supported options: `otlp`, `zipkin`, `console`, `none`. See [the OpenTelemetry specification](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.35.0/specification/configuration/sdk-environment-variables.md#exporter-selection) for more details. | `otlp` | [Stable](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/versioning-and-stability.md) |
286+
| `OTEL_TRACES_EXPORTER` | Comma-separated list of exporters. Supported options: `otlp`, `zipkin` [1], `console`, `none`. See [the OpenTelemetry specification](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.35.0/specification/configuration/sdk-environment-variables.md#exporter-selection) for more details. | `otlp` | [Stable](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/versioning-and-stability.md) |
287287
| `OTEL_METRICS_EXPORTER` | Comma-separated list of exporters. Supported options: `otlp`, `prometheus`, `console`, `none`. See [the OpenTelemetry specification](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.35.0/specification/configuration/sdk-environment-variables.md#exporter-selection) for more details. | `otlp` | [Stable](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/versioning-and-stability.md) |
288288
| `OTEL_LOGS_EXPORTER` | Comma-separated list of exporters. Supported options: `otlp`, `console`, `none`. See [the OpenTelemetry specification](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.35.0/specification/configuration/sdk-environment-variables.md#exporter-selection) for more details. | `otlp` | [Stable](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/versioning-and-stability.md) |
289289

290+
**[1]**: `zipkin` is deprecated and will be removed in the upcoming release.
291+
290292
### Traces exporter
291293

292294
| Environment variable | Description | Default value | Status |

docs/file-based-configuration.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -196,6 +196,7 @@ tracer_provider:
196196
# On .NET Framework, the grpc OTLP exporter protocol is not supported.
197197

198198
# Batch processor for Zipkin
199+
# This configuration is deprecated and will be removed in upcoming release.
199200
- batch:
200201
exporter:
201202
zipkin:

docs/plugins.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ public class MyPlugin
115115
| Options type | NuGet package | NuGet version |
116116
|-------------------------------------------------------------------------------------------|---------------------------------------------------|---------------|
117117
| OpenTelemetry.Exporter.ConsoleExporterOptions | OpenTelemetry.Exporter.Console | 1.14.0 |
118-
| OpenTelemetry.Exporter.ZipkinExporterOptions | OpenTelemetry.Exporter.Zipkin | 1.14.0 |
118+
| OpenTelemetry.Exporter.ZipkinExporterOptions **Deprecated** | OpenTelemetry.Exporter.Zipkin | 1.14.0 |
119119
| OpenTelemetry.Exporter.OtlpExporterOptions | OpenTelemetry.Exporter.OpenTelemetryProtocol | 1.14.0 |
120120
| OpenTelemetry.Instrumentation.AspNet.AspNetTraceInstrumentationOptions | OpenTelemetry.Instrumentation.AspNet | 1.14.0 |
121121
| OpenTelemetry.Instrumentation.AspNetCore.AspNetCoreTraceInstrumentationOptions | OpenTelemetry.Instrumentation.AspNetCore | 1.14.0 |

src/OpenTelemetry.AutoInstrumentation/Configurations/EnvironmentConfigurationTracerHelper.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -368,6 +368,7 @@ public static TracerProviderBuilder AddConsoleExporter(TracerProviderBuilder bui
368368
[MethodImpl(MethodImplOptions.NoInlining)]
369369
public static TracerProviderBuilder AddZipkinExporter(TracerProviderBuilder builder, PluginManager pluginManager)
370370
{
371+
Logger.Warning("Zipkin exporter is deprecated and it is enabled by the configuration. It will be removed in future versions. Consider migrating to OTLP exporter.");
371372
return builder.AddZipkinExporter(pluginManager.ConfigureTracesOptions);
372373
}
373374

@@ -413,6 +414,7 @@ public static TracerProviderBuilder AddOtlpGrpcExporter(TracerProviderBuilder bu
413414
[MethodImpl(MethodImplOptions.NoInlining)]
414415
public static TracerProviderBuilder AddZipkinExporter(TracerProviderBuilder builder, PluginManager pluginManager, BatchProcessorConfig batch, ZipkinExporterConfig zipkin)
415416
{
417+
Logger.Warning("Zipkin exporter is deprecated and it is enabled by the configuration. It will be removed in future versions. Consider migrating to OTLP exporter.");
416418
return builder.AddZipkinExporter(options =>
417419
{
418420
// Copy Auto settings to SDK settings
@@ -454,6 +456,7 @@ public static TracerProviderBuilder AddOtlpGrpcExporter(TracerProviderBuilder bu
454456
[MethodImpl(MethodImplOptions.NoInlining)]
455457
public static TracerProviderBuilder AddZipkinExporter(TracerProviderBuilder builder, PluginManager pluginManager, ZipkinExporterConfig zipkin)
456458
{
459+
Logger.Warning("Zipkin exporter is deprecated and it is enabled by the configuration. It will be removed in future versions. Consider migrating to OTLP exporter.");
457460
return builder.AddZipkinExporter(options =>
458461
{
459462
// Copy Auto settings to SDK settings

0 commit comments

Comments
 (0)