Skip to content

Add feature gate to disable log teeing when telemetry provider is set #13209

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions .chloggen/fg_teeing.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Use this changelog template to create an entry for release notes.

# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: enhancement

# The name of the component, or a single word describing the area of concern, (e.g. otlpreceiver)
component: service

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Adds feature gate for disabling tee'ing when telemetry provider is configured.

# One or more tracking issues or pull requests related to the change
issues: [13209]

# (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:

# 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: [user]
2 changes: 1 addition & 1 deletion service/go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ require (
go.opentelemetry.io/collector/receiver/receivertest v0.128.0
go.opentelemetry.io/collector/receiver/xreceiver v0.128.0
go.opentelemetry.io/collector/service/hostcapabilities v0.128.0
go.opentelemetry.io/contrib/bridges/otelzap v0.11.0
go.opentelemetry.io/contrib/otelconf v0.16.0
go.opentelemetry.io/contrib/propagators/b3 v1.36.0
go.opentelemetry.io/otel v1.36.0
Expand Down Expand Up @@ -111,7 +112,6 @@ require (
go.opentelemetry.io/collector/consumer/consumererror v0.128.0 // indirect
go.opentelemetry.io/collector/extension/extensionauth v1.34.0 // indirect
go.opentelemetry.io/collector/extension/extensionmiddleware v0.128.0 // indirect
go.opentelemetry.io/contrib/bridges/otelzap v0.11.0 // indirect
go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.61.0 // indirect
go.opentelemetry.io/contrib/zpages v0.61.0 // indirect
go.opentelemetry.io/otel/exporters/otlp/otlplog/otlploggrpc v0.12.2 // indirect
Expand Down
25 changes: 25 additions & 0 deletions service/telemetry/logger.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,25 @@
package telemetry // import "go.opentelemetry.io/collector/service/telemetry"

import (
"go.opentelemetry.io/contrib/bridges/otelzap"
"go.opentelemetry.io/otel/attribute"
"go.opentelemetry.io/otel/log"
"go.uber.org/zap"
"go.uber.org/zap/zapcore"

"go.opentelemetry.io/collector/featuregate"

"go.opentelemetry.io/collector/internal/telemetry/componentattribute"
)

var disableConsoleLoggingWhenProviderEnabled = featuregate.GlobalRegistry().MustRegister(
"telemetry.disableConsoleLoggingWhenProviderEnabled",
featuregate.StageAlpha,
featuregate.WithRegisterFromVersion("v0.129.0"),
featuregate.WithRegisterDescription("Disables console logging (tee-ing) when a logging provider is configured"),
featuregate.WithRegisterReferenceURL("https://github.com/open-telemetry/opentelemetry-collector/issues/13019"),
)

// newLogger creates a Logger and a LoggerProvider from Config.
func newLogger(set Settings, cfg Config) (*zap.Logger, log.LoggerProvider, error) {
// Copied from NewProductionConfig.
Expand Down Expand Up @@ -64,6 +75,20 @@

if len(cfg.Logs.Processors) > 0 && set.SDK != nil {
lp = set.SDK.LoggerProvider()

if disableConsoleLoggingWhenProviderEnabled.IsEnabled() {
attrs := attribute.NewSet()
otelCore, err := zapcore.NewIncreaseLevelCore(otelzap.NewCore(
"go.opentelemetry.io/collector/service/telemetry",
otelzap.WithLoggerProvider(lp),
otelzap.WithAttributes(attrs.ToSlice()...),
), zap.NewAtomicLevelAt(cfg.Logs.Level))
if err != nil {
panic(err)

Check warning on line 87 in service/telemetry/logger.go

View check run for this annotation

Codecov / codecov/patch

service/telemetry/logger.go#L87

Added line #L87 was not covered by tests
}
return otelCore
}

core = componentattribute.NewOTelTeeCoreWithAttributes(
core,
lp,
Expand Down
41 changes: 37 additions & 4 deletions service/telemetry/logger_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ import (
"testing"
"time"

"go.opentelemetry.io/collector/featuregate"

"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
config "go.opentelemetry.io/contrib/otelconf/v0.3.0"
Expand All @@ -32,10 +34,11 @@ type shutdownable interface {

func TestNewLogger(t *testing.T) {
tests := []struct {
name string
wantCoreType any
wantErr error
cfg Config
name string
wantCoreType any
disableTeeing bool
wantErr error
cfg Config
}{
{
name: "no log config",
Expand Down Expand Up @@ -80,6 +83,30 @@ func TestNewLogger(t *testing.T) {
},
wantCoreType: "*componentattribute.otelTeeCoreWithAttributes",
},
{
name: "log config with processors and tee'ing disabled",
cfg: Config{
Logs: LogsConfig{
Level: zapcore.DebugLevel,
Development: true,
Encoding: "console",
DisableCaller: true,
DisableStacktrace: true,
InitialFields: map[string]any{"fieldKey": "filed-value"},
Processors: []config.LogRecordProcessor{
{
Batch: &config.BatchLogRecordProcessor{
Exporter: config.LogRecordExporter{
Console: config.Console{},
},
},
},
},
},
},
disableTeeing: true,
wantCoreType: "*zapcore.levelFilterCore",
},
{
name: "log config with sampling",
cfg: Config{
Expand Down Expand Up @@ -109,6 +136,12 @@ func TestNewLogger(t *testing.T) {
Processors: tt.cfg.Logs.Processors,
}}))

if tt.disableTeeing == true {
_ = featuregate.GlobalRegistry().Set(disableConsoleLoggingWhenProviderEnabled.ID(), true)
defer func() {
_ = featuregate.GlobalRegistry().Set(disableConsoleLoggingWhenProviderEnabled.ID(), false)
}()
}
l, lp, err := newLogger(Settings{SDK: &sdk}, tt.cfg)
if tt.wantErr != nil {
require.ErrorContains(t, err, tt.wantErr.Error())
Expand Down
Loading