From df8aaaec98af5f9933e691d3dd9be4638ed8fc12 Mon Sep 17 00:00:00 2001 From: Bogdan Drutu Date: Mon, 13 Nov 2023 21:40:15 -0800 Subject: [PATCH] Fix connector logger zap kind key (#8878) Signed-off-by: Bogdan Drutu --- .chloggen/fixconnectorlogger.yaml | 13 +++++++++++++ component/component.go | 16 ++++++++++++++++ component/component_test.go | 10 ++++++++++ service/internal/components/loggers.go | 16 +++++++--------- 4 files changed, 46 insertions(+), 9 deletions(-) create mode 100755 .chloggen/fixconnectorlogger.yaml diff --git a/.chloggen/fixconnectorlogger.yaml b/.chloggen/fixconnectorlogger.yaml new file mode 100755 index 00000000000..5fe18bdfec8 --- /dev/null +++ b/.chloggen/fixconnectorlogger.yaml @@ -0,0 +1,13 @@ +# Use this changelog template to create an entry for release notes. + +# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' +change_type: 'bug_fix' + +# 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: "Fix connector logger zap kind key" + +# One or more tracking issues or pull requests related to the change +issues: [8878] diff --git a/component/component.go b/component/component.go index 3b3fe3fc7cf..e5f9e78c978 100644 --- a/component/component.go +++ b/component/component.go @@ -96,6 +96,22 @@ const ( KindConnector ) +func (k Kind) String() string { + switch k { + case KindReceiver: + return "Receiver" + case KindProcessor: + return "Processor" + case KindExporter: + return "Exporter" + case KindExtension: + return "Extension" + case KindConnector: + return "Connector" + } + return "" +} + // StabilityLevel represents the stability level of the component created by the factory. // The stability level is used to determine if the component should be used in production // or not. For more details see: diff --git a/component/component_test.go b/component/component_test.go index 4f8df15a6e6..8b694fb4303 100644 --- a/component/component_test.go +++ b/component/component_test.go @@ -9,6 +9,16 @@ import ( "github.com/stretchr/testify/assert" ) +func TestKindString(t *testing.T) { + assert.EqualValues(t, "", Kind(0).String()) + assert.EqualValues(t, "Receiver", KindReceiver.String()) + assert.EqualValues(t, "Processor", KindProcessor.String()) + assert.EqualValues(t, "Exporter", KindExporter.String()) + assert.EqualValues(t, "Extension", KindExtension.String()) + assert.EqualValues(t, "Connector", KindConnector.String()) + assert.EqualValues(t, "", Kind(100).String()) +} + func TestStabilityLevelString(t *testing.T) { assert.EqualValues(t, "Undefined", StabilityLevelUndefined.String()) assert.EqualValues(t, "Unmaintained", StabilityLevelUnmaintained.String()) diff --git a/service/internal/components/loggers.go b/service/internal/components/loggers.go index 30a6e29b9b2..026d4e189b2 100644 --- a/service/internal/components/loggers.go +++ b/service/internal/components/loggers.go @@ -4,6 +4,8 @@ package components // import "go.opentelemetry.io/collector/service/internal/components" import ( + "strings" + "go.uber.org/zap" "go.opentelemetry.io/collector/component" @@ -11,10 +13,6 @@ import ( const ( zapKindKey = "kind" - zapKindReceiver = "receiver" - zapKindProcessor = "processor" - zapKindExporter = "exporter" - zapKindExtension = "extension" zapNameKey = "name" zapDataTypeKey = "data_type" zapStabilityKey = "stability" @@ -25,34 +23,34 @@ const ( func ReceiverLogger(logger *zap.Logger, id component.ID, dt component.DataType) *zap.Logger { return logger.With( - zap.String(zapKindKey, zapKindReceiver), + zap.String(zapKindKey, strings.ToLower(component.KindReceiver.String())), zap.String(zapNameKey, id.String()), zap.String(zapDataTypeKey, string(dt))) } func ProcessorLogger(logger *zap.Logger, id component.ID, pipelineID component.ID) *zap.Logger { return logger.With( - zap.String(zapKindKey, zapKindProcessor), + zap.String(zapKindKey, strings.ToLower(component.KindProcessor.String())), zap.String(zapNameKey, id.String()), zap.String(zapPipelineKey, pipelineID.String())) } func ExporterLogger(logger *zap.Logger, id component.ID, dt component.DataType) *zap.Logger { return logger.With( - zap.String(zapKindKey, zapKindExporter), + zap.String(zapKindKey, strings.ToLower(component.KindExporter.String())), zap.String(zapDataTypeKey, string(dt)), zap.String(zapNameKey, id.String())) } func ExtensionLogger(logger *zap.Logger, id component.ID) *zap.Logger { return logger.With( - zap.String(zapKindKey, zapKindExtension), + zap.String(zapKindKey, strings.ToLower(component.KindExtension.String())), zap.String(zapNameKey, id.String())) } func ConnectorLogger(logger *zap.Logger, id component.ID, expDT, rcvDT component.DataType) *zap.Logger { return logger.With( - zap.String(zapKindKey, zapKindExporter), + zap.String(zapKindKey, strings.ToLower(component.KindConnector.String())), zap.String(zapNameKey, id.String()), zap.String(zapExporterInPipeline, string(expDT)), zap.String(zapReceiverInPipeline, string(rcvDT)))