From 2e7d536515d008ad0778dbb00e7e7c01e7264bd2 Mon Sep 17 00:00:00 2001 From: Tyler Yahn Date: Wed, 30 Aug 2023 07:52:31 -0700 Subject: [PATCH] Deprecate the gorilla/mux instrumentor and test pkgs (#262) * Deprecate the gorilla/mux instrumentor and text pkgs * Fix lint --- CHANGELOG.md | 7 +++++++ pkg/instrumentors/bpf/github.com/gorilla/mux/probe.go | 4 ++++ pkg/instrumentors/manager.go | 2 +- test/e2e/gorillamux/go.mod | 1 + 4 files changed, 13 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7e145d60c..24c184049 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -26,6 +26,13 @@ OpenTelemetry Go Automatic Instrumentation adheres to [Semantic Versioning](http - Fix context propagation across different goroutines. ([#118](https://github.com/open-telemetry/opentelemetry-go-instrumentation/pull/118)) - The offset tracker can once again build binaries for the Go stdlib. ([#256]https://github.com/open-telemetry/opentelemetry-go-instrumentation/pull/256) +### Deprecated + +- The `go.opentelemetry.io/auto/pkg/instrumentors/bpf/github.com/gorilla/mux` package is deprecated. + It will be removed in the following release. ([#262](https://github.com/open-telemetry/opentelemetry-go-instrumentation/pull/262)) +- The `go.opentelemetry.io/auto/test/e2e/gorillamux` module is deprecated. + It will be removed in the following release. ([#262](https://github.com/open-telemetry/opentelemetry-go-instrumentation/pull/262)) + ## [v0.2.2-alpha] - 2023-07-12 ### Added diff --git a/pkg/instrumentors/bpf/github.com/gorilla/mux/probe.go b/pkg/instrumentors/bpf/github.com/gorilla/mux/probe.go index 5617eb8f1..3b766ba38 100644 --- a/pkg/instrumentors/bpf/github.com/gorilla/mux/probe.go +++ b/pkg/instrumentors/bpf/github.com/gorilla/mux/probe.go @@ -12,6 +12,10 @@ // See the License for the specific language governing permissions and // limitations under the License. +// Package mux provides an instrumentation probe for the github.com/gorilla/mux +// package. +// +// Deprecated: This package will be removed in the next release. package mux import ( diff --git a/pkg/instrumentors/manager.go b/pkg/instrumentors/manager.go index 3f7c56ff2..0c2d66421 100644 --- a/pkg/instrumentors/manager.go +++ b/pkg/instrumentors/manager.go @@ -20,7 +20,7 @@ import ( "go.opentelemetry.io/auto/pkg/instrumentors/allocator" dbSql "go.opentelemetry.io/auto/pkg/instrumentors/bpf/database/sql" "go.opentelemetry.io/auto/pkg/instrumentors/bpf/github.com/gin-gonic/gin" - gorillaMux "go.opentelemetry.io/auto/pkg/instrumentors/bpf/github.com/gorilla/mux" + gorillaMux "go.opentelemetry.io/auto/pkg/instrumentors/bpf/github.com/gorilla/mux" // nolint:staticcheck // TODO: remove in #263 "go.opentelemetry.io/auto/pkg/instrumentors/bpf/google/golang/org/grpc" grpcServer "go.opentelemetry.io/auto/pkg/instrumentors/bpf/google/golang/org/grpc/server" httpClient "go.opentelemetry.io/auto/pkg/instrumentors/bpf/net/http/client" diff --git a/test/e2e/gorillamux/go.mod b/test/e2e/gorillamux/go.mod index 2020399ec..f87970487 100644 --- a/test/e2e/gorillamux/go.mod +++ b/test/e2e/gorillamux/go.mod @@ -1,3 +1,4 @@ +// Deprecated: This module will be removed in the next release. module go.opentelemetry.io/auto/test/e2e/gorillamux go 1.20