From 00e72a4edc1ea842dc1c26f01667995b72c9e96b Mon Sep 17 00:00:00 2001 From: Tyler Yahn Date: Thu, 23 May 2024 12:09:59 -0700 Subject: [PATCH] Deprecate otelecho (#5645) Towards #5550 --- CHANGELOG.md | 3 +++ instrumentation/github.com/labstack/echo/otelecho/doc.go | 7 +++++++ .../github.com/labstack/echo/otelecho/example/README.md | 2 ++ .../github.com/labstack/echo/otelecho/example/go.mod | 1 + .../github.com/labstack/echo/otelecho/example/server.go | 2 +- instrumentation/github.com/labstack/echo/otelecho/go.mod | 1 + .../github.com/labstack/echo/otelecho/test/doc.go | 7 +++++++ .../github.com/labstack/echo/otelecho/test/echo_test.go | 2 +- .../github.com/labstack/echo/otelecho/test/go.mod | 1 + 9 files changed, 24 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index ac83415f0e0..582bbf203a6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -26,6 +26,8 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm If you would like to become a Code Owner of this module and prevent it from being removed, see [#5547]. (#5643) - The `go.opentelemetry.io/contrib/instrumentation/github.com/gorilla/mux/otelmux` package is deprecated. If you would like to become a Code Owner of this module and prevent it from being removed, see [#5549]. (#5644) +- The `go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho` package is deprecated. + If you would like to become a Code Owner of this module and prevent it from being removed, see [#5550]. (#5645) [#5542]: https://github.com/open-telemetry/opentelemetry-go-contrib/issues/5542 [#5543]: https://github.com/open-telemetry/opentelemetry-go-contrib/issues/5543 @@ -34,6 +36,7 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm [#5546]: https://github.com/open-telemetry/opentelemetry-go-contrib/issues/5546 [#5547]: https://github.com/open-telemetry/opentelemetry-go-contrib/issues/5547 [#5549]: https://github.com/open-telemetry/opentelemetry-go-contrib/issues/5549 +[#5550]: https://github.com/open-telemetry/opentelemetry-go-contrib/issues/5550 [#5551]: https://github.com/open-telemetry/opentelemetry-go-contrib/issues/5551 ## [1.27.0/0.52.0/0.21.0/0.7.0/0.2.0] - 2024-05-21 diff --git a/instrumentation/github.com/labstack/echo/otelecho/doc.go b/instrumentation/github.com/labstack/echo/otelecho/doc.go index 01fe0cb8587..af3b07fb819 100644 --- a/instrumentation/github.com/labstack/echo/otelecho/doc.go +++ b/instrumentation/github.com/labstack/echo/otelecho/doc.go @@ -6,4 +6,11 @@ // // Currently only the routing of a received message can be instrumented. To do // so, use the Middleware function. +// +// Deprecated: otelecho has no Code Owner. +// After August 21, 2024, it may no longer be supported and may stop +// receiving new releases unless a new Code Owner is found. See +// [this issue] if you would like to become the Code Owner of this module. +// +// [this issue]: https://github.com/open-telemetry/opentelemetry-go-contrib/issues/5550 package otelecho // import "go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho" diff --git a/instrumentation/github.com/labstack/echo/otelecho/example/README.md b/instrumentation/github.com/labstack/echo/otelecho/example/README.md index 41b24e04931..ec0e849e7d7 100644 --- a/instrumentation/github.com/labstack/echo/otelecho/example/README.md +++ b/instrumentation/github.com/labstack/echo/otelecho/example/README.md @@ -1,5 +1,7 @@ # labstack echo instrumentation example +:warning: Deprecated: otelecho has no Code Owner. + An HTTP server using labstack echo and instrumentation. The server has a `/users/:id` endpoint. The server generates span information to `stdout`. diff --git a/instrumentation/github.com/labstack/echo/otelecho/example/go.mod b/instrumentation/github.com/labstack/echo/otelecho/example/go.mod index c7aa5141a70..3156211df4b 100644 --- a/instrumentation/github.com/labstack/echo/otelecho/example/go.mod +++ b/instrumentation/github.com/labstack/echo/otelecho/example/go.mod @@ -1,3 +1,4 @@ +// Deprecated: otelecho has no Code Owner. module go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho/example go 1.21 diff --git a/instrumentation/github.com/labstack/echo/otelecho/example/server.go b/instrumentation/github.com/labstack/echo/otelecho/example/server.go index d6d5ce76c4c..adfcd2da3c2 100644 --- a/instrumentation/github.com/labstack/echo/otelecho/example/server.go +++ b/instrumentation/github.com/labstack/echo/otelecho/example/server.go @@ -10,7 +10,7 @@ import ( "github.com/labstack/echo/v4" - "go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho" + "go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho" // nolint:staticcheck // deprecated. "go.opentelemetry.io/otel" "go.opentelemetry.io/otel/attribute" stdout "go.opentelemetry.io/otel/exporters/stdout/stdouttrace" diff --git a/instrumentation/github.com/labstack/echo/otelecho/go.mod b/instrumentation/github.com/labstack/echo/otelecho/go.mod index 551e55aeb27..ed256fa5ceb 100644 --- a/instrumentation/github.com/labstack/echo/otelecho/go.mod +++ b/instrumentation/github.com/labstack/echo/otelecho/go.mod @@ -1,3 +1,4 @@ +// Deprecated: otelecho has no Code Owner. module go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho go 1.21 diff --git a/instrumentation/github.com/labstack/echo/otelecho/test/doc.go b/instrumentation/github.com/labstack/echo/otelecho/test/doc.go index da2d7535a8c..1aeb939afdc 100644 --- a/instrumentation/github.com/labstack/echo/otelecho/test/doc.go +++ b/instrumentation/github.com/labstack/echo/otelecho/test/doc.go @@ -7,5 +7,12 @@ Package test validates the otelecho instrumentation with the default SDK. This package is in a separate module from the instrumentation it tests to isolate the dependency of the default SDK and not impose this as a transitive dependency for users. + +Deprecated: otelecho has no Code Owner. +After August 21, 2024, it may no longer be supported and may stop +receiving new releases unless a new Code Owner is found. See +[this issue] if you would like to become the Code Owner of this module. + +[this issue]: https://github.com/open-telemetry/opentelemetry-go-contrib/issues/5550 */ package test // import "go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho/test" diff --git a/instrumentation/github.com/labstack/echo/otelecho/test/echo_test.go b/instrumentation/github.com/labstack/echo/otelecho/test/echo_test.go index 21d213120c7..237d73d6fed 100644 --- a/instrumentation/github.com/labstack/echo/otelecho/test/echo_test.go +++ b/instrumentation/github.com/labstack/echo/otelecho/test/echo_test.go @@ -16,7 +16,7 @@ import ( "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" - "go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho" + "go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho" // nolint:staticcheck // deprecated. "go.opentelemetry.io/otel" "go.opentelemetry.io/otel/codes" "go.opentelemetry.io/otel/sdk/trace" diff --git a/instrumentation/github.com/labstack/echo/otelecho/test/go.mod b/instrumentation/github.com/labstack/echo/otelecho/test/go.mod index a9a8126538f..ccc2d9dafff 100644 --- a/instrumentation/github.com/labstack/echo/otelecho/test/go.mod +++ b/instrumentation/github.com/labstack/echo/otelecho/test/go.mod @@ -1,3 +1,4 @@ +// Deprecated: otelecho has no Code Owner. module go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho/test go 1.21