Skip to content

Commit

Permalink
Deprecate otelmemcache, otelgocql (#4164)
Browse files Browse the repository at this point in the history
  • Loading branch information
pellared authored Sep 6, 2023
1 parent 417fc12 commit 3ad5a2c
Show file tree
Hide file tree
Showing 16 changed files with 38 additions and 9 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
7 changes: 2 additions & 5 deletions instrumentation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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) | ||
Expand All @@ -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.
Expand All @@ -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}
```

Expand All @@ -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.
Expand Down
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 2 additions & 0 deletions instrumentation/github.com/gocql/gocql/otelgocql/doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 1 addition & 0 deletions instrumentation/github.com/gocql/gocql/otelgocql/go.mod
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
17 changes: 17 additions & 0 deletions zpages/doc.go
Original file line number Diff line number Diff line change
@@ -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"

0 comments on commit 3ad5a2c

Please sign in to comment.