Skip to content

Commit 37fcef7

Browse files
committed
Update variable name
1 parent 0add644 commit 37fcef7

File tree

4 files changed

+23
-16
lines changed

4 files changed

+23
-16
lines changed

component/componenttest/nop_telemetry.go

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@ import (
1616
// NewNopTelemetrySettings returns a new nop telemetry settings for Create* functions.
1717
func NewNopTelemetrySettings() component.TelemetrySettings {
1818
return component.TelemetrySettings{
19-
Logger: zap.NewNop(),
20-
SampledLogger: zap.NewNop,
21-
TracerProvider: trace.NewNoopTracerProvider(),
22-
MeterProvider: noop.NewMeterProvider(),
23-
MetricsLevel: configtelemetry.LevelNone,
24-
Resource: pcommon.NewResource(),
19+
Logger: zap.NewNop(),
20+
GetSampledLoggerFunction: zap.NewNop,
21+
TracerProvider: trace.NewNoopTracerProvider(),
22+
MeterProvider: noop.NewMeterProvider(),
23+
MetricsLevel: configtelemetry.LevelNone,
24+
Resource: pcommon.NewResource(),
2525
}
2626
}

component/telemetry.go

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,8 @@ type TelemetrySettings struct {
1717
// component to be used later as well.
1818
Logger *zap.Logger
1919

20-
// SampledLogger is built from the logger. It is passed to the created component.
21-
// It will be used to avoid flooding the logs with messages that are repeated frequently.
22-
// It will be built the first time used.
23-
SampledLogger func() *zap.Logger
20+
// GetSampledLoggerFunction is a function to get the sampled Logger
21+
GetSampledLoggerFunction func() *zap.Logger
2422

2523
// TracerProvider that the factory can pass to other instrumented third-party libraries.
2624
TracerProvider trace.TracerProvider
@@ -35,3 +33,10 @@ type TelemetrySettings struct {
3533
// Resource contains the resource attributes for the collector's telemetry.
3634
Resource pcommon.Resource
3735
}
36+
37+
// SampledLogger is built from the logger. It is passed to the created component.
38+
// It will be used to avoid flooding the logs with messages that are repeated frequently.
39+
// It will be built the first time used.
40+
func (t *TelemetrySettings) SampledLogger() *zap.Logger {
41+
return t.GetSampledLoggerFunction()
42+
}

service/service.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -105,11 +105,11 @@ func New(ctx context.Context, set Settings, cfg Config) (*Service, error) {
105105
pcommonRes := pdataFromSdk(res)
106106

107107
srv.telemetrySettings = component.TelemetrySettings{
108-
Logger: srv.telemetry.Logger(),
109-
SampledLogger: srv.telemetry.SampledLogger(),
110-
TracerProvider: srv.telemetry.TracerProvider(),
111-
MeterProvider: noop.NewMeterProvider(),
112-
MetricsLevel: cfg.Telemetry.Metrics.Level,
108+
Logger: srv.telemetry.Logger(),
109+
GetSampledLoggerFunction: srv.telemetry.SampledLogger(),
110+
TracerProvider: srv.telemetry.TracerProvider(),
111+
MeterProvider: noop.NewMeterProvider(),
112+
MetricsLevel: cfg.Telemetry.Metrics.Level,
113113

114114
// Construct telemetry attributes from build info and config's resource attributes.
115115
Resource: pcommonRes,

service/service_test.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -412,8 +412,10 @@ func TestServiceTelemetryLoggers(t *testing.T) {
412412
assert.NoError(t, srv.Shutdown(context.Background()))
413413
})
414414
assert.NotNil(t, srv.telemetrySettings.Logger)
415-
assert.NotNil(t, srv.telemetrySettings.SampledLogger())
415+
assert.NotNil(t, srv.telemetrySettings.GetSampledLoggerFunction)
416416
assert.NotEqual(t, srv.telemetrySettings.Logger, srv.telemetrySettings.SampledLogger())
417+
sampledLogger := srv.telemetrySettings.GetSampledLoggerFunction()
418+
assert.Equal(t, sampledLogger, srv.telemetrySettings.SampledLogger())
417419
}
418420

419421
func assertResourceLabels(t *testing.T, res pcommon.Resource, expectedLabels map[string]labelValue) {

0 commit comments

Comments
 (0)