From 1548e3f474a23b20c3034abf31941692002322b9 Mon Sep 17 00:00:00 2001 From: Tyler Yahn Date: Thu, 23 May 2024 11:48:43 -0700 Subject: [PATCH] Deprecate otelmux (#5644) Towards #5549 --- CHANGELOG.md | 3 +++ instrumentation/github.com/gorilla/mux/otelmux/doc.go | 7 +++++++ .../github.com/gorilla/mux/otelmux/example/README.md | 2 ++ .../github.com/gorilla/mux/otelmux/example/go.mod | 1 + .../github.com/gorilla/mux/otelmux/example/server.go | 2 +- instrumentation/github.com/gorilla/mux/otelmux/go.mod | 1 + instrumentation/github.com/gorilla/mux/otelmux/test/doc.go | 7 +++++++ instrumentation/github.com/gorilla/mux/otelmux/test/go.mod | 1 + .../github.com/gorilla/mux/otelmux/test/mux_test.go | 2 +- 9 files changed, 24 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f3cd4f95ab7..ac83415f0e0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -24,6 +24,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 [#5546]. (#5642) - The `go.opentelemetry.io/contrib/instrumentation/github.com/aws/aws-sdk-go-v2/otelaws` package is deprecated. 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) [#5542]: https://github.com/open-telemetry/opentelemetry-go-contrib/issues/5542 [#5543]: https://github.com/open-telemetry/opentelemetry-go-contrib/issues/5543 @@ -31,6 +33,7 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm [#5545]: https://github.com/open-telemetry/opentelemetry-go-contrib/issues/5545 [#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 [#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/gorilla/mux/otelmux/doc.go b/instrumentation/github.com/gorilla/mux/otelmux/doc.go index 0d4d92a7929..e49088d67b4 100644 --- a/instrumentation/github.com/gorilla/mux/otelmux/doc.go +++ b/instrumentation/github.com/gorilla/mux/otelmux/doc.go @@ -5,4 +5,11 @@ // // Currently only the routing of a received message can be instrumented. To do // it, use the Middleware function. +// +// Deprecated: otelmux 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/5549 package otelmux // import "go.opentelemetry.io/contrib/instrumentation/github.com/gorilla/mux/otelmux" diff --git a/instrumentation/github.com/gorilla/mux/otelmux/example/README.md b/instrumentation/github.com/gorilla/mux/otelmux/example/README.md index 3b201c743ee..f1d2ee01228 100644 --- a/instrumentation/github.com/gorilla/mux/otelmux/example/README.md +++ b/instrumentation/github.com/gorilla/mux/otelmux/example/README.md @@ -1,5 +1,7 @@ # gorilla/mux instrumentation example +:warning: Deprecated: otelmux has no Code Owner. + An HTTP server using gorilla/mux and instrumentation. The server has a `/users/{id:[0-9]+}` endpoint. The server generates span information to `stdout`. diff --git a/instrumentation/github.com/gorilla/mux/otelmux/example/go.mod b/instrumentation/github.com/gorilla/mux/otelmux/example/go.mod index 691048ec5b3..5177ca3274e 100644 --- a/instrumentation/github.com/gorilla/mux/otelmux/example/go.mod +++ b/instrumentation/github.com/gorilla/mux/otelmux/example/go.mod @@ -1,3 +1,4 @@ +// Deprecated: otelmux has no Code Owner. module go.opentelemetry.io/contrib/instrumentation/github.com/gorilla/mux/otelmux/example go 1.21 diff --git a/instrumentation/github.com/gorilla/mux/otelmux/example/server.go b/instrumentation/github.com/gorilla/mux/otelmux/example/server.go index 8b4c8a56ee4..6d6fcca0fd3 100644 --- a/instrumentation/github.com/gorilla/mux/otelmux/example/server.go +++ b/instrumentation/github.com/gorilla/mux/otelmux/example/server.go @@ -11,7 +11,7 @@ import ( "github.com/gorilla/mux" - "go.opentelemetry.io/contrib/instrumentation/github.com/gorilla/mux/otelmux" + "go.opentelemetry.io/contrib/instrumentation/github.com/gorilla/mux/otelmux" // 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/gorilla/mux/otelmux/go.mod b/instrumentation/github.com/gorilla/mux/otelmux/go.mod index 9452d548bd1..bd4c82fb770 100644 --- a/instrumentation/github.com/gorilla/mux/otelmux/go.mod +++ b/instrumentation/github.com/gorilla/mux/otelmux/go.mod @@ -1,3 +1,4 @@ +// Deprecated: otelmux has no Code Owner. module go.opentelemetry.io/contrib/instrumentation/github.com/gorilla/mux/otelmux go 1.21 diff --git a/instrumentation/github.com/gorilla/mux/otelmux/test/doc.go b/instrumentation/github.com/gorilla/mux/otelmux/test/doc.go index 5b405f7eb19..aaa9d0cc48d 100644 --- a/instrumentation/github.com/gorilla/mux/otelmux/test/doc.go +++ b/instrumentation/github.com/gorilla/mux/otelmux/test/doc.go @@ -7,5 +7,12 @@ Package test validates the otelmux 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: otelmux 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/5549 */ package test // import "go.opentelemetry.io/contrib/instrumentation/github.com/gorilla/mux/otelmux/test" diff --git a/instrumentation/github.com/gorilla/mux/otelmux/test/go.mod b/instrumentation/github.com/gorilla/mux/otelmux/test/go.mod index 94f663e046f..f220edf4b30 100644 --- a/instrumentation/github.com/gorilla/mux/otelmux/test/go.mod +++ b/instrumentation/github.com/gorilla/mux/otelmux/test/go.mod @@ -1,3 +1,4 @@ +// Deprecated: otelmux has no Code Owner. module go.opentelemetry.io/contrib/instrumentation/github.com/gorilla/mux/otelmux/test go 1.21 diff --git a/instrumentation/github.com/gorilla/mux/otelmux/test/mux_test.go b/instrumentation/github.com/gorilla/mux/otelmux/test/mux_test.go index 13e900b5ca1..cd7171cfdd7 100644 --- a/instrumentation/github.com/gorilla/mux/otelmux/test/mux_test.go +++ b/instrumentation/github.com/gorilla/mux/otelmux/test/mux_test.go @@ -14,7 +14,7 @@ import ( "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" - "go.opentelemetry.io/contrib/instrumentation/github.com/gorilla/mux/otelmux" + "go.opentelemetry.io/contrib/instrumentation/github.com/gorilla/mux/otelmux" // nolint:staticcheck // deprecated. "go.opentelemetry.io/otel/attribute" "go.opentelemetry.io/otel/codes" "go.opentelemetry.io/otel/propagation"