diff --git a/CHANGELOG.md b/CHANGELOG.md index d83b4136ba1..2aa0cfb9940 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -63,6 +63,8 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm - The `go.opentelemetry.io/contrib/instrumentation/github.com/astaxie/beego/otelbeego` module is deprecated. (#4092, #4104) - The `go.opentelemetry.io/contrib/instrumentation/github.com/go-kit/kit/otelkit` module is deprecated. (#4093, #4104) - The `go.opentelemetry.io/contrib/instrumentation/github.com/Shopify/sarama/otelsarama` module is deprecated. (#4099) +- The `go.opentelemetry.io/contrib/instrumentation/github.com/bradfitz/gomemcache/memcache/otelmemcache` module is deprecated. (#4164) +- The `go.opentelemetry.io/contrib/instrumentation/github.com/gocql/gocql/otelgocql` module is deprecated. (#4164) ### Removed diff --git a/instrumentation/README.md b/instrumentation/README.md index ec8d072d912..93951140fad 100644 --- a/instrumentation/README.md +++ b/instrumentation/README.md @@ -43,10 +43,8 @@ The following instrumentation packages are provided for popular Go packages and | Instrumentation Package | Metrics | Traces | | :---------------------: | :-----: | :----: | | [github.com/aws/aws-sdk-go-v2](./github.com/aws/aws-sdk-go-v2/otelaws)| | ✓ | -| [github.com/bradfitz/gomemcache](./github.com/bradfitz/gomemcache/memcache/otelmemcache) | | ✓ | | [github.com/emicklei/go-restful](./github.com/emicklei/go-restful/otelrestful) | | ✓ | | [github.com/gin-gonic/gin](./github.com/gin-gonic/gin/otelgin) | | ✓ | -| [github.com/gocql/gocql](./github.com/gocql/gocql/otelgocql) | ✓ | ✓ | | [github.com/gorilla/mux](./github.com/gorilla/mux/otelmux) | | ✓ | | [github.com/labstack/echo](./github.com/labstack/echo/otelecho) | | ✓ | | [go.mongodb.org/mongo-driver](./go.mongodb.org/mongo-driver/mongo/otelmongo) | | ✓ | @@ -57,7 +55,6 @@ The following instrumentation packages are provided for popular Go packages and | [net/http/httptrace](./net/http/httptrace/otelhttptrace) | | ✓ | | [runtime](./runtime) | ✓ | | - ## Organization In order to ensure the maintainability and discoverability of instrumentation packages, the following guidelines MUST be followed. @@ -66,7 +63,7 @@ In order to ensure the maintainability and discoverability of instrumentation pa All instrumentation packages SHOULD be of the form: -``` +```sh go.opentelemetry.io/contrib/instrumentation/{IMPORT_PATH}/otel{PACKAGE_NAME} ``` @@ -90,7 +87,7 @@ Additionally the following guidelines for package composition need to be followe Therefore, an appropriately configured `go.mod` and `go.sum` need to exist for each package. - To help understand the instrumentation a Go package documentation SHOULD be included. This documentation SHOULD be in a dedicated `doc.go` file if the package is more than one file. - It SHOULD contain useful information like what the purpose of the instrumentation is, how to use it, and any compatibility restrictions that might exist. + It SHOULD contain useful information like what the purpose of the instrumentation is, how to use it, and any compatibility restrictions that might exist. - Examples of how to actually use the instrumentation SHOULD be included. - All instrumentation packages MUST provide an option to accept a `TracerProvider` if it uses a Tracer, a `MeterProvider` if it uses a Meter, and `Propagators` if it handles any context propagation. Also, packages MUST use the default `TracerProvider`, `MeterProvider`, and `Propagators` supplied by the `global` package if no optional one is provided. diff --git a/instrumentation/github.com/Shopify/sarama/otelsarama/example/go.mod b/instrumentation/github.com/Shopify/sarama/otelsarama/example/go.mod index 4defe1368de..546456a1a75 100644 --- a/instrumentation/github.com/Shopify/sarama/otelsarama/example/go.mod +++ b/instrumentation/github.com/Shopify/sarama/otelsarama/example/go.mod @@ -1,3 +1,5 @@ +// Deprecated: This module is no longer supported. +// github.com/Shopify/sarama moved to github.com/IBM/sarama. module go.opentelemetry.io/contrib/instrumentation/github.com/Shopify/sarama/otelsarama/example go 1.18 diff --git a/instrumentation/github.com/astaxie/beego/otelbeego/example/go.mod b/instrumentation/github.com/astaxie/beego/otelbeego/example/go.mod index 7229e389ff6..3789a63fba9 100644 --- a/instrumentation/github.com/astaxie/beego/otelbeego/example/go.mod +++ b/instrumentation/github.com/astaxie/beego/otelbeego/example/go.mod @@ -1,3 +1,4 @@ +// Deprecated: This module is no longer supported. module go.opentelemetry.io/contrib/instrumentation/github.com/astaxie/beego/otelbeego/example go 1.18 diff --git a/instrumentation/github.com/bradfitz/gomemcache/memcache/otelmemcache/doc.go b/instrumentation/github.com/bradfitz/gomemcache/memcache/otelmemcache/doc.go index 177e593d0ea..9f906812057 100644 --- a/instrumentation/github.com/bradfitz/gomemcache/memcache/otelmemcache/doc.go +++ b/instrumentation/github.com/bradfitz/gomemcache/memcache/otelmemcache/doc.go @@ -19,4 +19,6 @@ // // The instrumentation works by wrapping the memcached client by calling // `NewClientWithTracing` and tracing it's every operation. +// +// Deprecated: This module is no longer supported. package otelmemcache // import "go.opentelemetry.io/contrib/instrumentation/github.com/bradfitz/gomemcache/memcache/otelmemcache" diff --git a/instrumentation/github.com/bradfitz/gomemcache/memcache/otelmemcache/example/client.go b/instrumentation/github.com/bradfitz/gomemcache/memcache/otelmemcache/example/client.go index fd9c3d16325..d7fe9ce50cb 100644 --- a/instrumentation/github.com/bradfitz/gomemcache/memcache/otelmemcache/example/client.go +++ b/instrumentation/github.com/bradfitz/gomemcache/memcache/otelmemcache/example/client.go @@ -21,7 +21,7 @@ import ( "github.com/bradfitz/gomemcache/memcache" - "go.opentelemetry.io/contrib/instrumentation/github.com/bradfitz/gomemcache/memcache/otelmemcache" + "go.opentelemetry.io/contrib/instrumentation/github.com/bradfitz/gomemcache/memcache/otelmemcache" //nolint:staticcheck // This is deprecated and will be removed in the next release. oteltracestdout "go.opentelemetry.io/otel/exporters/stdout/stdouttrace" sdktrace "go.opentelemetry.io/otel/sdk/trace" diff --git a/instrumentation/github.com/bradfitz/gomemcache/memcache/otelmemcache/go.mod b/instrumentation/github.com/bradfitz/gomemcache/memcache/otelmemcache/go.mod index 6f4942c7dd7..412e99a035c 100644 --- a/instrumentation/github.com/bradfitz/gomemcache/memcache/otelmemcache/go.mod +++ b/instrumentation/github.com/bradfitz/gomemcache/memcache/otelmemcache/go.mod @@ -1,3 +1,4 @@ +// Deprecated: This module is no longer supported. module go.opentelemetry.io/contrib/instrumentation/github.com/bradfitz/gomemcache/memcache/otelmemcache go 1.19 diff --git a/instrumentation/github.com/bradfitz/gomemcache/memcache/otelmemcache/test/gomemcache_test.go b/instrumentation/github.com/bradfitz/gomemcache/memcache/otelmemcache/test/gomemcache_test.go index 7d29fd859b4..c229de0064b 100644 --- a/instrumentation/github.com/bradfitz/gomemcache/memcache/otelmemcache/test/gomemcache_test.go +++ b/instrumentation/github.com/bradfitz/gomemcache/memcache/otelmemcache/test/gomemcache_test.go @@ -22,7 +22,7 @@ import ( "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" - "go.opentelemetry.io/contrib/instrumentation/github.com/bradfitz/gomemcache/memcache/otelmemcache" + "go.opentelemetry.io/contrib/instrumentation/github.com/bradfitz/gomemcache/memcache/otelmemcache" //nolint:staticcheck // This is deprecated and will be removed in the next release. "go.opentelemetry.io/contrib/instrumentation/github.com/bradfitz/gomemcache/memcache/otelmemcache/internal" "go.opentelemetry.io/contrib/internal/util" "go.opentelemetry.io/otel/codes" diff --git a/instrumentation/github.com/go-kit/kit/otelkit/example/go.mod b/instrumentation/github.com/go-kit/kit/otelkit/example/go.mod index 08bc8e6d206..b6f7bf56475 100644 --- a/instrumentation/github.com/go-kit/kit/otelkit/example/go.mod +++ b/instrumentation/github.com/go-kit/kit/otelkit/example/go.mod @@ -1,3 +1,4 @@ +// Deprecated: This module is no longer supported. module go.opentelemetry.io/contrib/instrumentation/github.com/go-kit/kit/otelkit/example go 1.18 diff --git a/instrumentation/github.com/gocql/gocql/otelgocql/doc.go b/instrumentation/github.com/gocql/gocql/otelgocql/doc.go index a28c5face2e..b15c5354603 100644 --- a/instrumentation/github.com/gocql/gocql/otelgocql/doc.go +++ b/instrumentation/github.com/gocql/gocql/otelgocql/doc.go @@ -13,4 +13,6 @@ // limitations under the License. // Package otelgocql instruments the github.com/gocql/gocql package. +// +// Deprecated: This module is no longer supported. package otelgocql // import "go.opentelemetry.io/contrib/instrumentation/github.com/gocql/gocql/otelgocql" diff --git a/instrumentation/github.com/gocql/gocql/otelgocql/example/client.go b/instrumentation/github.com/gocql/gocql/otelgocql/example/client.go index 0797803a860..9349e7be0da 100644 --- a/instrumentation/github.com/gocql/gocql/otelgocql/example/client.go +++ b/instrumentation/github.com/gocql/gocql/otelgocql/example/client.go @@ -48,7 +48,7 @@ import ( "go.opentelemetry.io/otel/sdk/metric" "go.opentelemetry.io/otel/sdk/trace" - "go.opentelemetry.io/contrib/instrumentation/github.com/gocql/gocql/otelgocql" + "go.opentelemetry.io/contrib/instrumentation/github.com/gocql/gocql/otelgocql" //nolint:staticcheck // This is deprecated and will be removed in the next release. ) const keyspace = "gocql_integration_example" diff --git a/instrumentation/github.com/gocql/gocql/otelgocql/example/doc.go b/instrumentation/github.com/gocql/gocql/otelgocql/example/doc.go index 558f5bee2df..a57be4f3412 100644 --- a/instrumentation/github.com/gocql/gocql/otelgocql/example/doc.go +++ b/instrumentation/github.com/gocql/gocql/otelgocql/example/doc.go @@ -13,4 +13,6 @@ // limitations under the License. // Package main provides an example use of the otelgocql instrumentation. +// +// Deprecated: This module is no longer supported. package main diff --git a/instrumentation/github.com/gocql/gocql/otelgocql/example/go.mod b/instrumentation/github.com/gocql/gocql/otelgocql/example/go.mod index 8c9f2e9f4b4..2ecc4c394dc 100644 --- a/instrumentation/github.com/gocql/gocql/otelgocql/example/go.mod +++ b/instrumentation/github.com/gocql/gocql/otelgocql/example/go.mod @@ -1,3 +1,4 @@ +// Deprecated: This module is no longer supported. module go.opentelemetry.io/contrib/instrumentation/github.com/gocql/gocql/otelgocql/example go 1.18 diff --git a/instrumentation/github.com/gocql/gocql/otelgocql/go.mod b/instrumentation/github.com/gocql/gocql/otelgocql/go.mod index ec4610a2d49..fad543eb542 100644 --- a/instrumentation/github.com/gocql/gocql/otelgocql/go.mod +++ b/instrumentation/github.com/gocql/gocql/otelgocql/go.mod @@ -1,3 +1,4 @@ +// Deprecated: This module is no longer supported. module go.opentelemetry.io/contrib/instrumentation/github.com/gocql/gocql/otelgocql go 1.19 diff --git a/instrumentation/github.com/gocql/gocql/otelgocql/test/gocql_test.go b/instrumentation/github.com/gocql/gocql/otelgocql/test/gocql_test.go index ddacd2df72d..0479b98a8ef 100644 --- a/instrumentation/github.com/gocql/gocql/otelgocql/test/gocql_test.go +++ b/instrumentation/github.com/gocql/gocql/otelgocql/test/gocql_test.go @@ -26,7 +26,7 @@ import ( "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" - "go.opentelemetry.io/contrib/instrumentation/github.com/gocql/gocql/otelgocql" + "go.opentelemetry.io/contrib/instrumentation/github.com/gocql/gocql/otelgocql" //nolint:staticcheck // This is deprecated and will be removed in the next release. "go.opentelemetry.io/contrib/instrumentation/github.com/gocql/gocql/otelgocql/internal" "go.opentelemetry.io/contrib/internal/util" "go.opentelemetry.io/otel/attribute" diff --git a/zpages/doc.go b/zpages/doc.go new file mode 100644 index 00000000000..e663fa1c2ee --- /dev/null +++ b/zpages/doc.go @@ -0,0 +1,17 @@ +// Copyright The OpenTelemetry Authors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// Package zpages implements a collection of HTML pages that display +// telemetry stats. +package zpages // import "go.opentelemetry.io/contrib/zpages"