[component] Deprecate TelemetrySettings.MetricsLevel (#12159)

<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description

<!-- Issue number if applicable -->

- Deprecates `component.TelemetrySettings.MetricsLevel`
- Sets the value passed to components to always be
`configtelemetry.LevelDetailed`

#### Link to tracking issue

Updates #11061
This commit is contained in:
Pablo Baeyens 2025-01-24 12:05:26 +00:00 committed by GitHub
parent e8807bfe94
commit 2447a81885
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
7 changed files with 34 additions and 6 deletions

View File

@ -0,0 +1,26 @@
# Use this changelog template to create an entry for release notes.
# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: deprecation
# The name of the component, or a single word describing the area of concern, (e.g. otlpreceiver)
component: component
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Deprecate `component.TelemetrySettings.MetricsLevel` in favor of using views and 'Enabled' method.
# One or more tracking issues or pull requests related to the change
issues: [12159]
# (Optional) One or more lines of additional information to render under the primary note.
# These lines will be padded with 2 spaces and then inserted directly into the document.
# Use pipe (|) for multiline entries.
subtext: |
- Components will temporarily need the service to support using views.
# Optional: The change log or logs in which this entry should be included.
# e.g. '[user]' or '[user, api]'
# Include 'user' if the change is relevant to end users.
# Include 'api' if there is a change to a library API.
# Default: '[user]'
change_logs: [api]

View File

@ -22,6 +22,6 @@ func TestNewNopTelemetrySettings(t *testing.T) {
assert.NotPanics(t, func() {
nts.MeterProvider.Meter("test")
})
assert.Equal(t, configtelemetry.LevelNone, nts.MetricsLevel)
assert.Equal(t, configtelemetry.LevelNone, nts.MetricsLevel) //nolint:staticcheck
assert.Equal(t, 0, nts.Resource.Attributes().Len())
}

View File

@ -68,7 +68,7 @@ func NewTelemetry(opts ...TelemetryOption) Telemetry {
func (tt *Telemetry) NewTelemetrySettings() component.TelemetrySettings {
set := NewNopTelemetrySettings()
set.MeterProvider = tt.meterProvider
set.MetricsLevel = configtelemetry.LevelDetailed
set.MetricsLevel = configtelemetry.LevelDetailed //nolint:staticcheck //SA1019
set.TracerProvider = tt.traceProvider
return set
}

View File

@ -20,7 +20,7 @@ func TestNewTelemetry(t *testing.T) {
assert.NotNil(t, tel.Reader)
assert.NotNil(t, tel.SpanRecorder)
set := tel.NewTelemetrySettings()
assert.Equal(t, configtelemetry.LevelDetailed, set.MetricsLevel)
assert.Equal(t, configtelemetry.LevelDetailed, set.MetricsLevel) //nolint:staticcheck //SA1019
assert.IsType(t, &sdktrace.TracerProvider{}, set.TracerProvider)
assert.IsType(t, &sdkmetric.MeterProvider{}, set.MeterProvider)
require.NoError(t, tel.Shutdown(context.Background()))

View File

@ -27,6 +27,9 @@ type TelemetrySettings struct {
// MetricsLevel represents the configuration value set when the collector
// is configured. Components may use this level to decide whether it is
// appropriate to avoid computationally expensive calculations.
//
// Deprecated: [v0.119.0] Use https://pkg.go.dev/go.opentelemetry.io/otel/sdk/metric@v1.34.0/internal/x#readme-instrument-enabled instead.
// Components will temporarily need to add a view to `service/telemetry` to drop metrics based on the level.
MetricsLevel configtelemetry.Level
// Resource contains the resource attributes for the collector's telemetry.

View File

@ -29,7 +29,6 @@ import (
"go.opentelemetry.io/collector/config/configauth"
"go.opentelemetry.io/collector/config/configcompression"
"go.opentelemetry.io/collector/config/configopaque"
"go.opentelemetry.io/collector/config/configtelemetry"
"go.opentelemetry.io/collector/config/configtls"
"go.opentelemetry.io/collector/extension/auth"
"go.opentelemetry.io/collector/extension/auth/authtest"
@ -49,7 +48,7 @@ var (
dummyID = component.MustNewID("dummy")
nonExistingID = component.MustNewID("nonexisting")
// Omit TracerProvider and MeterProvider in TelemetrySettings as otelhttp.Transport cannot be introspected
nilProvidersSettings = component.TelemetrySettings{Logger: zap.NewNop(), MetricsLevel: configtelemetry.LevelNone}
nilProvidersSettings = component.TelemetrySettings{Logger: zap.NewNop()}
)
func TestAllHTTPClientSettings(t *testing.T) {

View File

@ -14,7 +14,6 @@ require (
go.opentelemetry.io/collector/config/configauth v0.118.0
go.opentelemetry.io/collector/config/configcompression v1.24.0
go.opentelemetry.io/collector/config/configopaque v1.24.0
go.opentelemetry.io/collector/config/configtelemetry v0.118.0
go.opentelemetry.io/collector/config/configtls v1.24.0
go.opentelemetry.io/collector/extension/auth v0.118.0
go.opentelemetry.io/collector/extension/auth/authtest v0.118.0
@ -35,6 +34,7 @@ require (
github.com/google/uuid v1.6.0 // indirect
github.com/pmezard/go-difflib v1.0.0 // indirect
go.opentelemetry.io/auto/sdk v1.1.0 // indirect
go.opentelemetry.io/collector/config/configtelemetry v0.118.0 // indirect
go.opentelemetry.io/collector/extension v0.118.0 // indirect
go.opentelemetry.io/collector/pdata v1.24.0 // indirect
go.opentelemetry.io/otel/metric v1.34.0 // indirect