From e3ed198611123c91cb8133244ebda5537eb21ef8 Mon Sep 17 00:00:00 2001 From: Tyler Yahn Date: Tue, 8 Aug 2023 09:19:17 -0700 Subject: [PATCH] Deprecate the otlpmetric/internal package and sub-packages (#4420) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Deprecate the otlpmetric/internal package and sub-packages * Add stub to changelog * Add PR number to changelog stubs --------- Co-authored-by: Robert Pająk --- CHANGELOG.md | 4 ++++ exporters/otlp/otlpmetric/internal/exporter.go | 16 +++++----------- .../otlp/otlpmetric/internal/oconf/options.go | 11 ++++++++--- .../otlp/otlpmetric/internal/otest/client.go | 7 ++++++- .../otlpmetric/internal/otest/client_test.go | 4 ++-- .../otlp/otlpmetric/internal/otest/collector.go | 2 +- .../otlp/otlpmetric/internal/transform/doc.go | 3 +++ 7 files changed, 29 insertions(+), 18 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a6679c4b3b4..f5b9d37f2f4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -68,6 +68,10 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm ### Deprecated +- The `go.opentelemetry.io/otel/exporters/otlp/otlpmetric/internal` package is deprecated. (#4420) +- The `go.opentelemetry.io/otel/exporters/otlp/otlpmetric/internal/oconf` package is deprecated. (#4420) +- The `go.opentelemetry.io/otel/exporters/otlp/otlpmetric/internal/otest` package is deprecated. (#4420) +- The `go.opentelemetry.io/otel/exporters/otlp/otlpmetric/internal/transform` package is deprecated. (#4420) - The `go.opentelemetry.io/otel/exporters/otlp/internal` package is deprecated. (#4421) - The `go.opentelemetry.io/otel/exporters/otlp/internal/envconfig` package is deprecated. (#4421) - The `go.opentelemetry.io/otel/exporters/otlp/internal/retry` package is deprecated. (#4421) diff --git a/exporters/otlp/otlpmetric/internal/exporter.go b/exporters/otlp/otlpmetric/internal/exporter.go index f4428ac556f..73c51320ec2 100644 --- a/exporters/otlp/otlpmetric/internal/exporter.go +++ b/exporters/otlp/otlpmetric/internal/exporter.go @@ -12,6 +12,10 @@ // See the License for the specific language governing permissions and // limitations under the License. +// Package internal provides common utilities for all otlpmetric exporters. +// +// Deprecated: package internal exists for historical compatibility, it should +// not be used. package internal // import "go.opentelemetry.io/otel/exporters/otlp/otlpmetric/internal" import ( @@ -19,7 +23,7 @@ import ( "fmt" "sync" - "go.opentelemetry.io/otel/exporters/otlp/otlpmetric/internal/transform" + "go.opentelemetry.io/otel/exporters/otlp/otlpmetric/internal/transform" // nolint: staticcheck // Atomic deprecation. "go.opentelemetry.io/otel/sdk/metric" "go.opentelemetry.io/otel/sdk/metric/aggregation" "go.opentelemetry.io/otel/sdk/metric/metricdata" @@ -27,11 +31,6 @@ import ( ) // Exporter exports metrics data as OTLP. -// -// Deprecated: Exporter exists for historical compatibility, it should not be -// used. Do not remove Exporter unless the whole -// "go.opentelemetry.io/otel/exporters/otlp/otlpmetric/internal" module is -// removed. type Exporter struct { // Ensure synchronous access to the client across all functionality. clientMu sync.Mutex @@ -101,11 +100,6 @@ func (e *Exporter) Shutdown(ctx context.Context) error { // New return an Exporter that uses client to transmits the OTLP data it // produces. The client is assumed to be fully started and able to communicate // with its OTLP receiving endpoint. -// -// Deprecated: New exists for historical compatibility, it should not be used. -// Do not remove New unless the whole -// "go.opentelemetry.io/otel/exporters/otlp/otlpmetric/internal" module is -// removed. func New(client Client) *Exporter { return &Exporter{client: client} } diff --git a/exporters/otlp/otlpmetric/internal/oconf/options.go b/exporters/otlp/otlpmetric/internal/oconf/options.go index 8aa282ad8a1..a5e71a86cfb 100644 --- a/exporters/otlp/otlpmetric/internal/oconf/options.go +++ b/exporters/otlp/otlpmetric/internal/oconf/options.go @@ -12,6 +12,11 @@ // See the License for the specific language governing permissions and // limitations under the License. +// Package oconf provides common metric configuration types and functionality +// for all otlpmetric exporters. +// +// Deprecated: package oconf exists for historical compatibility, it should not +// be used. package oconf // import "go.opentelemetry.io/otel/exporters/otlp/otlpmetric/internal/oconf" import ( @@ -25,9 +30,9 @@ import ( "google.golang.org/grpc/credentials/insecure" "google.golang.org/grpc/encoding/gzip" - "go.opentelemetry.io/otel/exporters/otlp/internal" // nolint: staticcheck // Synchronous deprecation. - "go.opentelemetry.io/otel/exporters/otlp/internal/retry" // nolint: staticcheck // Synchronous deprecation. - ominternal "go.opentelemetry.io/otel/exporters/otlp/otlpmetric/internal" + "go.opentelemetry.io/otel/exporters/otlp/internal" // nolint: staticcheck // Synchronous deprecation. + "go.opentelemetry.io/otel/exporters/otlp/internal/retry" // nolint: staticcheck // Synchronous deprecation. + ominternal "go.opentelemetry.io/otel/exporters/otlp/otlpmetric/internal" // nolint: staticcheck // Atomic deprecation. "go.opentelemetry.io/otel/internal/global" "go.opentelemetry.io/otel/sdk/metric" "go.opentelemetry.io/otel/sdk/metric/aggregation" diff --git a/exporters/otlp/otlpmetric/internal/otest/client.go b/exporters/otlp/otlpmetric/internal/otest/client.go index a315869c17d..2200413e49c 100644 --- a/exporters/otlp/otlpmetric/internal/otest/client.go +++ b/exporters/otlp/otlpmetric/internal/otest/client.go @@ -12,6 +12,11 @@ // See the License for the specific language governing permissions and // limitations under the License. +// Package otest provides common testing utilities for all otlpmetric +// exporters. +// +// Deprecated: package otest exists for historical compatibility, it should not +// be used. package otest // import "go.opentelemetry.io/otel/exporters/otlp/otlpmetric/internal/otest" import ( @@ -26,7 +31,7 @@ import ( "google.golang.org/protobuf/proto" "go.opentelemetry.io/otel" - "go.opentelemetry.io/otel/exporters/otlp/otlpmetric/internal" + "go.opentelemetry.io/otel/exporters/otlp/otlpmetric/internal" // nolint: staticcheck // Atomic deprecation. semconv "go.opentelemetry.io/otel/semconv/v1.21.0" collpb "go.opentelemetry.io/proto/otlp/collector/metrics/v1" cpb "go.opentelemetry.io/proto/otlp/common/v1" diff --git a/exporters/otlp/otlpmetric/internal/otest/client_test.go b/exporters/otlp/otlpmetric/internal/otest/client_test.go index a0d9bd5eec3..2c2ddcc9c01 100644 --- a/exporters/otlp/otlpmetric/internal/otest/client_test.go +++ b/exporters/otlp/otlpmetric/internal/otest/client_test.go @@ -19,8 +19,8 @@ import ( "testing" "go.opentelemetry.io/otel" - "go.opentelemetry.io/otel/exporters/otlp/internal" // nolint: staticcheck // Synchronous deprecation. - ominternal "go.opentelemetry.io/otel/exporters/otlp/otlpmetric/internal" + "go.opentelemetry.io/otel/exporters/otlp/internal" // nolint: staticcheck // Synchronous deprecation. + ominternal "go.opentelemetry.io/otel/exporters/otlp/otlpmetric/internal" // nolint: staticcheck // Atomic deprecation. "go.opentelemetry.io/otel/sdk/metric" "go.opentelemetry.io/otel/sdk/metric/aggregation" "go.opentelemetry.io/otel/sdk/metric/metricdata" diff --git a/exporters/otlp/otlpmetric/internal/otest/collector.go b/exporters/otlp/otlpmetric/internal/otest/collector.go index 34756f4ccf5..b31e308c965 100644 --- a/exporters/otlp/otlpmetric/internal/otest/collector.go +++ b/exporters/otlp/otlpmetric/internal/otest/collector.go @@ -39,7 +39,7 @@ import ( "google.golang.org/grpc/metadata" "google.golang.org/protobuf/proto" - "go.opentelemetry.io/otel/exporters/otlp/otlpmetric/internal/oconf" + "go.opentelemetry.io/otel/exporters/otlp/otlpmetric/internal/oconf" // nolint: staticcheck // Atomic deprecation. collpb "go.opentelemetry.io/proto/otlp/collector/metrics/v1" mpb "go.opentelemetry.io/proto/otlp/metrics/v1" ) diff --git a/exporters/otlp/otlpmetric/internal/transform/doc.go b/exporters/otlp/otlpmetric/internal/transform/doc.go index 7a79f794dd1..59c4951e211 100644 --- a/exporters/otlp/otlpmetric/internal/transform/doc.go +++ b/exporters/otlp/otlpmetric/internal/transform/doc.go @@ -14,4 +14,7 @@ // Package transform provides transformation functionality from the // sdk/metric/metricdata data-types into OTLP data-types. +// +// Deprecated: package transform exists for historical compatibility, it should +// not be used. package transform // import "go.opentelemetry.io/otel/exporters/otlp/otlpmetric/internal/transform"