From 9dd4a5a8f500d92ed1877b36588b7640a6b07eb5 Mon Sep 17 00:00:00 2001 From: Bogdan Drutu Date: Fri, 14 Feb 2025 15:42:09 -0800 Subject: [PATCH] Remove unused not_component config for mdatagen (#12237) Signed-off-by: Bogdan Drutu --- .chloggen/rm-not-component.yaml | 25 +++++++++++++++++++ cmd/mdatagen/internal/command.go | 2 +- cmd/mdatagen/internal/status.go | 1 - .../metadatatest/generated_telemetrytest.go | 10 -------- processor/processorhelper/logs_test.go | 12 +++++++-- processor/processorhelper/metadata.yaml | 3 +-- processor/processorhelper/metrics_test.go | 4 +-- processor/processorhelper/traces_test.go | 4 +-- 8 files changed, 41 insertions(+), 20 deletions(-) create mode 100644 .chloggen/rm-not-component.yaml diff --git a/.chloggen/rm-not-component.yaml b/.chloggen/rm-not-component.yaml new file mode 100644 index 0000000000..9b9f03091b --- /dev/null +++ b/.chloggen/rm-not-component.yaml @@ -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: breaking + +# The name of the component, or a single word describing the area of concern, (e.g. otlpreceiver) +component: mdatagen + +# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). +note: Remove unused not_component config for mdatagen + +# One or more tracking issues or pull requests related to the change +issues: [12237] + +# (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: [api] diff --git a/cmd/mdatagen/internal/command.go b/cmd/mdatagen/internal/command.go index 35d6b93757..9c5293f5fa 100644 --- a/cmd/mdatagen/internal/command.go +++ b/cmd/mdatagen/internal/command.go @@ -78,7 +78,7 @@ func run(ymlPath string) error { codeDir := filepath.Join(ymlDir, "internal", md.GeneratedPackageName) toGenerate := map[string]string{} if md.Status != nil { - if md.Status.Class != "cmd" && md.Status.Class != "pkg" && !md.Status.NotComponent { + if md.Status.Class != "cmd" && md.Status.Class != "pkg" { toGenerate[filepath.Join(tmplDir, "status.go.tmpl")] = filepath.Join(codeDir, "generated_status.go") if err = generateFile(filepath.Join(tmplDir, "component_test.go.tmpl"), filepath.Join(ymlDir, "generated_component_test.go"), md, packageName); err != nil { diff --git a/cmd/mdatagen/internal/status.go b/cmd/mdatagen/internal/status.go index eafd86ca17..ebc95cff98 100644 --- a/cmd/mdatagen/internal/status.go +++ b/cmd/mdatagen/internal/status.go @@ -46,7 +46,6 @@ type Status struct { Warnings []string `mapstructure:"warnings"` Codeowners *Codeowners `mapstructure:"codeowners"` UnsupportedPlatforms []string `mapstructure:"unsupported_platforms"` - NotComponent bool `mapstructure:"not_component"` } func (s *Status) SortedDistributions() []string { diff --git a/processor/processorhelper/internal/metadatatest/generated_telemetrytest.go b/processor/processorhelper/internal/metadatatest/generated_telemetrytest.go index cfa500f6ea..75a7c3f0ad 100644 --- a/processor/processorhelper/internal/metadatatest/generated_telemetrytest.go +++ b/processor/processorhelper/internal/metadatatest/generated_telemetrytest.go @@ -9,19 +9,9 @@ import ( "go.opentelemetry.io/otel/sdk/metric/metricdata" "go.opentelemetry.io/otel/sdk/metric/metricdata/metricdatatest" - "go.opentelemetry.io/collector/component" "go.opentelemetry.io/collector/component/componenttest" - "go.opentelemetry.io/collector/processor" - "go.opentelemetry.io/collector/processor/processortest" ) -func NewSettings(tt *componenttest.Telemetry) processor.Settings { - set := processortest.NewNopSettingsWithType(processortest.NopType) - set.ID = component.NewID(component.MustNewType("processorhelper")) - set.TelemetrySettings = tt.NewTelemetrySettings() - return set -} - func AssertEqualProcessorIncomingItems(t *testing.T, tt *componenttest.Telemetry, dps []metricdata.DataPoint[int64], opts ...metricdatatest.Option) { want := metricdata.Metrics{ Name: "otelcol_processor_incoming_items", diff --git a/processor/processorhelper/logs_test.go b/processor/processorhelper/logs_test.go index d1e2fddab1..b01b78e83d 100644 --- a/processor/processorhelper/logs_test.go +++ b/processor/processorhelper/logs_test.go @@ -20,6 +20,7 @@ import ( "go.opentelemetry.io/collector/consumer" "go.opentelemetry.io/collector/consumer/consumertest" "go.opentelemetry.io/collector/pdata/plog" + "go.opentelemetry.io/collector/processor" "go.opentelemetry.io/collector/processor/processorhelper/internal/metadatatest" "go.opentelemetry.io/collector/processor/processortest" ) @@ -121,7 +122,7 @@ func TestLogs_RecordInOut(t *testing.T) { incomingLogRecords.AppendEmpty() tel := componenttest.NewTelemetry() - lp, err := NewLogs(context.Background(), metadatatest.NewSettings(tel), &testLogsCfg, consumertest.NewNop(), mockAggregate) + lp, err := NewLogs(context.Background(), newSettings(tel), &testLogsCfg, consumertest.NewNop(), mockAggregate) require.NoError(t, err) assert.NoError(t, lp.Start(context.Background(), componenttest.NewNopHost())) @@ -159,7 +160,7 @@ func TestLogs_RecordIn_ErrorOut(t *testing.T) { incomingLogRecords.AppendEmpty() tel := componenttest.NewTelemetry() - lp, err := NewLogs(context.Background(), metadatatest.NewSettings(tel), &testLogsCfg, consumertest.NewNop(), mockErr) + lp, err := NewLogs(context.Background(), newSettings(tel), &testLogsCfg, consumertest.NewNop(), mockErr) require.NoError(t, err) require.NoError(t, lp.Start(context.Background(), componenttest.NewNopHost())) @@ -181,3 +182,10 @@ func TestLogs_RecordIn_ErrorOut(t *testing.T) { }, }, metricdatatest.IgnoreTimestamp()) } + +func newSettings(tel *componenttest.Telemetry) processor.Settings { + set := processortest.NewNopSettings() + set.ID = component.NewID(component.MustNewType("processorhelper")) + set.TelemetrySettings = tel.NewTelemetrySettings() + return set +} diff --git a/processor/processorhelper/metadata.yaml b/processor/processorhelper/metadata.yaml index bd1dd0f229..b6197f1e45 100644 --- a/processor/processorhelper/metadata.yaml +++ b/processor/processorhelper/metadata.yaml @@ -2,8 +2,7 @@ type: processorhelper github_project: open-telemetry/opentelemetry-collector status: - class: processor - not_component: true + class: pkg stability: beta: [traces, metrics, logs] diff --git a/processor/processorhelper/metrics_test.go b/processor/processorhelper/metrics_test.go index 7593a52604..ae558325e3 100644 --- a/processor/processorhelper/metrics_test.go +++ b/processor/processorhelper/metrics_test.go @@ -121,7 +121,7 @@ func TestMetrics_RecordInOut(t *testing.T) { dps.AppendEmpty() tel := componenttest.NewTelemetry() - mp, err := NewMetrics(context.Background(), metadatatest.NewSettings(tel), &testMetricsCfg, consumertest.NewNop(), mockAggregate) + mp, err := NewMetrics(context.Background(), newSettings(tel), &testMetricsCfg, consumertest.NewNop(), mockAggregate) require.NoError(t, err) assert.NoError(t, mp.Start(context.Background(), componenttest.NewNopHost())) @@ -158,7 +158,7 @@ func TestMetrics_RecordIn_ErrorOut(t *testing.T) { dps.AppendEmpty() tel := componenttest.NewTelemetry() - mp, err := NewMetrics(context.Background(), metadatatest.NewSettings(tel), &testMetricsCfg, consumertest.NewNop(), mockErr) + mp, err := NewMetrics(context.Background(), newSettings(tel), &testMetricsCfg, consumertest.NewNop(), mockErr) require.NoError(t, err) require.NoError(t, mp.Start(context.Background(), componenttest.NewNopHost())) diff --git a/processor/processorhelper/traces_test.go b/processor/processorhelper/traces_test.go index f491d4f538..7131f4e31f 100644 --- a/processor/processorhelper/traces_test.go +++ b/processor/processorhelper/traces_test.go @@ -123,7 +123,7 @@ func TestTraces_RecordInOut(t *testing.T) { incomingSpans.AppendEmpty() tel := componenttest.NewTelemetry() - tp, err := NewTraces(context.Background(), metadatatest.NewSettings(tel), &testLogsCfg, consumertest.NewNop(), mockAggregate) + tp, err := NewTraces(context.Background(), newSettings(tel), &testLogsCfg, consumertest.NewNop(), mockAggregate) require.NoError(t, err) assert.NoError(t, tp.Start(context.Background(), componenttest.NewNopHost())) @@ -162,7 +162,7 @@ func TestTraces_RecordIn_ErrorOut(t *testing.T) { incomingSpans.AppendEmpty() tel := componenttest.NewTelemetry() - tp, err := NewTraces(context.Background(), metadatatest.NewSettings(tel), &testLogsCfg, consumertest.NewNop(), mockErr) + tp, err := NewTraces(context.Background(), newSettings(tel), &testLogsCfg, consumertest.NewNop(), mockErr) require.NoError(t, err) require.NoError(t, tp.Start(context.Background(), componenttest.NewNopHost()))