From d78820e9050cd63daebdb4b82202f10d9c2b66e3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20Paj=C4=85k?= Date: Tue, 15 Aug 2023 17:54:50 +0200 Subject: [PATCH] Deprecate exporters/jaeger (#4423) * Deprecate exporters/jaeger * Delete jaeger example * Remove jaeger exporter from docs * Remove example from docs * Update CHANGELOG.md Co-authored-by: Tyler Yahn * Revert "Delete jaeger example" This reverts commit 1a2b47bc9ac4e8f7e6f64a6cf6fe79e4c9261c23. * Revert "Remove example from docs" This reverts commit 682db01075fb62c6947b26f2b57667b2a4122c56. * Add nolint comment * Remove Jaeger from main README * Deprecate example/jaeger * Apply suggestions from code review Co-authored-by: Tyler Yahn * Apply suggestions from code review Co-authored-by: Tyler Yahn * Update go.mod * Update main.go * fix lint --------- Co-authored-by: Tyler Yahn Co-authored-by: Aaron Clawson <3766680+MadVikingGod@users.noreply.github.com> --- CHANGELOG.md | 5 +++++ README.md | 1 - example/jaeger/go.mod | 6 ++++++ example/jaeger/main.go | 9 ++++++++- exporters/README.md | 1 - exporters/jaeger/README.md | 6 ++++++ exporters/jaeger/doc.go | 6 ++++++ exporters/jaeger/go.mod | 5 +++++ 8 files changed, 36 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 11549cd77a4..774ec6edb82 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -78,6 +78,11 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm ### Deprecated +- The `go.opentelemetry.io/otel/exporters/jaeger` package is deprecated. + OpenTelemetry dropped support for Jaeger exporter in July 2023. + Use `go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp` + or `go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc` instead. (#4423) +- The `go.opentelemetry.io/otel/example/jaeger` package is deprecated. (#4423) - The `go.opentelemetry.io/otel/exporters/otlp/otlpmetric/internal` package is deprecated. (#4420) - The `go.opentelemetry.io/otel/exporters/otlp/otlpmetric/internal/oconf` package is deprecated. (#4420) - The `go.opentelemetry.io/otel/exporters/otlp/otlpmetric/internal/otest` package is deprecated. (#4420) diff --git a/README.md b/README.md index 370513054de..652dd175590 100644 --- a/README.md +++ b/README.md @@ -101,7 +101,6 @@ All officially supported exporters for the OpenTelemetry project are contained i | Exporter | Metrics | Traces | |---------------------------------------|:-------:|:------:| -| [Jaeger](./exporters/jaeger/) | | ✓ | | [OTLP](./exporters/otlp/) | ✓ | ✓ | | [Prometheus](./exporters/prometheus/) | ✓ | | | [stdout](./exporters/stdout/) | ✓ | ✓ | diff --git a/example/jaeger/go.mod b/example/jaeger/go.mod index ce0267c891e..b2be8745d5a 100644 --- a/example/jaeger/go.mod +++ b/example/jaeger/go.mod @@ -1,3 +1,9 @@ +// Deprecated: This example is no longer supported as +// [go.opentelemetry.io/otel/exporters/jaeger] is no longer supported. +// OpenTelemetry dropped support for Jaeger exporter in July 2023. +// Jaeger officially accepts and recommends using OTLP. +// Use [go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp] +// or [go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc] instead. module go.opentelemetry.io/otel/example/jaeger go 1.19 diff --git a/example/jaeger/main.go b/example/jaeger/main.go index 58b7e8b510e..d4f41f5f316 100644 --- a/example/jaeger/main.go +++ b/example/jaeger/main.go @@ -14,6 +14,13 @@ // Command jaeger is an example program that creates spans // and uploads to Jaeger. +// +// Deprecated: This example is no longer supported as +// [go.opentelemetry.io/otel/exporters/jaeger] is no longer supported. +// OpenTelemetry dropped support for Jaeger exporter in July 2023. +// Jaeger officially accepts and recommends using OTLP. +// Use [go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp] +// or [go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc] instead. package main import ( @@ -23,7 +30,7 @@ import ( "go.opentelemetry.io/otel" "go.opentelemetry.io/otel/attribute" - "go.opentelemetry.io/otel/exporters/jaeger" + "go.opentelemetry.io/otel/exporters/jaeger" //nolint:staticcheck // This is deprecated and will be removed in the next release. "go.opentelemetry.io/otel/sdk/resource" tracesdk "go.opentelemetry.io/otel/sdk/trace" semconv "go.opentelemetry.io/otel/semconv/v1.21.0" diff --git a/exporters/README.md b/exporters/README.md index a43f2b8341b..58561902d43 100644 --- a/exporters/README.md +++ b/exporters/README.md @@ -9,7 +9,6 @@ The following exporter packages are provided with the following OpenTelemetry si | Exporter Package | Metrics | Traces | | :-----------------------------------------------------------------------------: | :-----: | :----: | -| [go.opentelemetry.io/otel/exporters/jaeger](./jaeger) | | ✓ | | [go.opentelemetry.io/otel/exporters/otlp/otlpmetric](./otlp/otlpmetric) | ✓ | | | [go.opentelemetry.io/otel/exporters/otlp/otlptrace](./otlp/otlptrace) | | ✓ | | [go.opentelemetry.io/otel/exporters/prometheus](./prometheus) | ✓ | | diff --git a/exporters/jaeger/README.md b/exporters/jaeger/README.md index 19060ba4fd2..439bf79a90f 100644 --- a/exporters/jaeger/README.md +++ b/exporters/jaeger/README.md @@ -2,6 +2,12 @@ [![Go Reference](https://pkg.go.dev/badge/go.opentelemetry.io/otel/exporters/jaeger.svg)](https://pkg.go.dev/go.opentelemetry.io/otel/exporters/jaeger) +> **Deprecated:** This module is no longer supported. +> OpenTelemetry dropped support for Jaeger exporter in July 2023. +> Jaeger officially accepts and recommends using OTLP. +> Use [go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp](https://pkg.go.dev/go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp) +> or [go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc](https://pkg.go.dev/go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc) instead. + [OpenTelemetry span exporter for Jaeger](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.20.0/specification/trace/sdk_exporters/jaeger.md) implementation. ## Installation diff --git a/exporters/jaeger/doc.go b/exporters/jaeger/doc.go index 0d7ba867642..a7359654110 100644 --- a/exporters/jaeger/doc.go +++ b/exporters/jaeger/doc.go @@ -13,4 +13,10 @@ // limitations under the License. // Package jaeger contains an OpenTelemetry tracing exporter for Jaeger. +// +// Deprecated: This module is no longer supported. +// OpenTelemetry dropped support for Jaeger exporter in July 2023. +// Jaeger officially accepts and recommends using OTLP. +// Use [go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp] +// or [go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc] instead. package jaeger // import "go.opentelemetry.io/otel/exporters/jaeger" diff --git a/exporters/jaeger/go.mod b/exporters/jaeger/go.mod index 6e716a24da0..cef7005a963 100644 --- a/exporters/jaeger/go.mod +++ b/exporters/jaeger/go.mod @@ -1,3 +1,8 @@ +// Deprecated: This module is no longer supported. +// OpenTelemetry dropped support for Jaeger exporter in July 2023. +// Jaeger officially accepts and recommends using OTLP. +// Use [go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp] +// or [go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc] instead. module go.opentelemetry.io/otel/exporters/jaeger go 1.19