diff --git a/.chloggen/type-aliases.yaml b/.chloggen/type-aliases.yaml new file mode 100644 index 000000000000..cb6b735a03e8 --- /dev/null +++ b/.chloggen/type-aliases.yaml @@ -0,0 +1,35 @@ +# 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. receiver/otlp) +component: all + +# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). +note: Add support for deprecated component type aliases + +# (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: | + To add a deprecated type alias to a component factory, use the `WithDeprecatedTypeAlias` option. + ```go + return xexporter.NewFactory( + metadata.Type, + createDefaultConfig, + xexporter.WithTraces(createTracesExporter, metadata.TracesStability), + xexporter.WithDeprecatedTypeAlias("old_component_name"), + ) + ``` + When the alias is used in configuration, a deprecation warning will be automatically logged, and the component will function normally using the original implementation. + +# One or more tracking issues or pull requests related to the change +issues: [14208] + +# 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/.github/workflows/utils/cspell.json b/.github/workflows/utils/cspell.json index dcec12199e69..d6691af5e840 100644 --- a/.github/workflows/utils/cspell.json +++ b/.github/workflows/utils/cspell.json @@ -125,6 +125,7 @@ "cmux", "codeboten", "codeowners", + "componentalias", "componenterror", "componenthelper", "componentprofiles", diff --git a/cmd/builder/internal/builder/main_test.go b/cmd/builder/internal/builder/main_test.go index f6660b4795e4..76ef5e064ea3 100644 --- a/cmd/builder/internal/builder/main_test.go +++ b/cmd/builder/internal/builder/main_test.go @@ -88,6 +88,7 @@ var replaceModules = []string{ "/extension/zpagesextension", "/extension/xextension", "/featuregate", + "/internal/componentalias", "/internal/memorylimiter", "/internal/fanoutconsumer", "/internal/sharedcomponent", diff --git a/cmd/builder/internal/builder/templates/components.go.tmpl b/cmd/builder/internal/builder/templates/components.go.tmpl index d9722a9cb5d6..4fe7dfc81f82 100644 --- a/cmd/builder/internal/builder/templates/components.go.tmpl +++ b/cmd/builder/internal/builder/templates/components.go.tmpl @@ -28,6 +28,20 @@ import ( {{- end}} ) +type aliasProvider interface{ DeprecatedAlias() component.Type } + +func makeModulesMap[T component.Factory](factories map[component.Type]T, modules map[component.Type]string) map[component.Type]string { + for compType, factory := range factories { + if ap, ok := any(factory).(aliasProvider); ok { + alias := ap.DeprecatedAlias() + if alias.String() != "" { + modules[alias] = modules[compType] + } + } + } + return modules +} + func components() (otelcol.Factories, error) { var err error factories := otelcol.Factories{ @@ -42,10 +56,11 @@ func components() (otelcol.Factories, error) { if err != nil { return otelcol.Factories{}, err } - factories.ExtensionModules = make(map[component.Type]string, len(factories.Extensions)) - {{- range .Extensions}} - factories.ExtensionModules[{{.Name}}.NewFactory().Type()] = "{{.GoMod}}" - {{- end}} + factories.ExtensionModules = makeModulesMap(factories.Extensions, map[component.Type]string{ + {{- range .Extensions}} + {{.Name}}.NewFactory().Type(): "{{.GoMod}}", + {{- end}} + }) factories.Receivers, err = otelcol.MakeFactoryMap[receiver.Factory]( {{- range .Receivers}} @@ -55,10 +70,11 @@ func components() (otelcol.Factories, error) { if err != nil { return otelcol.Factories{}, err } - factories.ReceiverModules = make(map[component.Type]string, len(factories.Receivers)) - {{- range .Receivers}} - factories.ReceiverModules[{{.Name}}.NewFactory().Type()] = "{{.GoMod}}" - {{- end}} + factories.ReceiverModules = makeModulesMap(factories.Receivers, map[component.Type]string{ + {{- range .Receivers}} + {{.Name}}.NewFactory().Type(): "{{.GoMod}}", + {{- end}} + }) factories.Exporters, err = otelcol.MakeFactoryMap[exporter.Factory]( {{- range .Exporters}} @@ -68,10 +84,11 @@ func components() (otelcol.Factories, error) { if err != nil { return otelcol.Factories{}, err } - factories.ExporterModules = make(map[component.Type]string, len(factories.Exporters)) - {{- range .Exporters}} - factories.ExporterModules[{{.Name}}.NewFactory().Type()] = "{{.GoMod}}" - {{- end}} + factories.ExporterModules = makeModulesMap(factories.Exporters, map[component.Type]string{ + {{- range .Exporters}} + {{.Name}}.NewFactory().Type(): "{{.GoMod}}", + {{- end}} + }) factories.Processors, err = otelcol.MakeFactoryMap[processor.Factory]( {{- range .Processors}} @@ -81,10 +98,11 @@ func components() (otelcol.Factories, error) { if err != nil { return otelcol.Factories{}, err } - factories.ProcessorModules = make(map[component.Type]string, len(factories.Processors)) - {{- range .Processors}} - factories.ProcessorModules[{{.Name}}.NewFactory().Type()] = "{{.GoMod}}" - {{- end}} + factories.ProcessorModules = makeModulesMap(factories.Processors, map[component.Type]string{ + {{- range .Processors}} + {{.Name}}.NewFactory().Type(): "{{.GoMod}}", + {{- end}} + }) factories.Connectors, err = otelcol.MakeFactoryMap[connector.Factory]( {{- range .Connectors}} @@ -94,10 +112,11 @@ func components() (otelcol.Factories, error) { if err != nil { return otelcol.Factories{}, err } - factories.ConnectorModules = make(map[component.Type]string, len(factories.Connectors)) - {{- range .Connectors}} - factories.ConnectorModules[{{.Name}}.NewFactory().Type()] = "{{.GoMod}}" - {{- end}} + factories.ConnectorModules = makeModulesMap(factories.Connectors, map[component.Type]string{ + {{- range .Connectors}} + {{.Name}}.NewFactory().Type(): "{{.GoMod}}", + {{- end}} + }) return factories, nil } diff --git a/cmd/mdatagen/go.mod b/cmd/mdatagen/go.mod index 9212fe938eac..8392dff8f749 100644 --- a/cmd/mdatagen/go.mod +++ b/cmd/mdatagen/go.mod @@ -61,6 +61,7 @@ require ( go.opentelemetry.io/collector/consumer/consumererror v0.143.0 // indirect go.opentelemetry.io/collector/consumer/xconsumer v0.143.0 // indirect go.opentelemetry.io/collector/featuregate v1.49.0 // indirect + go.opentelemetry.io/collector/internal/componentalias v0.0.0-00010101000000-000000000000 // indirect go.opentelemetry.io/collector/internal/fanoutconsumer v0.143.0 // indirect go.opentelemetry.io/collector/pdata/pprofile v0.143.0 // indirect go.opentelemetry.io/collector/pdata/testdata v0.143.0 // indirect @@ -200,3 +201,5 @@ replace go.opentelemetry.io/collector/exporter/exporterhelper => ../../exporter/ replace go.opentelemetry.io/collector/service/telemetry/telemetrytest => ../../service/telemetry/telemetrytest replace go.opentelemetry.io/collector/internal/testutil => ../../internal/testutil + +replace go.opentelemetry.io/collector/internal/componentalias => ../../internal/componentalias diff --git a/cmd/otelcorecol/builder-config.yaml b/cmd/otelcorecol/builder-config.yaml index 9758367403e7..bd6b4b47f1c3 100644 --- a/cmd/otelcorecol/builder-config.yaml +++ b/cmd/otelcorecol/builder-config.yaml @@ -89,6 +89,7 @@ replaces: - go.opentelemetry.io/collector/extension/xextension => ../../extension/xextension - go.opentelemetry.io/collector/extension/zpagesextension => ../../extension/zpagesextension - go.opentelemetry.io/collector/featuregate => ../../featuregate + - go.opentelemetry.io/collector/internal/componentalias => ../../internal/componentalias - go.opentelemetry.io/collector/internal/memorylimiter => ../../internal/memorylimiter - go.opentelemetry.io/collector/internal/fanoutconsumer => ../../internal/fanoutconsumer - go.opentelemetry.io/collector/internal/telemetry => ../../internal/telemetry diff --git a/cmd/otelcorecol/components.go b/cmd/otelcorecol/components.go index c75a63362a35..de39856751a7 100644 --- a/cmd/otelcorecol/components.go +++ b/cmd/otelcorecol/components.go @@ -24,6 +24,20 @@ import ( "go.opentelemetry.io/collector/service/telemetry/otelconftelemetry" ) +type aliasProvider interface{ DeprecatedAlias() component.Type } + +func makeModulesMap[T component.Factory](factories map[component.Type]T, modules map[component.Type]string) map[component.Type]string { + for compType, factory := range factories { + if ap, ok := any(factory).(aliasProvider); ok { + alias := ap.DeprecatedAlias() + if alias.String() != "" { + modules[alias] = modules[compType] + } + } + } + return modules +} + func components() (otelcol.Factories, error) { var err error factories := otelcol.Factories{ @@ -37,9 +51,10 @@ func components() (otelcol.Factories, error) { if err != nil { return otelcol.Factories{}, err } - factories.ExtensionModules = make(map[component.Type]string, len(factories.Extensions)) - factories.ExtensionModules[memorylimiterextension.NewFactory().Type()] = "go.opentelemetry.io/collector/extension/memorylimiterextension v0.143.0" - factories.ExtensionModules[zpagesextension.NewFactory().Type()] = "go.opentelemetry.io/collector/extension/zpagesextension v0.143.0" + factories.ExtensionModules = makeModulesMap(factories.Extensions, map[component.Type]string{ + memorylimiterextension.NewFactory().Type(): "go.opentelemetry.io/collector/extension/memorylimiterextension v0.143.0", + zpagesextension.NewFactory().Type(): "go.opentelemetry.io/collector/extension/zpagesextension v0.143.0", + }) factories.Receivers, err = otelcol.MakeFactoryMap[receiver.Factory]( nopreceiver.NewFactory(), @@ -48,9 +63,10 @@ func components() (otelcol.Factories, error) { if err != nil { return otelcol.Factories{}, err } - factories.ReceiverModules = make(map[component.Type]string, len(factories.Receivers)) - factories.ReceiverModules[nopreceiver.NewFactory().Type()] = "go.opentelemetry.io/collector/receiver/nopreceiver v0.143.0" - factories.ReceiverModules[otlpreceiver.NewFactory().Type()] = "go.opentelemetry.io/collector/receiver/otlpreceiver v0.143.0" + factories.ReceiverModules = makeModulesMap(factories.Receivers, map[component.Type]string{ + nopreceiver.NewFactory().Type(): "go.opentelemetry.io/collector/receiver/nopreceiver v0.143.0", + otlpreceiver.NewFactory().Type(): "go.opentelemetry.io/collector/receiver/otlpreceiver v0.143.0", + }) factories.Exporters, err = otelcol.MakeFactoryMap[exporter.Factory]( debugexporter.NewFactory(), @@ -61,11 +77,12 @@ func components() (otelcol.Factories, error) { if err != nil { return otelcol.Factories{}, err } - factories.ExporterModules = make(map[component.Type]string, len(factories.Exporters)) - factories.ExporterModules[debugexporter.NewFactory().Type()] = "go.opentelemetry.io/collector/exporter/debugexporter v0.143.0" - factories.ExporterModules[nopexporter.NewFactory().Type()] = "go.opentelemetry.io/collector/exporter/nopexporter v0.143.0" - factories.ExporterModules[otlpexporter.NewFactory().Type()] = "go.opentelemetry.io/collector/exporter/otlpexporter v0.143.0" - factories.ExporterModules[otlphttpexporter.NewFactory().Type()] = "go.opentelemetry.io/collector/exporter/otlphttpexporter v0.143.0" + factories.ExporterModules = makeModulesMap(factories.Exporters, map[component.Type]string{ + debugexporter.NewFactory().Type(): "go.opentelemetry.io/collector/exporter/debugexporter v0.143.0", + nopexporter.NewFactory().Type(): "go.opentelemetry.io/collector/exporter/nopexporter v0.143.0", + otlpexporter.NewFactory().Type(): "go.opentelemetry.io/collector/exporter/otlpexporter v0.143.0", + otlphttpexporter.NewFactory().Type(): "go.opentelemetry.io/collector/exporter/otlphttpexporter v0.143.0", + }) factories.Processors, err = otelcol.MakeFactoryMap[processor.Factory]( batchprocessor.NewFactory(), @@ -74,9 +91,10 @@ func components() (otelcol.Factories, error) { if err != nil { return otelcol.Factories{}, err } - factories.ProcessorModules = make(map[component.Type]string, len(factories.Processors)) - factories.ProcessorModules[batchprocessor.NewFactory().Type()] = "go.opentelemetry.io/collector/processor/batchprocessor v0.143.0" - factories.ProcessorModules[memorylimiterprocessor.NewFactory().Type()] = "go.opentelemetry.io/collector/processor/memorylimiterprocessor v0.143.0" + factories.ProcessorModules = makeModulesMap(factories.Processors, map[component.Type]string{ + batchprocessor.NewFactory().Type(): "go.opentelemetry.io/collector/processor/batchprocessor v0.143.0", + memorylimiterprocessor.NewFactory().Type(): "go.opentelemetry.io/collector/processor/memorylimiterprocessor v0.143.0", + }) factories.Connectors, err = otelcol.MakeFactoryMap[connector.Factory]( forwardconnector.NewFactory(), @@ -84,8 +102,9 @@ func components() (otelcol.Factories, error) { if err != nil { return otelcol.Factories{}, err } - factories.ConnectorModules = make(map[component.Type]string, len(factories.Connectors)) - factories.ConnectorModules[forwardconnector.NewFactory().Type()] = "go.opentelemetry.io/collector/connector/forwardconnector v0.143.0" + factories.ConnectorModules = makeModulesMap(factories.Connectors, map[component.Type]string{ + forwardconnector.NewFactory().Type(): "go.opentelemetry.io/collector/connector/forwardconnector v0.143.0", + }) return factories, nil } diff --git a/cmd/otelcorecol/go.mod b/cmd/otelcorecol/go.mod index d24e0a8e0a81..2341e79a9dfe 100644 --- a/cmd/otelcorecol/go.mod +++ b/cmd/otelcorecol/go.mod @@ -116,6 +116,7 @@ require ( go.opentelemetry.io/collector/extension/extensiontest v0.143.0 // indirect go.opentelemetry.io/collector/extension/xextension v0.143.0 // indirect go.opentelemetry.io/collector/featuregate v1.49.0 // indirect + go.opentelemetry.io/collector/internal/componentalias v0.0.0-00010101000000-000000000000 // indirect go.opentelemetry.io/collector/internal/fanoutconsumer v0.143.0 // indirect go.opentelemetry.io/collector/internal/memorylimiter v0.143.0 // indirect go.opentelemetry.io/collector/internal/sharedcomponent v0.143.0 // indirect @@ -279,6 +280,8 @@ replace go.opentelemetry.io/collector/extension/zpagesextension => ../../extensi replace go.opentelemetry.io/collector/featuregate => ../../featuregate +replace go.opentelemetry.io/collector/internal/componentalias => ../../internal/componentalias + replace go.opentelemetry.io/collector/internal/memorylimiter => ../../internal/memorylimiter replace go.opentelemetry.io/collector/internal/fanoutconsumer => ../../internal/fanoutconsumer diff --git a/connector/connector.go b/connector/connector.go index e7c11d95bd51..4689519644f7 100644 --- a/connector/connector.go +++ b/connector/connector.go @@ -9,6 +9,7 @@ import ( "go.opentelemetry.io/collector/component" "go.opentelemetry.io/collector/connector/internal" "go.opentelemetry.io/collector/consumer" + "go.opentelemetry.io/collector/internal/componentalias" "go.opentelemetry.io/collector/pipeline" ) @@ -234,6 +235,7 @@ func WithLogsToLogs(createLogsToLogs CreateLogsToLogsFunc, sl component.Stabilit type factory struct { cfgType component.Type component.CreateDefaultConfigFunc + componentalias.TypeAliasHolder createTracesToTracesFunc CreateTracesToTracesFunc createTracesToMetricsFunc CreateTracesToMetricsFunc @@ -308,8 +310,8 @@ func (f *factory) CreateTracesToTraces(ctx context.Context, set Settings, cfg co return nil, internal.ErrDataTypes(set.ID, pipeline.SignalTraces, pipeline.SignalTraces) } - if set.ID.Type() != f.Type() { - return nil, internal.ErrIDMismatch(set.ID, f.Type()) + if err := componentalias.ValidateComponentType(f, set.ID); err != nil { + return nil, err } return f.createTracesToTracesFunc(ctx, set, cfg, next) @@ -320,8 +322,8 @@ func (f *factory) CreateTracesToMetrics(ctx context.Context, set Settings, cfg c return nil, internal.ErrDataTypes(set.ID, pipeline.SignalTraces, pipeline.SignalMetrics) } - if set.ID.Type() != f.Type() { - return nil, internal.ErrIDMismatch(set.ID, f.Type()) + if err := componentalias.ValidateComponentType(f, set.ID); err != nil { + return nil, err } return f.createTracesToMetricsFunc(ctx, set, cfg, next) @@ -332,8 +334,8 @@ func (f *factory) CreateTracesToLogs(ctx context.Context, set Settings, cfg comp return nil, internal.ErrDataTypes(set.ID, pipeline.SignalTraces, pipeline.SignalLogs) } - if set.ID.Type() != f.Type() { - return nil, internal.ErrIDMismatch(set.ID, f.Type()) + if err := componentalias.ValidateComponentType(f, set.ID); err != nil { + return nil, err } return f.createTracesToLogsFunc(ctx, set, cfg, next) @@ -344,8 +346,8 @@ func (f *factory) CreateMetricsToTraces(ctx context.Context, set Settings, cfg c return nil, internal.ErrDataTypes(set.ID, pipeline.SignalMetrics, pipeline.SignalTraces) } - if set.ID.Type() != f.Type() { - return nil, internal.ErrIDMismatch(set.ID, f.Type()) + if err := componentalias.ValidateComponentType(f, set.ID); err != nil { + return nil, err } return f.createMetricsToTracesFunc(ctx, set, cfg, next) @@ -356,8 +358,8 @@ func (f *factory) CreateMetricsToMetrics(ctx context.Context, set Settings, cfg return nil, internal.ErrDataTypes(set.ID, pipeline.SignalMetrics, pipeline.SignalMetrics) } - if set.ID.Type() != f.Type() { - return nil, internal.ErrIDMismatch(set.ID, f.Type()) + if err := componentalias.ValidateComponentType(f, set.ID); err != nil { + return nil, err } return f.createMetricsToMetricsFunc(ctx, set, cfg, next) @@ -368,8 +370,8 @@ func (f *factory) CreateMetricsToLogs(ctx context.Context, set Settings, cfg com return nil, internal.ErrDataTypes(set.ID, pipeline.SignalMetrics, pipeline.SignalLogs) } - if set.ID.Type() != f.Type() { - return nil, internal.ErrIDMismatch(set.ID, f.Type()) + if err := componentalias.ValidateComponentType(f, set.ID); err != nil { + return nil, err } return f.createMetricsToLogsFunc(ctx, set, cfg, next) @@ -380,8 +382,8 @@ func (f *factory) CreateLogsToTraces(ctx context.Context, set Settings, cfg comp return nil, internal.ErrDataTypes(set.ID, pipeline.SignalLogs, pipeline.SignalTraces) } - if set.ID.Type() != f.Type() { - return nil, internal.ErrIDMismatch(set.ID, f.Type()) + if err := componentalias.ValidateComponentType(f, set.ID); err != nil { + return nil, err } return f.createLogsToTracesFunc(ctx, set, cfg, next) @@ -392,8 +394,8 @@ func (f *factory) CreateLogsToMetrics(ctx context.Context, set Settings, cfg com return nil, internal.ErrDataTypes(set.ID, pipeline.SignalLogs, pipeline.SignalMetrics) } - if set.ID.Type() != f.Type() { - return nil, internal.ErrIDMismatch(set.ID, f.Type()) + if err := componentalias.ValidateComponentType(f, set.ID); err != nil { + return nil, err } return f.createLogsToMetricsFunc(ctx, set, cfg, next) @@ -404,8 +406,8 @@ func (f *factory) CreateLogsToLogs(ctx context.Context, set Settings, cfg compon return nil, internal.ErrDataTypes(set.ID, pipeline.SignalLogs, pipeline.SignalLogs) } - if set.ID.Type() != f.Type() { - return nil, internal.ErrIDMismatch(set.ID, f.Type()) + if err := componentalias.ValidateComponentType(f, set.ID); err != nil { + return nil, err } return f.createLogsToLogsFunc(ctx, set, cfg, next) @@ -416,6 +418,7 @@ func NewFactory(cfgType component.Type, createDefaultConfig component.CreateDefa f := &factory{ cfgType: cfgType, CreateDefaultConfigFunc: createDefaultConfig, + TypeAliasHolder: componentalias.NewTypeAliasHolder(), } for _, opt := range options { opt.apply(f) diff --git a/connector/connectortest/go.mod b/connector/connectortest/go.mod index 874f3405ad14..78d966db9059 100644 --- a/connector/connectortest/go.mod +++ b/connector/connectortest/go.mod @@ -29,6 +29,7 @@ require ( github.com/pmezard/go-difflib v1.0.0 // indirect go.opentelemetry.io/auto/sdk v1.2.1 // indirect go.opentelemetry.io/collector/featuregate v1.49.0 // indirect + go.opentelemetry.io/collector/internal/componentalias v0.0.0-00010101000000-000000000000 // indirect go.opentelemetry.io/collector/internal/fanoutconsumer v0.143.0 // indirect go.opentelemetry.io/collector/pipeline v1.49.0 // indirect go.opentelemetry.io/collector/pipeline/xpipeline v0.143.0 // indirect @@ -72,3 +73,5 @@ replace go.opentelemetry.io/collector/internal/fanoutconsumer => ../../internal/ replace go.opentelemetry.io/collector/featuregate => ../../featuregate replace go.opentelemetry.io/collector/internal/testutil => ../../internal/testutil + +replace go.opentelemetry.io/collector/internal/componentalias => ../../internal/componentalias diff --git a/connector/forwardconnector/go.mod b/connector/forwardconnector/go.mod index bf7a9e5bda03..33c18347bf07 100644 --- a/connector/forwardconnector/go.mod +++ b/connector/forwardconnector/go.mod @@ -39,6 +39,7 @@ require ( github.com/pmezard/go-difflib v1.0.0 // indirect go.opentelemetry.io/auto/sdk v1.2.1 // indirect go.opentelemetry.io/collector/featuregate v1.49.0 // indirect + go.opentelemetry.io/collector/internal/componentalias v0.0.0-00010101000000-000000000000 // indirect go.opentelemetry.io/collector/internal/fanoutconsumer v0.143.0 // indirect go.opentelemetry.io/collector/pipeline/xpipeline v0.143.0 // indirect go.opentelemetry.io/otel v1.39.0 // indirect @@ -91,3 +92,5 @@ replace go.opentelemetry.io/collector/internal/fanoutconsumer => ../../internal/ replace go.opentelemetry.io/collector/featuregate => ../../featuregate replace go.opentelemetry.io/collector/internal/testutil => ../../internal/testutil + +replace go.opentelemetry.io/collector/internal/componentalias => ../../internal/componentalias diff --git a/connector/go.mod b/connector/go.mod index ce498c4823e6..4c62bc31ce08 100644 --- a/connector/go.mod +++ b/connector/go.mod @@ -7,6 +7,7 @@ require ( go.opentelemetry.io/collector/component v1.49.0 go.opentelemetry.io/collector/consumer v1.49.0 go.opentelemetry.io/collector/consumer/consumertest v0.143.0 + go.opentelemetry.io/collector/internal/componentalias v0.0.0-00010101000000-000000000000 go.opentelemetry.io/collector/internal/fanoutconsumer v0.143.0 go.opentelemetry.io/collector/pdata v1.49.0 go.opentelemetry.io/collector/pdata/testdata v0.143.0 @@ -49,6 +50,8 @@ replace go.opentelemetry.io/collector/consumer/consumertest => ../consumer/consu replace go.opentelemetry.io/collector/pipeline => ../pipeline +replace go.opentelemetry.io/collector/internal/componentalias => ../internal/componentalias + replace go.opentelemetry.io/collector/internal/fanoutconsumer => ../internal/fanoutconsumer replace go.opentelemetry.io/collector/featuregate => ../featuregate diff --git a/connector/xconnector/connector.go b/connector/xconnector/connector.go index fbf7f3abe0f4..69b62a6d7e65 100644 --- a/connector/xconnector/connector.go +++ b/connector/xconnector/connector.go @@ -11,6 +11,7 @@ import ( "go.opentelemetry.io/collector/connector/internal" "go.opentelemetry.io/collector/consumer" "go.opentelemetry.io/collector/consumer/xconsumer" + "go.opentelemetry.io/collector/internal/componentalias" "go.opentelemetry.io/collector/pipeline" "go.opentelemetry.io/collector/pipeline/xpipeline" ) @@ -92,6 +93,7 @@ type factoryOpts struct { opts []connector.FactoryOption *factory + deprecatedAlias component.Type } // WithTracesToTraces overrides the default "error not supported" implementation for WithTracesToTraces and the default "undefined" stability level. @@ -213,9 +215,18 @@ func WithProfilesToLogs(createProfilesToLogs CreateProfilesToLogsFunc, sl compon }) } +// WithDeprecatedTypeAlias configures a deprecated type alias for the connector. Only one alias is supported per connector. +// When the alias is used in configuration, a deprecation warning is automatically logged. +func WithDeprecatedTypeAlias(alias component.Type) FactoryOption { + return factoryOptionFunc(func(o *factoryOpts) { + o.deprecatedAlias = alias + }) +} + // factory implements the Factory interface. type factory struct { connector.Factory + componentalias.TypeAliasHolder createTracesToProfilesFunc CreateTracesToProfilesFunc createMetricsToProfilesFunc CreateMetricsToProfilesFunc @@ -268,8 +279,8 @@ func (f *factory) CreateTracesToProfiles(ctx context.Context, set connector.Sett if f.createTracesToProfilesFunc == nil { return nil, internal.ErrDataTypes(set.ID, pipeline.SignalTraces, xpipeline.SignalProfiles) } - if set.ID.Type() != f.Type() { - return nil, internal.ErrIDMismatch(set.ID, f.Type()) + if err := componentalias.ValidateComponentType(f.Factory, set.ID); err != nil { + return nil, err } return f.createTracesToProfilesFunc(ctx, set, cfg, next) } @@ -278,8 +289,8 @@ func (f *factory) CreateMetricsToProfiles(ctx context.Context, set connector.Set if f.createMetricsToProfilesFunc == nil { return nil, internal.ErrDataTypes(set.ID, pipeline.SignalMetrics, xpipeline.SignalProfiles) } - if set.ID.Type() != f.Type() { - return nil, internal.ErrIDMismatch(set.ID, f.Type()) + if err := componentalias.ValidateComponentType(f.Factory, set.ID); err != nil { + return nil, err } return f.createMetricsToProfilesFunc(ctx, set, cfg, next) } @@ -288,8 +299,8 @@ func (f *factory) CreateLogsToProfiles(ctx context.Context, set connector.Settin if f.createLogsToProfilesFunc == nil { return nil, internal.ErrDataTypes(set.ID, pipeline.SignalLogs, xpipeline.SignalProfiles) } - if set.ID.Type() != f.Type() { - return nil, internal.ErrIDMismatch(set.ID, f.Type()) + if err := componentalias.ValidateComponentType(f.Factory, set.ID); err != nil { + return nil, err } return f.createLogsToProfilesFunc(ctx, set, cfg, next) } @@ -298,8 +309,8 @@ func (f *factory) CreateProfilesToProfiles(ctx context.Context, set connector.Se if f.createProfilesToProfilesFunc == nil { return nil, internal.ErrDataTypes(set.ID, xpipeline.SignalProfiles, xpipeline.SignalProfiles) } - if set.ID.Type() != f.Type() { - return nil, internal.ErrIDMismatch(set.ID, f.Type()) + if err := componentalias.ValidateComponentType(f.Factory, set.ID); err != nil { + return nil, err } return f.createProfilesToProfilesFunc(ctx, set, cfg, next) } @@ -308,8 +319,8 @@ func (f *factory) CreateProfilesToTraces(ctx context.Context, set connector.Sett if f.createProfilesToTracesFunc == nil { return nil, internal.ErrDataTypes(set.ID, xpipeline.SignalProfiles, pipeline.SignalTraces) } - if set.ID.Type() != f.Type() { - return nil, internal.ErrIDMismatch(set.ID, f.Type()) + if err := componentalias.ValidateComponentType(f.Factory, set.ID); err != nil { + return nil, err } return f.createProfilesToTracesFunc(ctx, set, cfg, next) } @@ -318,8 +329,8 @@ func (f *factory) CreateProfilesToMetrics(ctx context.Context, set connector.Set if f.createProfilesToMetricsFunc == nil { return nil, internal.ErrDataTypes(set.ID, xpipeline.SignalProfiles, pipeline.SignalMetrics) } - if set.ID.Type() != f.Type() { - return nil, internal.ErrIDMismatch(set.ID, f.Type()) + if err := componentalias.ValidateComponentType(f.Factory, set.ID); err != nil { + return nil, err } return f.createProfilesToMetricsFunc(ctx, set, cfg, next) } @@ -328,18 +339,21 @@ func (f *factory) CreateProfilesToLogs(ctx context.Context, set connector.Settin if f.createProfilesToLogsFunc == nil { return nil, internal.ErrDataTypes(set.ID, xpipeline.SignalProfiles, pipeline.SignalLogs) } - if set.ID.Type() != f.Type() { - return nil, internal.ErrIDMismatch(set.ID, f.Type()) + if err := componentalias.ValidateComponentType(f.Factory, set.ID); err != nil { + return nil, err } return f.createProfilesToLogsFunc(ctx, set, cfg, next) } // NewFactory returns a Factory. func NewFactory(cfgType component.Type, createDefaultConfig component.CreateDefaultConfigFunc, options ...FactoryOption) Factory { - opts := factoryOpts{factory: &factory{}} + f := &factory{TypeAliasHolder: componentalias.NewTypeAliasHolder()} + opts := factoryOpts{factory: f} for _, opt := range options { opt.applyOption(&opts) } opts.Factory = connector.NewFactory(cfgType, createDefaultConfig, opts.opts...) + opts.Factory.(componentalias.TypeAliasHolder).SetDeprecatedAlias(opts.deprecatedAlias) + f.SetDeprecatedAlias(opts.deprecatedAlias) return opts.factory } diff --git a/connector/xconnector/connector_test.go b/connector/xconnector/connector_test.go index 14fc5a4294b1..32de0b5c6a5f 100644 --- a/connector/xconnector/connector_test.go +++ b/connector/xconnector/connector_test.go @@ -16,6 +16,7 @@ import ( "go.opentelemetry.io/collector/consumer" "go.opentelemetry.io/collector/consumer/consumertest" "go.opentelemetry.io/collector/consumer/xconsumer" + "go.opentelemetry.io/collector/internal/componentalias" "go.opentelemetry.io/collector/pipeline" "go.opentelemetry.io/collector/pipeline/xpipeline" ) @@ -164,3 +165,27 @@ func createProfilesToMetrics(context.Context, connector.Settings, component.Conf func createProfilesToLogs(context.Context, connector.Settings, component.Config, consumer.Logs) (Profiles, error) { return nopInstance, nil } + +func TestNewFactoryWithDeprecatedAlias(t *testing.T) { + testType := component.MustNewType("newname") + aliasType := component.MustNewType("oldname") + defaultCfg := struct{}{} + + f := NewFactory( + testType, + func() component.Config { return &defaultCfg }, + WithProfilesToProfiles(createProfilesToProfiles, component.StabilityLevelAlpha), + WithDeprecatedTypeAlias(aliasType), + ) + + assert.Equal(t, testType, f.Type()) + assert.Equal(t, aliasType, f.(*factory).Factory.(componentalias.TypeAliasHolder).DeprecatedAlias()) + assert.EqualValues(t, &defaultCfg, f.CreateDefaultConfig()) + + _, err := f.CreateProfilesToProfiles(context.Background(), connector.Settings{ID: component.MustNewID("newname")}, &defaultCfg, consumertest.NewNop()) + require.NoError(t, err) + _, err = f.CreateProfilesToProfiles(context.Background(), connector.Settings{ID: component.MustNewID("oldname")}, &defaultCfg, consumertest.NewNop()) + require.NoError(t, err) + _, err = f.CreateProfilesToProfiles(context.Background(), connector.Settings{ID: component.MustNewID("wrongname")}, &defaultCfg, consumertest.NewNop()) + require.Error(t, err) +} diff --git a/connector/xconnector/go.mod b/connector/xconnector/go.mod index 2b32ec6ee294..3d93f53c2761 100644 --- a/connector/xconnector/go.mod +++ b/connector/xconnector/go.mod @@ -9,6 +9,7 @@ require ( go.opentelemetry.io/collector/consumer v1.49.0 go.opentelemetry.io/collector/consumer/consumertest v0.143.0 go.opentelemetry.io/collector/consumer/xconsumer v0.143.0 + go.opentelemetry.io/collector/internal/componentalias v0.0.0-00010101000000-000000000000 go.opentelemetry.io/collector/internal/fanoutconsumer v0.143.0 go.opentelemetry.io/collector/pdata/pprofile v0.143.0 go.opentelemetry.io/collector/pdata/testdata v0.143.0 @@ -59,3 +60,5 @@ replace go.opentelemetry.io/collector/internal/fanoutconsumer => ../../internal/ replace go.opentelemetry.io/collector/featuregate => ../../featuregate replace go.opentelemetry.io/collector/internal/testutil => ../../internal/testutil + +replace go.opentelemetry.io/collector/internal/componentalias => ../../internal/componentalias diff --git a/exporter/debugexporter/go.mod b/exporter/debugexporter/go.mod index 40ca642f3922..a975b4ba8aa3 100644 --- a/exporter/debugexporter/go.mod +++ b/exporter/debugexporter/go.mod @@ -54,6 +54,7 @@ require ( go.opentelemetry.io/collector/extension v1.49.0 // indirect go.opentelemetry.io/collector/extension/xextension v0.143.0 // indirect go.opentelemetry.io/collector/featuregate v1.49.0 // indirect + go.opentelemetry.io/collector/internal/componentalias v0.0.0-00010101000000-000000000000 // indirect go.opentelemetry.io/collector/pipeline v1.49.0 // indirect go.opentelemetry.io/collector/pipeline/xpipeline v0.143.0 // indirect go.opentelemetry.io/collector/receiver v1.49.0 // indirect @@ -135,3 +136,5 @@ replace go.opentelemetry.io/collector/confmap/xconfmap => ../../confmap/xconfmap replace go.opentelemetry.io/collector/exporter/exporterhelper => ../exporterhelper replace go.opentelemetry.io/collector/internal/testutil => ../../internal/testutil + +replace go.opentelemetry.io/collector/internal/componentalias => ../../internal/componentalias diff --git a/exporter/exporter.go b/exporter/exporter.go index 2df5ab6853bc..7bb908c8200d 100644 --- a/exporter/exporter.go +++ b/exporter/exporter.go @@ -8,7 +8,7 @@ import ( "go.opentelemetry.io/collector/component" "go.opentelemetry.io/collector/consumer" - "go.opentelemetry.io/collector/exporter/internal/experr" + "go.opentelemetry.io/collector/internal/componentalias" "go.opentelemetry.io/collector/pipeline" ) @@ -105,6 +105,7 @@ type CreateLogsFunc func(context.Context, Settings, component.Config) (Logs, err type factory struct { cfgType component.Type component.CreateDefaultConfigFunc + componentalias.TypeAliasHolder createTracesFunc CreateTracesFunc tracesStabilityLevel component.StabilityLevel createMetricsFunc CreateMetricsFunc @@ -136,8 +137,8 @@ func (f *factory) CreateTraces(ctx context.Context, set Settings, cfg component. return nil, pipeline.ErrSignalNotSupported } - if set.ID.Type() != f.Type() { - return nil, experr.ErrIDMismatch(set.ID, f.Type()) + if err := componentalias.ValidateComponentType(f, set.ID); err != nil { + return nil, err } return f.createTracesFunc(ctx, set, cfg) @@ -148,8 +149,8 @@ func (f *factory) CreateMetrics(ctx context.Context, set Settings, cfg component return nil, pipeline.ErrSignalNotSupported } - if set.ID.Type() != f.Type() { - return nil, experr.ErrIDMismatch(set.ID, f.Type()) + if err := componentalias.ValidateComponentType(f, set.ID); err != nil { + return nil, err } return f.createMetricsFunc(ctx, set, cfg) @@ -160,8 +161,8 @@ func (f *factory) CreateLogs(ctx context.Context, set Settings, cfg component.Co return nil, pipeline.ErrSignalNotSupported } - if set.ID.Type() != f.Type() { - return nil, experr.ErrIDMismatch(set.ID, f.Type()) + if err := componentalias.ValidateComponentType(f, set.ID); err != nil { + return nil, err } return f.createLogsFunc(ctx, set, cfg) @@ -196,6 +197,7 @@ func NewFactory(cfgType component.Type, createDefaultConfig component.CreateDefa f := &factory{ cfgType: cfgType, CreateDefaultConfigFunc: createDefaultConfig, + TypeAliasHolder: componentalias.NewTypeAliasHolder(), } for _, opt := range options { opt.applyOption(f) diff --git a/exporter/exporterhelper/go.mod b/exporter/exporterhelper/go.mod index 298f45ec5758..e18d59ce965b 100644 --- a/exporter/exporterhelper/go.mod +++ b/exporter/exporterhelper/go.mod @@ -59,6 +59,7 @@ require ( go.opentelemetry.io/collector/consumer/xconsumer v0.143.0 // indirect go.opentelemetry.io/collector/exporter/xexporter v0.143.0 // indirect go.opentelemetry.io/collector/extension v1.49.0 // indirect + go.opentelemetry.io/collector/internal/componentalias v0.0.0-00010101000000-000000000000 // indirect go.opentelemetry.io/collector/receiver v1.49.0 // indirect go.opentelemetry.io/collector/receiver/receivertest v0.143.0 // indirect go.opentelemetry.io/collector/receiver/xreceiver v0.143.0 // indirect @@ -122,3 +123,5 @@ replace go.opentelemetry.io/collector/config/configoptional => ../../config/conf replace go.opentelemetry.io/collector/confmap/xconfmap => ../../confmap/xconfmap replace go.opentelemetry.io/collector/internal/testutil => ../../internal/testutil + +replace go.opentelemetry.io/collector/internal/componentalias => ../../internal/componentalias diff --git a/exporter/exporterhelper/xexporterhelper/go.mod b/exporter/exporterhelper/xexporterhelper/go.mod index 1bd964a2af9f..6186e7e69dc1 100644 --- a/exporter/exporterhelper/xexporterhelper/go.mod +++ b/exporter/exporterhelper/xexporterhelper/go.mod @@ -54,6 +54,7 @@ require ( go.opentelemetry.io/collector/extension v1.49.0 // indirect go.opentelemetry.io/collector/extension/xextension v0.143.0 // indirect go.opentelemetry.io/collector/featuregate v1.49.0 // indirect + go.opentelemetry.io/collector/internal/componentalias v0.0.0-00010101000000-000000000000 // indirect go.opentelemetry.io/collector/pipeline v1.49.0 // indirect go.opentelemetry.io/collector/receiver v1.49.0 // indirect go.opentelemetry.io/collector/receiver/receivertest v0.143.0 // indirect @@ -128,3 +129,5 @@ replace go.opentelemetry.io/collector/confmap/xconfmap => ../../../confmap/xconf replace go.opentelemetry.io/collector/exporter/exporterhelper => ../ replace go.opentelemetry.io/collector/internal/testutil => ../../../internal/testutil + +replace go.opentelemetry.io/collector/internal/componentalias => ../../../internal/componentalias diff --git a/exporter/exportertest/go.mod b/exporter/exportertest/go.mod index fc9bc000012e..13a78e09891e 100644 --- a/exporter/exportertest/go.mod +++ b/exporter/exportertest/go.mod @@ -49,6 +49,7 @@ require ( go.opentelemetry.io/collector/extension v1.49.0 // indirect go.opentelemetry.io/collector/extension/xextension v0.143.0 // indirect go.opentelemetry.io/collector/featuregate v1.49.0 // indirect + go.opentelemetry.io/collector/internal/componentalias v0.0.0-00010101000000-000000000000 // indirect go.opentelemetry.io/collector/pdata/xpdata v0.143.0 // indirect go.opentelemetry.io/collector/receiver/xreceiver v0.143.0 // indirect go.opentelemetry.io/otel v1.39.0 // indirect @@ -118,3 +119,5 @@ replace go.opentelemetry.io/collector/confmap/xconfmap => ../../confmap/xconfmap replace go.opentelemetry.io/collector/exporter/exporterhelper => ../exporterhelper replace go.opentelemetry.io/collector/internal/testutil => ../../internal/testutil + +replace go.opentelemetry.io/collector/internal/componentalias => ../../internal/componentalias diff --git a/exporter/go.mod b/exporter/go.mod index cb9fcc38cc78..d47414e170a4 100644 --- a/exporter/go.mod +++ b/exporter/go.mod @@ -10,6 +10,7 @@ require ( go.opentelemetry.io/collector/consumer v1.49.0 go.opentelemetry.io/collector/consumer/consumertest v0.143.0 go.opentelemetry.io/collector/exporter/exporterhelper v0.143.0 + go.opentelemetry.io/collector/internal/componentalias v0.0.0-00010101000000-000000000000 go.opentelemetry.io/collector/pdata v1.49.0 go.opentelemetry.io/collector/pipeline v1.49.0 go.uber.org/goleak v1.3.0 @@ -109,3 +110,5 @@ replace go.opentelemetry.io/collector/confmap/xconfmap => ../confmap/xconfmap replace go.opentelemetry.io/collector/exporter/exporterhelper => ./exporterhelper replace go.opentelemetry.io/collector/internal/testutil => ../internal/testutil + +replace go.opentelemetry.io/collector/internal/componentalias => ../internal/componentalias diff --git a/exporter/nopexporter/go.mod b/exporter/nopexporter/go.mod index 67ee0a3362d3..662861f9cb96 100644 --- a/exporter/nopexporter/go.mod +++ b/exporter/nopexporter/go.mod @@ -39,6 +39,7 @@ require ( go.opentelemetry.io/collector/consumer/consumererror v0.143.0 // indirect go.opentelemetry.io/collector/consumer/xconsumer v0.143.0 // indirect go.opentelemetry.io/collector/featuregate v1.49.0 // indirect + go.opentelemetry.io/collector/internal/componentalias v0.0.0-00010101000000-000000000000 // indirect go.opentelemetry.io/collector/pipeline v1.49.0 // indirect go.opentelemetry.io/collector/receiver v1.49.0 // indirect go.opentelemetry.io/collector/receiver/receivertest v0.143.0 // indirect @@ -113,3 +114,5 @@ replace go.opentelemetry.io/collector/confmap/xconfmap => ../../confmap/xconfmap replace go.opentelemetry.io/collector/exporter/exporterhelper => ../exporterhelper replace go.opentelemetry.io/collector/internal/testutil => ../../internal/testutil + +replace go.opentelemetry.io/collector/internal/componentalias => ../../internal/componentalias diff --git a/exporter/otlpexporter/go.mod b/exporter/otlpexporter/go.mod index 9769a8100165..8e3c907dde9f 100644 --- a/exporter/otlpexporter/go.mod +++ b/exporter/otlpexporter/go.mod @@ -71,6 +71,7 @@ require ( go.opentelemetry.io/collector/extension/extensionmiddleware v0.143.0 // indirect go.opentelemetry.io/collector/extension/xextension v0.143.0 // indirect go.opentelemetry.io/collector/featuregate v1.49.0 // indirect + go.opentelemetry.io/collector/internal/componentalias v0.0.0-00010101000000-000000000000 // indirect go.opentelemetry.io/collector/pdata/xpdata v0.143.0 // indirect go.opentelemetry.io/collector/pipeline v1.49.0 // indirect go.opentelemetry.io/collector/pipeline/xpipeline v0.143.0 // indirect @@ -182,3 +183,5 @@ replace go.opentelemetry.io/collector/config/configoptional => ../../config/conf replace go.opentelemetry.io/collector/exporter/exporterhelper => ../exporterhelper replace go.opentelemetry.io/collector/internal/testutil => ../../internal/testutil + +replace go.opentelemetry.io/collector/internal/componentalias => ../../internal/componentalias diff --git a/exporter/otlphttpexporter/go.mod b/exporter/otlphttpexporter/go.mod index c025184dcbea..d217be478051 100644 --- a/exporter/otlphttpexporter/go.mod +++ b/exporter/otlphttpexporter/go.mod @@ -71,6 +71,7 @@ require ( go.opentelemetry.io/collector/extension/extensionmiddleware v0.143.0 // indirect go.opentelemetry.io/collector/extension/xextension v0.143.0 // indirect go.opentelemetry.io/collector/featuregate v1.49.0 // indirect + go.opentelemetry.io/collector/internal/componentalias v0.0.0-00010101000000-000000000000 // indirect go.opentelemetry.io/collector/pdata/xpdata v0.143.0 // indirect go.opentelemetry.io/collector/pipeline v1.49.0 // indirect go.opentelemetry.io/collector/pipeline/xpipeline v0.143.0 // indirect @@ -180,3 +181,5 @@ replace go.opentelemetry.io/collector/pdata/xpdata => ../../pdata/xpdata replace go.opentelemetry.io/collector/exporter/exporterhelper => ../exporterhelper replace go.opentelemetry.io/collector/internal/testutil => ../../internal/testutil + +replace go.opentelemetry.io/collector/internal/componentalias => ../../internal/componentalias diff --git a/exporter/xexporter/exporter.go b/exporter/xexporter/exporter.go index dea6ed6084ea..28c8f61806ca 100644 --- a/exporter/xexporter/exporter.go +++ b/exporter/xexporter/exporter.go @@ -9,7 +9,7 @@ import ( "go.opentelemetry.io/collector/component" "go.opentelemetry.io/collector/consumer/xconsumer" "go.opentelemetry.io/collector/exporter" - "go.opentelemetry.io/collector/exporter/internal/experr" + "go.opentelemetry.io/collector/internal/componentalias" "go.opentelemetry.io/collector/pipeline" ) @@ -47,6 +47,7 @@ func (f factoryOptionFunc) applyOption(o *factoryOpts) { type factoryOpts struct { opts []exporter.FactoryOption *factory + deprecatedAlias component.Type } // CreateProfilesFunc is the equivalent of Factory.CreateProfiles. @@ -81,8 +82,17 @@ func WithProfiles(createProfiles CreateProfilesFunc, sl component.StabilityLevel }) } +// WithDeprecatedTypeAlias configures a deprecated type alias for the exporter. Only one alias is supported per exporter. +// When the alias is used in configuration, a deprecation warning is automatically logged. +func WithDeprecatedTypeAlias(alias component.Type) FactoryOption { + return factoryOptionFunc(func(o *factoryOpts) { + o.deprecatedAlias = alias + }) +} + type factory struct { exporter.Factory + componentalias.TypeAliasHolder createProfilesFunc CreateProfilesFunc profilesStabilityLevel component.StabilityLevel } @@ -95,19 +105,21 @@ func (f *factory) CreateProfiles(ctx context.Context, set exporter.Settings, cfg if f.createProfilesFunc == nil { return nil, pipeline.ErrSignalNotSupported } - - if set.ID.Type() != f.Type() { - return nil, experr.ErrIDMismatch(set.ID, f.Type()) + if err := componentalias.ValidateComponentType(f.Factory, set.ID); err != nil { + return nil, err } return f.createProfilesFunc(ctx, set, cfg) } // NewFactory returns a Factory. func NewFactory(cfgType component.Type, createDefaultConfig component.CreateDefaultConfigFunc, options ...FactoryOption) Factory { - opts := factoryOpts{factory: &factory{}} + f := &factory{TypeAliasHolder: componentalias.NewTypeAliasHolder()} + opts := factoryOpts{factory: f} for _, opt := range options { opt.applyOption(&opts) } opts.Factory = exporter.NewFactory(cfgType, createDefaultConfig, opts.opts...) + opts.Factory.(componentalias.TypeAliasHolder).SetDeprecatedAlias(opts.deprecatedAlias) + f.SetDeprecatedAlias(opts.deprecatedAlias) return opts.factory } diff --git a/exporter/xexporter/exporter_test.go b/exporter/xexporter/exporter_test.go index 3951bb75cb29..0d9b926d9e33 100644 --- a/exporter/xexporter/exporter_test.go +++ b/exporter/xexporter/exporter_test.go @@ -14,6 +14,7 @@ import ( "go.opentelemetry.io/collector/consumer/consumertest" "go.opentelemetry.io/collector/exporter" "go.opentelemetry.io/collector/exporter/internal/experr" + "go.opentelemetry.io/collector/internal/componentalias" ) var testID = component.MustNewID("test") @@ -53,3 +54,27 @@ type nop struct { func createProfiles(context.Context, exporter.Settings, component.Config) (Profiles, error) { return nopInstance, nil } + +func TestNewFactoryWithDeprecatedAlias(t *testing.T) { + testType := component.MustNewType("newname") + aliasType := component.MustNewType("oldname") + defaultCfg := struct{}{} + + f := NewFactory( + testType, + func() component.Config { return &defaultCfg }, + WithProfiles(createProfiles, component.StabilityLevelAlpha), + WithDeprecatedTypeAlias(aliasType), + ) + + assert.Equal(t, testType, f.Type()) + assert.Equal(t, aliasType, f.(*factory).Factory.(componentalias.TypeAliasHolder).DeprecatedAlias()) + assert.EqualValues(t, &defaultCfg, f.CreateDefaultConfig()) + + _, err := f.CreateProfiles(context.Background(), exporter.Settings{ID: component.MustNewID("newname")}, &defaultCfg) + require.NoError(t, err) + _, err = f.CreateProfiles(context.Background(), exporter.Settings{ID: component.MustNewID("oldname")}, &defaultCfg) + require.NoError(t, err) + _, err = f.CreateProfiles(context.Background(), exporter.Settings{ID: component.MustNewID("wrongname")}, &defaultCfg) + require.Error(t, err) +} diff --git a/exporter/xexporter/go.mod b/exporter/xexporter/go.mod index 7c5e1d7a91ff..2076a43be70d 100644 --- a/exporter/xexporter/go.mod +++ b/exporter/xexporter/go.mod @@ -8,6 +8,7 @@ require ( go.opentelemetry.io/collector/consumer/consumertest v0.143.0 go.opentelemetry.io/collector/consumer/xconsumer v0.143.0 go.opentelemetry.io/collector/exporter v1.49.0 + go.opentelemetry.io/collector/internal/componentalias v0.0.0-00010101000000-000000000000 go.opentelemetry.io/collector/pipeline v1.49.0 ) @@ -84,3 +85,5 @@ replace go.opentelemetry.io/collector/confmap/xconfmap => ../../confmap/xconfmap replace go.opentelemetry.io/collector/exporter/exporterhelper => ../exporterhelper replace go.opentelemetry.io/collector/internal/testutil => ../../internal/testutil + +replace go.opentelemetry.io/collector/internal/componentalias => ../../internal/componentalias diff --git a/internal/componentalias/Makefile b/internal/componentalias/Makefile new file mode 100644 index 000000000000..ded7a36092dc --- /dev/null +++ b/internal/componentalias/Makefile @@ -0,0 +1 @@ +include ../../Makefile.Common diff --git a/internal/componentalias/alias.go b/internal/componentalias/alias.go new file mode 100644 index 000000000000..7008a269cb64 --- /dev/null +++ b/internal/componentalias/alias.go @@ -0,0 +1,50 @@ +// Copyright The OpenTelemetry Authors +// SPDX-License-Identifier: Apache-2.0 + +package componentalias // import "go.opentelemetry.io/collector/internal/componentalias" + +import ( + "errors" + "fmt" + + "go.opentelemetry.io/collector/component" +) + +type TypeAliasHolder interface { + DeprecatedAlias() component.Type + SetDeprecatedAlias(component.Type) +} + +func NewTypeAliasHolder() TypeAliasHolder { + ta := typeAlias(component.Type{}) + return &ta +} + +type typeAlias component.Type + +// DeprecatedAlias returns the deprecated type typeAlias for this component, if any. +// Returns an empty component.Type if no typeAlias is configured. +func (ta *typeAlias) DeprecatedAlias() component.Type { + return component.Type(*ta) +} + +// SetDeprecatedAlias sets the deprecated type typeAlias. +func (ta *typeAlias) SetDeprecatedAlias(newAlias component.Type) { + *ta = typeAlias(newAlias) +} + +// ValidateComponentType returns an error if the provided factory does not match the provided component ID. +// It checks both the current type and any deprecated alias type. +func ValidateComponentType(f component.Factory, id component.ID) error { + if id.Type() == f.Type() { + return nil + } + errMsg := fmt.Sprintf("component type mismatch: component ID %q does not have type %q", id, f.Type()) + if aliasHolder, ok := f.(TypeAliasHolder); ok && aliasHolder.DeprecatedAlias().String() != "" { + if id.Type() == aliasHolder.DeprecatedAlias() { + return nil + } + errMsg += fmt.Sprintf(" or deprecated alias type %q", aliasHolder.DeprecatedAlias()) + } + return errors.New(errMsg) +} diff --git a/internal/componentalias/alias_test.go b/internal/componentalias/alias_test.go new file mode 100644 index 000000000000..c8ea7e8bd333 --- /dev/null +++ b/internal/componentalias/alias_test.go @@ -0,0 +1,157 @@ +// Copyright The OpenTelemetry Authors +// SPDX-License-Identifier: Apache-2.0 + +package componentalias + +import ( + "testing" + + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" + + "go.opentelemetry.io/collector/component" +) + +func TestNewTypeAliasHolder(t *testing.T) { + holder := NewTypeAliasHolder() + require.NotNil(t, holder) + + alias := holder.DeprecatedAlias() + assert.Equal(t, component.Type{}, alias) + assert.Empty(t, alias.String()) + + testType := component.MustNewType("test_alias") + holder.SetDeprecatedAlias(testType) + retrievedAlias := holder.DeprecatedAlias() + assert.Equal(t, testType, retrievedAlias) + assert.Equal(t, "test_alias", retrievedAlias.String()) +} + +type mockFactory struct { + factoryType component.Type + TypeAliasHolder +} + +func (f *mockFactory) Type() component.Type { + return f.factoryType +} + +func (f *mockFactory) CreateDefaultConfig() component.Config { + return nil +} + +func TestValidateComponentType_ExactMatch(t *testing.T) { + testType := component.MustNewType("test") + factory := &mockFactory{ + factoryType: testType, + TypeAliasHolder: NewTypeAliasHolder(), + } + + testID := component.MustNewID(testType.String()) + err := ValidateComponentType(factory, testID) + require.NoError(t, err) +} + +func TestValidateComponentType_AliasMatch(t *testing.T) { + factoryType := component.MustNewType("new_name") + aliasType := component.MustNewType("old_name") + + factory := &mockFactory{ + factoryType: factoryType, + TypeAliasHolder: NewTypeAliasHolder(), + } + factory.SetDeprecatedAlias(aliasType) + + // Test with alias type + aliasID := component.MustNewID(aliasType.String()) + err := ValidateComponentType(factory, aliasID) + require.NoError(t, err) + + // Test with factory type still works + factoryID := component.MustNewID(factoryType.String()) + err = ValidateComponentType(factory, factoryID) + require.NoError(t, err) +} + +func TestValidateComponentType_NoMatch(t *testing.T) { + factoryType := component.MustNewType("factory_type") + wrongType := component.MustNewType("wrong_type") + + factory := &mockFactory{ + factoryType: factoryType, + TypeAliasHolder: NewTypeAliasHolder(), + } + + wrongID := component.MustNewID(wrongType.String()) + err := ValidateComponentType(factory, wrongID) + require.Error(t, err) + assert.Contains(t, err.Error(), "component type mismatch") + assert.Contains(t, err.Error(), wrongType.String()) + assert.Contains(t, err.Error(), factoryType.String()) +} + +func TestValidateComponentType_NoMatchWithAlias(t *testing.T) { + factoryType := component.MustNewType("factory_type") + aliasType := component.MustNewType("alias_type") + wrongType := component.MustNewType("wrong_type") + + factory := &mockFactory{ + factoryType: factoryType, + TypeAliasHolder: NewTypeAliasHolder(), + } + factory.SetDeprecatedAlias(aliasType) + + wrongID := component.MustNewID(wrongType.String()) + err := ValidateComponentType(factory, wrongID) + require.Error(t, err) + assert.Contains(t, err.Error(), "component type mismatch") + assert.Contains(t, err.Error(), wrongType.String()) + assert.Contains(t, err.Error(), factoryType.String()) + assert.Contains(t, err.Error(), "deprecated alias type") + assert.Contains(t, err.Error(), aliasType.String()) +} + +func TestValidateComponentType_EmptyAlias(t *testing.T) { + factoryType := component.MustNewType("factory_type") + wrongType := component.MustNewType("wrong_type") + + factory := &mockFactory{ + factoryType: factoryType, + TypeAliasHolder: NewTypeAliasHolder(), + } + // Don't set any alias (empty by default) + + wrongID := component.MustNewID(wrongType.String()) + err := ValidateComponentType(factory, wrongID) + require.Error(t, err) + assert.Contains(t, err.Error(), "component type mismatch") + assert.NotContains(t, err.Error(), "deprecated alias type") +} + +type mockFactoryWithoutAlias struct { + factoryType component.Type +} + +func (f *mockFactoryWithoutAlias) Type() component.Type { + return f.factoryType +} + +func (f *mockFactoryWithoutAlias) CreateDefaultConfig() component.Config { + return nil +} + +func TestValidateComponentType_FactoryWithoutAliasSupport(t *testing.T) { + factoryType := component.MustNewType("factory_type") + factory := &mockFactoryWithoutAlias{factoryType: factoryType} + + factoryID := component.MustNewID(factoryType.String()) + err := ValidateComponentType(factory, factoryID) + require.NoError(t, err) + + wrongType := component.MustNewType("wrong_type") + wrongID := component.MustNewID(wrongType.String()) + err = ValidateComponentType(factory, wrongID) + require.Error(t, err) + assert.Contains(t, err.Error(), "component type mismatch") + assert.NotContains(t, err.Error(), "deprecated alias type") +} diff --git a/internal/componentalias/go.mod b/internal/componentalias/go.mod new file mode 100644 index 000000000000..c290787039fa --- /dev/null +++ b/internal/componentalias/go.mod @@ -0,0 +1,34 @@ +module go.opentelemetry.io/collector/internal/componentalias + +go 1.24.0 + +require ( + github.com/stretchr/testify v1.11.1 + go.opentelemetry.io/collector/component v1.49.0 +) + +require ( + github.com/cespare/xxhash/v2 v2.3.0 // indirect + github.com/davecgh/go-spew v1.1.1 // indirect + github.com/hashicorp/go-version v1.8.0 // indirect + github.com/json-iterator/go v1.1.12 // indirect + github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect + github.com/modern-go/reflect2 v1.0.3-0.20250322232337-35a7c28c31ee // indirect + github.com/pmezard/go-difflib v1.0.0 // indirect + go.opentelemetry.io/collector/featuregate v1.49.0 // indirect + go.opentelemetry.io/collector/pdata v1.49.0 // indirect + go.opentelemetry.io/otel v1.39.0 // indirect + go.opentelemetry.io/otel/metric v1.39.0 // indirect + go.opentelemetry.io/otel/trace v1.39.0 // indirect + go.uber.org/multierr v1.11.0 // indirect + go.uber.org/zap v1.27.1 // indirect + gopkg.in/yaml.v3 v3.0.1 // indirect +) + +replace go.opentelemetry.io/collector/component => ../../component + +replace go.opentelemetry.io/collector/pdata => ../../pdata + +replace go.opentelemetry.io/collector/featuregate => ../../featuregate + +replace go.opentelemetry.io/collector/internal/testutil => ../testutil diff --git a/internal/componentalias/go.sum b/internal/componentalias/go.sum new file mode 100644 index 000000000000..abdc34c9817c --- /dev/null +++ b/internal/componentalias/go.sum @@ -0,0 +1,61 @@ +github.com/cespare/xxhash/v2 v2.3.0 h1:UL815xU9SqsFlibzuggzjXhog7bL6oX9BbNZnL2UFvs= +github.com/cespare/xxhash/v2 v2.3.0/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs= +github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/go-logr/logr v1.4.3 h1:CjnDlHq8ikf6E492q6eKboGOC0T8CDaOvkHCIg8idEI= +github.com/go-logr/logr v1.4.3/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY= +github.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag= +github.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE= +github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8= +github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU= +github.com/google/gofuzz v1.0.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg= +github.com/hashicorp/go-version v1.8.0 h1:KAkNb1HAiZd1ukkxDFGmokVZe1Xy9HG6NUp+bPle2i4= +github.com/hashicorp/go-version v1.8.0/go.mod h1:fltr4n8CU8Ke44wwGCBoEymUuxUHl09ZGVZPK5anwXA= +github.com/json-iterator/go v1.1.12 h1:PV8peI4a0ysnczrg+LtxykD8LfKY9ML6u2jnxaEnrnM= +github.com/json-iterator/go v1.1.12/go.mod h1:e30LSqwooZae/UwlEbR2852Gd8hjQvJoHmT4TnhNGBo= +github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE= +github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk= +github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY= +github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE= +github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q= +github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd h1:TRLaZ9cD/w8PVh93nsPXa1VrQ6jlwL5oN8l14QlcNfg= +github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q= +github.com/modern-go/reflect2 v1.0.2/go.mod h1:yWuevngMOJpCy52FWWMvUC8ws7m/LJsjYzDa0/r8luk= +github.com/modern-go/reflect2 v1.0.3-0.20250322232337-35a7c28c31ee h1:W5t00kpgFdJifH4BDsTlE89Zl93FEloxaWZfGcifgq8= +github.com/modern-go/reflect2 v1.0.3-0.20250322232337-35a7c28c31ee/go.mod h1:yWuevngMOJpCy52FWWMvUC8ws7m/LJsjYzDa0/r8luk= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/rogpeppe/go-internal v1.13.1 h1:KvO1DLK/DRN07sQ1LQKScxyZJuNnedQ5/wKSR38lUII= +github.com/rogpeppe/go-internal v1.13.1/go.mod h1:uMEvuHeurkdAXX61udpOXGD/AzZDWNMNyH2VO9fmH0o= +github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= +github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= +github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= +go.opentelemetry.io/auto/sdk v1.2.1 h1:jXsnJ4Lmnqd11kwkBV2LgLoFMZKizbCi5fNZ/ipaZ64= +go.opentelemetry.io/auto/sdk v1.2.1/go.mod h1:KRTj+aOaElaLi+wW1kO/DZRXwkF4C5xPbEe3ZiIhN7Y= +go.opentelemetry.io/otel v1.39.0 h1:8yPrr/S0ND9QEfTfdP9V+SiwT4E0G7Y5MO7p85nis48= +go.opentelemetry.io/otel v1.39.0/go.mod h1:kLlFTywNWrFyEdH0oj2xK0bFYZtHRYUdv1NklR/tgc8= +go.opentelemetry.io/otel/metric v1.39.0 h1:d1UzonvEZriVfpNKEVmHXbdf909uGTOQjA0HF0Ls5Q0= +go.opentelemetry.io/otel/metric v1.39.0/go.mod h1:jrZSWL33sD7bBxg1xjrqyDjnuzTUB0x1nBERXd7Ftcs= +go.opentelemetry.io/otel/trace v1.39.0 h1:2d2vfpEDmCJ5zVYz7ijaJdOF59xLomrvj7bjt6/qCJI= +go.opentelemetry.io/otel/trace v1.39.0/go.mod h1:88w4/PnZSazkGzz/w84VHpQafiU4EtqqlVdxWy+rNOA= +go.opentelemetry.io/proto/slim/otlp v1.9.0 h1:fPVMv8tP3TrsqlkH1HWYUpbCY9cAIemx184VGkS6vlE= +go.opentelemetry.io/proto/slim/otlp v1.9.0/go.mod h1:xXdeJJ90Gqyll+orzUkY4bOd2HECo5JofeoLpymVqdI= +go.opentelemetry.io/proto/slim/otlp/collector/profiles/v1development v0.2.0 h1:o13nadWDNkH/quoDomDUClnQBpdQQ2Qqv0lQBjIXjE8= +go.opentelemetry.io/proto/slim/otlp/collector/profiles/v1development v0.2.0/go.mod h1:Gyb6Xe7FTi/6xBHwMmngGoHqL0w29Y4eW8TGFzpefGA= +go.opentelemetry.io/proto/slim/otlp/profiles/v1development v0.2.0 h1:EiUYvtwu6PMrMHVjcPfnsG3v+ajPkbUeH+IL93+QYyk= +go.opentelemetry.io/proto/slim/otlp/profiles/v1development v0.2.0/go.mod h1:mUUHKFiN2SST3AhJ8XhJxEoeVW12oqfXog0Bo8W3Ec4= +go.uber.org/goleak v1.3.0 h1:2K3zAYmnTNqV73imy9J1T3WC+gmCePx2hEGkimedGto= +go.uber.org/goleak v1.3.0/go.mod h1:CoHD4mav9JJNrW/WLlf7HGZPjdw8EucARQHekz1X6bE= +go.uber.org/multierr v1.11.0 h1:blXXJkSxSSfBVBlC76pxqeO+LN3aDfLQo+309xJstO0= +go.uber.org/multierr v1.11.0/go.mod h1:20+QtiLqy0Nd6FdQB9TLXag12DsQkrbs3htMFfDN80Y= +go.uber.org/zap v1.27.1 h1:08RqriUEv8+ArZRYSTXy1LeBScaMpVSTBhCeaZYfMYc= +go.uber.org/zap v1.27.1/go.mod h1:GB2qFLM7cTU87MWRP2mPIjqfIDnGu+VIO4V/SdhGo2E= +google.golang.org/protobuf v1.36.11 h1:fV6ZwhNocDyBLK0dj+fg8ektcVegBBuEolpbTQyBNVE= +google.golang.org/protobuf v1.36.11/go.mod h1:HTf+CrKn2C3g5S8VImy6tdcUvCska2kB7j23XfzDpco= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk= +gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/internal/e2e/go.mod b/internal/e2e/go.mod index 309a8a2bee08..2dca87ebb4ae 100644 --- a/internal/e2e/go.mod +++ b/internal/e2e/go.mod @@ -117,6 +117,7 @@ require ( go.opentelemetry.io/collector/extension/extensiontest v0.143.0 // indirect go.opentelemetry.io/collector/extension/xextension v0.143.0 // indirect go.opentelemetry.io/collector/featuregate v1.49.0 // indirect + go.opentelemetry.io/collector/internal/componentalias v0.0.0-00010101000000-000000000000 // indirect go.opentelemetry.io/collector/internal/fanoutconsumer v0.143.0 // indirect go.opentelemetry.io/collector/internal/telemetry v0.143.0 // indirect go.opentelemetry.io/collector/pdata/pprofile v0.143.0 // indirect @@ -303,3 +304,5 @@ replace go.opentelemetry.io/collector/confmap/provider/envprovider => ../../conf replace go.opentelemetry.io/collector/exporter/exporterhelper => ../../exporter/exporterhelper replace go.opentelemetry.io/collector/internal/testutil => ../../internal/testutil + +replace go.opentelemetry.io/collector/internal/componentalias => ../componentalias diff --git a/otelcol/factories.go b/otelcol/factories.go index 763770591890..1ef4b0498c12 100644 --- a/otelcol/factories.go +++ b/otelcol/factories.go @@ -10,6 +10,7 @@ import ( "go.opentelemetry.io/collector/connector" "go.opentelemetry.io/collector/exporter" "go.opentelemetry.io/collector/extension" + "go.opentelemetry.io/collector/internal/componentalias" "go.opentelemetry.io/collector/processor" "go.opentelemetry.io/collector/receiver" "go.opentelemetry.io/collector/service/telemetry" @@ -54,6 +55,7 @@ type Factories struct { // MakeFactoryMap takes a list of factories and returns a map with Factory type as keys. // It returns a non-nil error when there are factories with duplicate type. +// If a factory has a deprecated alias, the map will also contain an entry for the alias. func MakeFactoryMap[T component.Factory](factories ...T) (map[component.Type]T, error) { fMap := map[component.Type]T{} for _, f := range factories { @@ -61,6 +63,17 @@ func MakeFactoryMap[T component.Factory](factories ...T) (map[component.Type]T, return fMap, fmt.Errorf("duplicate component factory %q", f.Type()) } fMap[f.Type()] = f + + // If factory has a deprecated alias, add it to the map as well + if aliasHolder, ok := any(f).(componentalias.TypeAliasHolder); ok { + alias := aliasHolder.DeprecatedAlias() + if alias.String() != "" { + if _, exists := fMap[alias]; exists { + return fMap, fmt.Errorf("duplicate component factory %q (alias of %q)", alias, f.Type()) + } + fMap[alias] = f + } + } } return fMap, nil } diff --git a/otelcol/factories_test.go b/otelcol/factories_test.go index 52a5f0299e11..d1aa4e48b100 100644 --- a/otelcol/factories_test.go +++ b/otelcol/factories_test.go @@ -20,6 +20,7 @@ import ( "go.opentelemetry.io/collector/processor/processortest" "go.opentelemetry.io/collector/receiver" "go.opentelemetry.io/collector/receiver/receivertest" + "go.opentelemetry.io/collector/receiver/xreceiver" "go.opentelemetry.io/collector/service/telemetry" ) @@ -83,6 +84,7 @@ func TestMakeFactoryMap(t *testing.T) { fRec := receiver.NewFactory(component.MustNewType("rec"), nil) fRec2 := receiver.NewFactory(component.MustNewType("rec"), nil) + fRec3 := xreceiver.NewFactory(component.MustNewType("new_rec"), nil, xreceiver.WithDeprecatedTypeAlias(component.MustNewType("rec"))) fPro := processor.NewFactory(component.MustNewType("pro"), nil) fCon := connector.NewFactory(component.MustNewType("con"), nil) fExp := exporter.NewFactory(component.MustNewType("exp"), nil) @@ -103,6 +105,18 @@ func TestMakeFactoryMap(t *testing.T) { name: "same name", in: []component.Factory{fRec, fPro, fCon, fExp, fExt, fRec2}, }, + { + name: "with deprecated alias", + in: []component.Factory{fRec3}, + out: map[component.Type]component.Factory{ + fRec3.Type(): fRec3, + component.MustNewType("rec"): fRec3, + }, + }, + { + name: "conflicting alias name", + in: []component.Factory{fRec, fRec3}, + }, } for _, tt := range testCases { diff --git a/otelcol/go.mod b/otelcol/go.mod index c0516199008e..e58702970509 100644 --- a/otelcol/go.mod +++ b/otelcol/go.mod @@ -20,6 +20,7 @@ require ( go.opentelemetry.io/collector/extension v1.49.0 go.opentelemetry.io/collector/extension/extensiontest v0.143.0 go.opentelemetry.io/collector/featuregate v1.49.0 + go.opentelemetry.io/collector/internal/componentalias v0.0.0-00010101000000-000000000000 go.opentelemetry.io/collector/pipeline v1.49.0 go.opentelemetry.io/collector/processor v1.49.0 go.opentelemetry.io/collector/processor/processortest v0.143.0 @@ -231,3 +232,5 @@ replace go.opentelemetry.io/collector/pdata/xpdata => ../pdata/xpdata replace go.opentelemetry.io/collector/exporter/exporterhelper => ../exporter/exporterhelper replace go.opentelemetry.io/collector/internal/testutil => ../internal/testutil + +replace go.opentelemetry.io/collector/internal/componentalias => ../internal/componentalias diff --git a/otelcol/otelcoltest/go.mod b/otelcol/otelcoltest/go.mod index d19f8b3b73fa..0464d862d0f6 100644 --- a/otelcol/otelcoltest/go.mod +++ b/otelcol/otelcoltest/go.mod @@ -76,6 +76,7 @@ require ( go.opentelemetry.io/collector/extension v1.49.0 // indirect go.opentelemetry.io/collector/extension/extensioncapabilities v0.143.0 // indirect go.opentelemetry.io/collector/featuregate v1.49.0 // indirect + go.opentelemetry.io/collector/internal/componentalias v0.0.0-00010101000000-000000000000 // indirect go.opentelemetry.io/collector/internal/fanoutconsumer v0.143.0 // indirect go.opentelemetry.io/collector/internal/telemetry v0.143.0 // indirect go.opentelemetry.io/collector/pdata v1.49.0 // indirect @@ -241,3 +242,5 @@ replace go.opentelemetry.io/collector/exporter/exporterhelper => ../../exporter/ replace go.opentelemetry.io/collector/config/configoptional => ../../config/configoptional replace go.opentelemetry.io/collector/internal/testutil => ../../internal/testutil + +replace go.opentelemetry.io/collector/internal/componentalias => ../../internal/componentalias diff --git a/processor/batchprocessor/go.mod b/processor/batchprocessor/go.mod index 57deb0c1f1a3..d1252b6571de 100644 --- a/processor/batchprocessor/go.mod +++ b/processor/batchprocessor/go.mod @@ -46,6 +46,7 @@ require ( go.opentelemetry.io/collector/component/componentstatus v0.143.0 // indirect go.opentelemetry.io/collector/consumer/xconsumer v0.143.0 // indirect go.opentelemetry.io/collector/featuregate v1.49.0 // indirect + go.opentelemetry.io/collector/internal/componentalias v0.0.0-00010101000000-000000000000 // indirect go.opentelemetry.io/collector/pdata/pprofile v0.143.0 // indirect go.opentelemetry.io/collector/pipeline v1.49.0 // indirect go.opentelemetry.io/collector/processor/xprocessor v0.143.0 // indirect @@ -101,3 +102,5 @@ replace go.opentelemetry.io/collector/consumer/consumererror => ../../consumer/c replace go.opentelemetry.io/collector/featuregate => ../../featuregate replace go.opentelemetry.io/collector/internal/testutil => ../../internal/testutil + +replace go.opentelemetry.io/collector/internal/componentalias => ../../internal/componentalias diff --git a/processor/go.mod b/processor/go.mod index fbccd098cb00..fe988b55e48c 100644 --- a/processor/go.mod +++ b/processor/go.mod @@ -7,6 +7,7 @@ require ( go.opentelemetry.io/collector/component v1.49.0 go.opentelemetry.io/collector/consumer v1.49.0 go.opentelemetry.io/collector/consumer/consumertest v0.143.0 + go.opentelemetry.io/collector/internal/componentalias v0.0.0-00010101000000-000000000000 go.opentelemetry.io/collector/pipeline v1.49.0 go.uber.org/goleak v1.3.0 ) @@ -50,3 +51,5 @@ replace go.opentelemetry.io/collector/pipeline => ../pipeline replace go.opentelemetry.io/collector/featuregate => ../featuregate replace go.opentelemetry.io/collector/internal/testutil => ../internal/testutil + +replace go.opentelemetry.io/collector/internal/componentalias => ../internal/componentalias diff --git a/processor/memorylimiterprocessor/go.mod b/processor/memorylimiterprocessor/go.mod index 8f536e3df94d..aef57af18761 100644 --- a/processor/memorylimiterprocessor/go.mod +++ b/processor/memorylimiterprocessor/go.mod @@ -58,6 +58,7 @@ require ( go.opentelemetry.io/auto/sdk v1.2.1 // indirect go.opentelemetry.io/collector/component/componentstatus v0.143.0 // indirect go.opentelemetry.io/collector/featuregate v1.49.0 // indirect + go.opentelemetry.io/collector/internal/componentalias v0.0.0-00010101000000-000000000000 // indirect go.opentelemetry.io/collector/pdata/testdata v0.143.0 // indirect go.opentelemetry.io/otel/sdk v1.39.0 // indirect go.uber.org/multierr v1.11.0 // indirect @@ -118,3 +119,5 @@ replace go.opentelemetry.io/collector/processor/processorhelper => ../processorh replace go.opentelemetry.io/collector/pipeline/xpipeline => ../../pipeline/xpipeline replace go.opentelemetry.io/collector/internal/testutil => ../../internal/testutil + +replace go.opentelemetry.io/collector/internal/componentalias => ../../internal/componentalias diff --git a/processor/processor.go b/processor/processor.go index 93ed0b69f653..8b1203e9f530 100644 --- a/processor/processor.go +++ b/processor/processor.go @@ -8,8 +8,8 @@ import ( "go.opentelemetry.io/collector/component" "go.opentelemetry.io/collector/consumer" + "go.opentelemetry.io/collector/internal/componentalias" "go.opentelemetry.io/collector/pipeline" - "go.opentelemetry.io/collector/processor/internal" ) // Traces is a processor that can consume traces. @@ -99,6 +99,7 @@ func (f factoryOptionFunc) applyOption(o *factory) { type factory struct { cfgType component.Type component.CreateDefaultConfigFunc + componentalias.TypeAliasHolder createTracesFunc CreateTracesFunc tracesStabilityLevel component.StabilityLevel createMetricsFunc CreateMetricsFunc @@ -130,8 +131,8 @@ func (f *factory) CreateTraces(ctx context.Context, set Settings, cfg component. return nil, pipeline.ErrSignalNotSupported } - if set.ID.Type() != f.Type() { - return nil, internal.ErrIDMismatch(set.ID, f.Type()) + if err := componentalias.ValidateComponentType(f, set.ID); err != nil { + return nil, err } return f.createTracesFunc(ctx, set, cfg, next) @@ -142,8 +143,8 @@ func (f *factory) CreateMetrics(ctx context.Context, set Settings, cfg component return nil, pipeline.ErrSignalNotSupported } - if set.ID.Type() != f.Type() { - return nil, internal.ErrIDMismatch(set.ID, f.Type()) + if err := componentalias.ValidateComponentType(f, set.ID); err != nil { + return nil, err } return f.createMetricsFunc(ctx, set, cfg, next) @@ -154,8 +155,8 @@ func (f *factory) CreateLogs(ctx context.Context, set Settings, cfg component.Co return nil, pipeline.ErrSignalNotSupported } - if set.ID.Type() != f.Type() { - return nil, internal.ErrIDMismatch(set.ID, f.Type()) + if err := componentalias.ValidateComponentType(f, set.ID); err != nil { + return nil, err } return f.createLogsFunc(ctx, set, cfg, next) @@ -199,6 +200,7 @@ func NewFactory(cfgType component.Type, createDefaultConfig component.CreateDefa f := &factory{ cfgType: cfgType, CreateDefaultConfigFunc: createDefaultConfig, + TypeAliasHolder: componentalias.NewTypeAliasHolder(), } for _, opt := range options { opt.applyOption(f) diff --git a/processor/processorhelper/go.mod b/processor/processorhelper/go.mod index 4026759218b7..00a49f759c59 100644 --- a/processor/processorhelper/go.mod +++ b/processor/processorhelper/go.mod @@ -36,6 +36,7 @@ require ( go.opentelemetry.io/collector/component/componentstatus v0.143.0 // indirect go.opentelemetry.io/collector/consumer/xconsumer v0.143.0 // indirect go.opentelemetry.io/collector/featuregate v1.49.0 // indirect + go.opentelemetry.io/collector/internal/componentalias v0.0.0-00010101000000-000000000000 // indirect go.opentelemetry.io/collector/pdata/pprofile v0.143.0 // indirect go.opentelemetry.io/collector/pdata/testdata v0.143.0 // indirect go.opentelemetry.io/collector/processor/xprocessor v0.143.0 // indirect @@ -73,3 +74,5 @@ replace go.opentelemetry.io/collector/component/componentstatus => ../../compone replace go.opentelemetry.io/collector/featuregate => ../../featuregate replace go.opentelemetry.io/collector/internal/testutil => ../../internal/testutil + +replace go.opentelemetry.io/collector/internal/componentalias => ../../internal/componentalias diff --git a/processor/processorhelper/xprocessorhelper/go.mod b/processor/processorhelper/xprocessorhelper/go.mod index 59cb5d9a32a7..047fe78da121 100644 --- a/processor/processorhelper/xprocessorhelper/go.mod +++ b/processor/processorhelper/xprocessorhelper/go.mod @@ -30,6 +30,7 @@ require ( go.opentelemetry.io/auto/sdk v1.2.1 // indirect go.opentelemetry.io/collector/component/componentstatus v0.143.0 // indirect go.opentelemetry.io/collector/featuregate v1.49.0 // indirect + go.opentelemetry.io/collector/internal/componentalias v0.0.0-00010101000000-000000000000 // indirect go.opentelemetry.io/collector/pdata v1.49.0 // indirect go.opentelemetry.io/collector/pdata/testdata v0.143.0 // indirect go.opentelemetry.io/collector/pipeline v1.49.0 // indirect @@ -75,3 +76,5 @@ replace go.opentelemetry.io/collector/processor/xprocessor => ../../xprocessor replace go.opentelemetry.io/collector/featuregate => ../../../featuregate replace go.opentelemetry.io/collector/internal/testutil => ../../../internal/testutil + +replace go.opentelemetry.io/collector/internal/componentalias => ../../../internal/componentalias diff --git a/processor/processortest/go.mod b/processor/processortest/go.mod index 97748ddbcb4a..7236e1b6e77b 100644 --- a/processor/processortest/go.mod +++ b/processor/processortest/go.mod @@ -32,6 +32,7 @@ require ( github.com/pmezard/go-difflib v1.0.0 // indirect go.opentelemetry.io/auto/sdk v1.2.1 // indirect go.opentelemetry.io/collector/featuregate v1.49.0 // indirect + go.opentelemetry.io/collector/internal/componentalias v0.0.0-00010101000000-000000000000 // indirect go.opentelemetry.io/otel v1.39.0 // indirect go.opentelemetry.io/otel/metric v1.39.0 // indirect go.opentelemetry.io/otel/sdk v1.39.0 // indirect @@ -70,3 +71,5 @@ replace go.opentelemetry.io/collector/pipeline => ../../pipeline replace go.opentelemetry.io/collector/featuregate => ../../featuregate replace go.opentelemetry.io/collector/internal/testutil => ../../internal/testutil + +replace go.opentelemetry.io/collector/internal/componentalias => ../../internal/componentalias diff --git a/processor/xprocessor/go.mod b/processor/xprocessor/go.mod index 8f39e0c555a3..682bb93e6dd0 100644 --- a/processor/xprocessor/go.mod +++ b/processor/xprocessor/go.mod @@ -7,6 +7,7 @@ require ( go.opentelemetry.io/collector/component v1.49.0 go.opentelemetry.io/collector/consumer/consumertest v0.143.0 go.opentelemetry.io/collector/consumer/xconsumer v0.143.0 + go.opentelemetry.io/collector/internal/componentalias v0.0.0-00010101000000-000000000000 go.opentelemetry.io/collector/pipeline v1.49.0 go.opentelemetry.io/collector/processor v1.49.0 ) @@ -19,6 +20,7 @@ require ( github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect github.com/modern-go/reflect2 v1.0.3-0.20250322232337-35a7c28c31ee // indirect github.com/pmezard/go-difflib v1.0.0 // indirect + github.com/rogpeppe/go-internal v1.14.1 // indirect go.opentelemetry.io/collector/consumer v1.49.0 // indirect go.opentelemetry.io/collector/featuregate v1.49.0 // indirect go.opentelemetry.io/collector/pdata v1.49.0 // indirect @@ -52,3 +54,5 @@ replace go.opentelemetry.io/collector/pipeline => ../../pipeline replace go.opentelemetry.io/collector/featuregate => ../../featuregate replace go.opentelemetry.io/collector/internal/testutil => ../../internal/testutil + +replace go.opentelemetry.io/collector/internal/componentalias => ../../internal/componentalias diff --git a/processor/xprocessor/go.sum b/processor/xprocessor/go.sum index abdc34c9817c..7228f36f9dce 100644 --- a/processor/xprocessor/go.sum +++ b/processor/xprocessor/go.sum @@ -26,8 +26,8 @@ github.com/modern-go/reflect2 v1.0.3-0.20250322232337-35a7c28c31ee h1:W5t00kpgFd github.com/modern-go/reflect2 v1.0.3-0.20250322232337-35a7c28c31ee/go.mod h1:yWuevngMOJpCy52FWWMvUC8ws7m/LJsjYzDa0/r8luk= github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= -github.com/rogpeppe/go-internal v1.13.1 h1:KvO1DLK/DRN07sQ1LQKScxyZJuNnedQ5/wKSR38lUII= -github.com/rogpeppe/go-internal v1.13.1/go.mod h1:uMEvuHeurkdAXX61udpOXGD/AzZDWNMNyH2VO9fmH0o= +github.com/rogpeppe/go-internal v1.14.1 h1:UQB4HGPB6osV0SQTLymcB4TgvyWu6ZyliaW0tI/otEQ= +github.com/rogpeppe/go-internal v1.14.1/go.mod h1:MaRKkUm5W0goXpeCfT7UZI6fk/L7L7so1lCWt35ZSgc= github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= diff --git a/processor/xprocessor/processor.go b/processor/xprocessor/processor.go index 9d575d1e9898..24c71b61eba5 100644 --- a/processor/xprocessor/processor.go +++ b/processor/xprocessor/processor.go @@ -8,9 +8,9 @@ import ( "go.opentelemetry.io/collector/component" "go.opentelemetry.io/collector/consumer/xconsumer" + "go.opentelemetry.io/collector/internal/componentalias" "go.opentelemetry.io/collector/pipeline" "go.opentelemetry.io/collector/processor" - "go.opentelemetry.io/collector/processor/internal" ) // Factory is a component.Factory interface for processors. @@ -54,6 +54,7 @@ func (f factoryOptionFunc) applyOption(o *factoryOpts) { type factory struct { processor.Factory + componentalias.TypeAliasHolder createProfilesFunc CreateProfilesFunc profilesStabilityLevel component.StabilityLevel } @@ -66,8 +67,8 @@ func (f *factory) CreateProfiles(ctx context.Context, set processor.Settings, cf if f.createProfilesFunc == nil { return nil, pipeline.ErrSignalNotSupported } - if set.ID.Type() != f.Type() { - return nil, internal.ErrIDMismatch(set.ID, f.Type()) + if err := componentalias.ValidateComponentType(f.Factory, set.ID); err != nil { + return nil, err } return f.createProfilesFunc(ctx, set, cfg, next) } @@ -75,6 +76,7 @@ func (f *factory) CreateProfiles(ctx context.Context, set processor.Settings, cf type factoryOpts struct { opts []processor.FactoryOption *factory + deprecatedAlias component.Type } // WithTraces overrides the default "error not supported" implementation for CreateTraces and the default "undefined" stability level. @@ -106,12 +108,23 @@ func WithProfiles(createProfiles CreateProfilesFunc, sl component.StabilityLevel }) } +// WithDeprecatedTypeAlias configures a deprecated type alias for the processor. Only one alias is supported per processor. +// When the alias is used in configuration, a deprecation warning is automatically logged. +func WithDeprecatedTypeAlias(alias component.Type) FactoryOption { + return factoryOptionFunc(func(o *factoryOpts) { + o.deprecatedAlias = alias + }) +} + // NewFactory returns a Factory. func NewFactory(cfgType component.Type, createDefaultConfig component.CreateDefaultConfigFunc, options ...FactoryOption) Factory { - opts := factoryOpts{factory: &factory{}} + f := &factory{TypeAliasHolder: componentalias.NewTypeAliasHolder()} + opts := factoryOpts{factory: f} for _, opt := range options { opt.applyOption(&opts) } opts.Factory = processor.NewFactory(cfgType, createDefaultConfig, opts.opts...) + opts.Factory.(componentalias.TypeAliasHolder).SetDeprecatedAlias(opts.deprecatedAlias) + f.SetDeprecatedAlias(opts.deprecatedAlias) return opts.factory } diff --git a/processor/xprocessor/processor_test.go b/processor/xprocessor/processor_test.go index 215464eba61e..51bdc68f7e57 100644 --- a/processor/xprocessor/processor_test.go +++ b/processor/xprocessor/processor_test.go @@ -13,6 +13,7 @@ import ( "go.opentelemetry.io/collector/component" "go.opentelemetry.io/collector/consumer/consumertest" "go.opentelemetry.io/collector/consumer/xconsumer" + "go.opentelemetry.io/collector/internal/componentalias" "go.opentelemetry.io/collector/processor" "go.opentelemetry.io/collector/processor/internal" ) @@ -54,3 +55,27 @@ type nopProcessor struct { func createProfiles(context.Context, processor.Settings, component.Config, xconsumer.Profiles) (Profiles, error) { return nopInstance, nil } + +func TestNewFactoryWithDeprecatedAlias(t *testing.T) { + testType := component.MustNewType("newname") + aliasType := component.MustNewType("oldname") + defaultCfg := struct{}{} + + f := NewFactory( + testType, + func() component.Config { return &defaultCfg }, + WithProfiles(createProfiles, component.StabilityLevelAlpha), + WithDeprecatedTypeAlias(aliasType), + ) + + assert.Equal(t, testType, f.Type()) + assert.Equal(t, aliasType, f.(*factory).Factory.(componentalias.TypeAliasHolder).DeprecatedAlias()) + assert.EqualValues(t, &defaultCfg, f.CreateDefaultConfig()) + + _, err := f.CreateProfiles(context.Background(), processor.Settings{ID: component.MustNewID("newname")}, &defaultCfg, consumertest.NewNop()) + require.NoError(t, err) + _, err = f.CreateProfiles(context.Background(), processor.Settings{ID: component.MustNewID("oldname")}, &defaultCfg, consumertest.NewNop()) + require.NoError(t, err) + _, err = f.CreateProfiles(context.Background(), processor.Settings{ID: component.MustNewID("wrongname")}, &defaultCfg, consumertest.NewNop()) + require.Error(t, err) +} diff --git a/receiver/go.mod b/receiver/go.mod index 919820754c6b..76dc0ddcd1e0 100644 --- a/receiver/go.mod +++ b/receiver/go.mod @@ -7,6 +7,7 @@ require ( go.opentelemetry.io/collector/component v1.49.0 go.opentelemetry.io/collector/consumer v1.49.0 go.opentelemetry.io/collector/consumer/consumertest v0.143.0 + go.opentelemetry.io/collector/internal/componentalias v0.0.0-00010101000000-000000000000 go.opentelemetry.io/collector/pdata v1.49.0 go.opentelemetry.io/collector/pipeline v1.49.0 go.uber.org/goleak v1.3.0 @@ -52,3 +53,5 @@ replace go.opentelemetry.io/collector/pipeline => ../pipeline replace go.opentelemetry.io/collector/featuregate => ../featuregate replace go.opentelemetry.io/collector/internal/testutil => ../internal/testutil + +replace go.opentelemetry.io/collector/internal/componentalias => ../internal/componentalias diff --git a/receiver/nopreceiver/go.mod b/receiver/nopreceiver/go.mod index 70f23a0f92e4..c697fae0e5f2 100644 --- a/receiver/nopreceiver/go.mod +++ b/receiver/nopreceiver/go.mod @@ -39,6 +39,7 @@ require ( go.opentelemetry.io/auto/sdk v1.2.1 // indirect go.opentelemetry.io/collector/consumer/consumererror v0.143.0 // indirect go.opentelemetry.io/collector/featuregate v1.49.0 // indirect + go.opentelemetry.io/collector/internal/componentalias v0.0.0-00010101000000-000000000000 // indirect go.opentelemetry.io/collector/pdata/pprofile v0.143.0 // indirect go.opentelemetry.io/collector/pipeline v1.49.0 // indirect go.opentelemetry.io/otel v1.39.0 // indirect @@ -86,3 +87,5 @@ replace go.opentelemetry.io/collector/consumer/consumererror => ../../consumer/c replace go.opentelemetry.io/collector/featuregate => ../../featuregate replace go.opentelemetry.io/collector/internal/testutil => ../../internal/testutil + +replace go.opentelemetry.io/collector/internal/componentalias => ../../internal/componentalias diff --git a/receiver/otlpreceiver/go.mod b/receiver/otlpreceiver/go.mod index 4e556f133060..2019165c90b3 100644 --- a/receiver/otlpreceiver/go.mod +++ b/receiver/otlpreceiver/go.mod @@ -74,6 +74,7 @@ require ( go.opentelemetry.io/collector/extension/extensionauth v1.49.0 // indirect go.opentelemetry.io/collector/extension/extensionmiddleware v0.143.0 // indirect go.opentelemetry.io/collector/featuregate v1.49.0 // indirect + go.opentelemetry.io/collector/internal/componentalias v0.0.0-00010101000000-000000000000 // indirect go.opentelemetry.io/collector/pipeline v1.49.0 // indirect go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.63.0 // indirect go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.63.0 // indirect @@ -167,3 +168,5 @@ replace go.opentelemetry.io/collector/config/configmiddleware => ../../config/co replace go.opentelemetry.io/collector/extension/extensionmiddleware/extensionmiddlewaretest => ../../extension/extensionmiddleware/extensionmiddlewaretest replace go.opentelemetry.io/collector/internal/testutil => ../../internal/testutil + +replace go.opentelemetry.io/collector/internal/componentalias => ../../internal/componentalias diff --git a/receiver/receiver.go b/receiver/receiver.go index f2aa1fe2c584..833951574fea 100644 --- a/receiver/receiver.go +++ b/receiver/receiver.go @@ -8,8 +8,8 @@ import ( "go.opentelemetry.io/collector/component" "go.opentelemetry.io/collector/consumer" + "go.opentelemetry.io/collector/internal/componentalias" "go.opentelemetry.io/collector/pipeline" - "go.opentelemetry.io/collector/receiver/internal" ) // Traces receiver receives traces. @@ -115,6 +115,7 @@ type CreateLogsFunc func(context.Context, Settings, component.Config, consumer.L type factory struct { cfgType component.Type component.CreateDefaultConfigFunc + componentalias.TypeAliasHolder createTracesFunc CreateTracesFunc tracesStabilityLevel component.StabilityLevel createMetricsFunc CreateMetricsFunc @@ -146,8 +147,8 @@ func (f *factory) CreateTraces(ctx context.Context, set Settings, cfg component. return nil, pipeline.ErrSignalNotSupported } - if set.ID.Type() != f.Type() { - return nil, internal.ErrIDMismatch(set.ID, f.Type()) + if err := componentalias.ValidateComponentType(f, set.ID); err != nil { + return nil, err } return f.createTracesFunc(ctx, set, cfg, next) @@ -158,8 +159,8 @@ func (f *factory) CreateMetrics(ctx context.Context, set Settings, cfg component return nil, pipeline.ErrSignalNotSupported } - if set.ID.Type() != f.Type() { - return nil, internal.ErrIDMismatch(set.ID, f.Type()) + if err := componentalias.ValidateComponentType(f, set.ID); err != nil { + return nil, err } return f.createMetricsFunc(ctx, set, cfg, next) @@ -170,8 +171,8 @@ func (f *factory) CreateLogs(ctx context.Context, set Settings, cfg component.Co return nil, pipeline.ErrSignalNotSupported } - if set.ID.Type() != f.Type() { - return nil, internal.ErrIDMismatch(set.ID, f.Type()) + if err := componentalias.ValidateComponentType(f, set.ID); err != nil { + return nil, err } return f.createLogsFunc(ctx, set, cfg, next) @@ -206,6 +207,7 @@ func NewFactory(cfgType component.Type, createDefaultConfig component.CreateDefa f := &factory{ cfgType: cfgType, CreateDefaultConfigFunc: createDefaultConfig, + TypeAliasHolder: componentalias.NewTypeAliasHolder(), } for _, opt := range options { opt.applyOption(f) diff --git a/receiver/receiverhelper/go.mod b/receiver/receiverhelper/go.mod index 8292ef085426..e0e4163c0b78 100644 --- a/receiver/receiverhelper/go.mod +++ b/receiver/receiverhelper/go.mod @@ -30,6 +30,7 @@ require ( github.com/pmezard/go-difflib v1.0.0 // indirect go.opentelemetry.io/auto/sdk v1.2.1 // indirect go.opentelemetry.io/collector/consumer v1.49.0 // indirect + go.opentelemetry.io/collector/internal/componentalias v0.0.0-00010101000000-000000000000 // indirect go.opentelemetry.io/collector/pdata v1.49.0 // indirect go.opentelemetry.io/collector/pdata/pprofile v0.143.0 // indirect go.opentelemetry.io/otel/sdk v1.39.0 // indirect @@ -67,3 +68,5 @@ replace go.opentelemetry.io/collector/featuregate => ../../featuregate replace go.opentelemetry.io/collector/consumer/consumererror => ../../consumer/consumererror replace go.opentelemetry.io/collector/internal/testutil => ../../internal/testutil + +replace go.opentelemetry.io/collector/internal/componentalias => ../../internal/componentalias diff --git a/receiver/receivertest/go.mod b/receiver/receivertest/go.mod index 88a399b406bc..be963c1a1df2 100644 --- a/receiver/receivertest/go.mod +++ b/receiver/receivertest/go.mod @@ -30,6 +30,7 @@ require ( github.com/pmezard/go-difflib v1.0.0 // indirect go.opentelemetry.io/auto/sdk v1.2.1 // indirect go.opentelemetry.io/collector/featuregate v1.49.0 // indirect + go.opentelemetry.io/collector/internal/componentalias v0.0.0-00010101000000-000000000000 // indirect go.opentelemetry.io/collector/pdata/pprofile v0.143.0 // indirect go.opentelemetry.io/otel v1.39.0 // indirect go.opentelemetry.io/otel/metric v1.39.0 // indirect @@ -72,3 +73,5 @@ replace go.opentelemetry.io/collector/consumer/consumertest => ../../consumer/co replace go.opentelemetry.io/collector/featuregate => ../../featuregate replace go.opentelemetry.io/collector/internal/testutil => ../../internal/testutil + +replace go.opentelemetry.io/collector/internal/componentalias => ../../internal/componentalias diff --git a/receiver/xreceiver/go.mod b/receiver/xreceiver/go.mod index b45ad392e597..761824c0b5c7 100644 --- a/receiver/xreceiver/go.mod +++ b/receiver/xreceiver/go.mod @@ -7,6 +7,7 @@ require ( go.opentelemetry.io/collector/component v1.49.0 go.opentelemetry.io/collector/consumer/consumertest v0.143.0 go.opentelemetry.io/collector/consumer/xconsumer v0.143.0 + go.opentelemetry.io/collector/internal/componentalias v0.0.0-00010101000000-000000000000 go.opentelemetry.io/collector/pipeline v1.49.0 go.opentelemetry.io/collector/receiver v1.49.0 ) @@ -52,3 +53,5 @@ replace go.opentelemetry.io/collector/pipeline => ../../pipeline replace go.opentelemetry.io/collector/featuregate => ../../featuregate replace go.opentelemetry.io/collector/internal/testutil => ../../internal/testutil + +replace go.opentelemetry.io/collector/internal/componentalias => ../../internal/componentalias diff --git a/receiver/xreceiver/receiver.go b/receiver/xreceiver/receiver.go index 8a912119ab27..52e78a3cabd3 100644 --- a/receiver/xreceiver/receiver.go +++ b/receiver/xreceiver/receiver.go @@ -8,9 +8,9 @@ import ( "go.opentelemetry.io/collector/component" "go.opentelemetry.io/collector/consumer/xconsumer" + "go.opentelemetry.io/collector/internal/componentalias" "go.opentelemetry.io/collector/pipeline" "go.opentelemetry.io/collector/receiver" - "go.opentelemetry.io/collector/receiver/internal" ) // Profiles receiver receives profiles. @@ -56,6 +56,7 @@ func (f factoryOptionFunc) applyOption(o *factoryOpts) { type factory struct { receiver.Factory + componentalias.TypeAliasHolder createProfilesFunc CreateProfilesFunc profilesStabilityLevel component.StabilityLevel } @@ -68,8 +69,8 @@ func (f *factory) CreateProfiles(ctx context.Context, set receiver.Settings, cfg if f.createProfilesFunc == nil { return nil, pipeline.ErrSignalNotSupported } - if set.ID.Type() != f.Type() { - return nil, internal.ErrIDMismatch(set.ID, f.Type()) + if err := componentalias.ValidateComponentType(f.Factory, set.ID); err != nil { + return nil, err } return f.createProfilesFunc(ctx, set, cfg, next) } @@ -77,6 +78,7 @@ func (f *factory) CreateProfiles(ctx context.Context, set receiver.Settings, cfg type factoryOpts struct { opts []receiver.FactoryOption *factory + deprecatedAlias component.Type } // WithTraces overrides the default "error not supported" implementation for Factory.CreateTraces and the default "undefined" stability level. @@ -108,12 +110,23 @@ func WithProfiles(createProfiles CreateProfilesFunc, sl component.StabilityLevel }) } +// WithDeprecatedTypeAlias configures a deprecated type alias for the receiver. Only one alias is supported per receiver. +// When the alias is used in configuration, a deprecation warning is automatically logged. +func WithDeprecatedTypeAlias(alias component.Type) FactoryOption { + return factoryOptionFunc(func(o *factoryOpts) { + o.deprecatedAlias = alias + }) +} + // NewFactory returns a Factory. func NewFactory(cfgType component.Type, createDefaultConfig component.CreateDefaultConfigFunc, options ...FactoryOption) Factory { - opts := factoryOpts{factory: &factory{}} + f := &factory{TypeAliasHolder: componentalias.NewTypeAliasHolder()} + opts := factoryOpts{factory: f} for _, opt := range options { opt.applyOption(&opts) } opts.Factory = receiver.NewFactory(cfgType, createDefaultConfig, opts.opts...) + opts.Factory.(componentalias.TypeAliasHolder).SetDeprecatedAlias(opts.deprecatedAlias) + f.SetDeprecatedAlias(opts.deprecatedAlias) return opts.factory } diff --git a/receiver/xreceiver/receiver_test.go b/receiver/xreceiver/receiver_test.go index fb9b9c335618..fed7e6c844f0 100644 --- a/receiver/xreceiver/receiver_test.go +++ b/receiver/xreceiver/receiver_test.go @@ -13,6 +13,7 @@ import ( "go.opentelemetry.io/collector/component" "go.opentelemetry.io/collector/consumer/consumertest" "go.opentelemetry.io/collector/consumer/xconsumer" + "go.opentelemetry.io/collector/internal/componentalias" "go.opentelemetry.io/collector/receiver" "go.opentelemetry.io/collector/receiver/internal" ) @@ -53,3 +54,27 @@ type nopReceiver struct { func createProfiles(context.Context, receiver.Settings, component.Config, xconsumer.Profiles) (Profiles, error) { return nopInstance, nil } + +func TestNewFactoryWithDeprecatedAlias(t *testing.T) { + testType := component.MustNewType("newname") + aliasType := component.MustNewType("oldname") + defaultCfg := struct{}{} + + f := NewFactory( + testType, + func() component.Config { return &defaultCfg }, + WithProfiles(createProfiles, component.StabilityLevelAlpha), + WithDeprecatedTypeAlias(aliasType), + ) + + assert.Equal(t, testType, f.Type()) + assert.Equal(t, aliasType, f.(*factory).Factory.(componentalias.TypeAliasHolder).DeprecatedAlias()) + assert.EqualValues(t, &defaultCfg, f.CreateDefaultConfig()) + + _, err := f.CreateProfiles(context.Background(), receiver.Settings{ID: component.MustNewID("newname")}, &defaultCfg, consumertest.NewNop()) + require.NoError(t, err) + _, err = f.CreateProfiles(context.Background(), receiver.Settings{ID: component.MustNewID("oldname")}, &defaultCfg, consumertest.NewNop()) + require.NoError(t, err) + _, err = f.CreateProfiles(context.Background(), receiver.Settings{ID: component.MustNewID("wrongname")}, &defaultCfg, consumertest.NewNop()) + require.Error(t, err) +} diff --git a/scraper/scraperhelper/go.mod b/scraper/scraperhelper/go.mod index a3e5a4aa0854..8dd9d1a91c94 100644 --- a/scraper/scraperhelper/go.mod +++ b/scraper/scraperhelper/go.mod @@ -40,6 +40,7 @@ require ( go.opentelemetry.io/collector/consumer/consumererror v0.143.0 // indirect go.opentelemetry.io/collector/consumer/xconsumer v0.143.0 // indirect go.opentelemetry.io/collector/featuregate v1.49.0 // indirect + go.opentelemetry.io/collector/internal/componentalias v0.0.0-00010101000000-000000000000 // indirect go.opentelemetry.io/collector/pdata/pprofile v0.143.0 // indirect go.opentelemetry.io/collector/receiver/xreceiver v0.143.0 // indirect golang.org/x/sys v0.39.0 // indirect @@ -82,3 +83,5 @@ replace go.opentelemetry.io/collector/consumer/consumertest => ../../consumer/co replace go.opentelemetry.io/collector/featuregate => ../../featuregate replace go.opentelemetry.io/collector/internal/testutil => ../../internal/testutil + +replace go.opentelemetry.io/collector/internal/componentalias => ../../internal/componentalias diff --git a/service/go.mod b/service/go.mod index e12d1fd992cf..358c6854f2f6 100644 --- a/service/go.mod +++ b/service/go.mod @@ -30,6 +30,7 @@ require ( go.opentelemetry.io/collector/extension/extensiontest v0.143.0 go.opentelemetry.io/collector/extension/zpagesextension v0.143.0 go.opentelemetry.io/collector/featuregate v1.49.0 + go.opentelemetry.io/collector/internal/componentalias v0.0.0-00010101000000-000000000000 go.opentelemetry.io/collector/internal/fanoutconsumer v0.143.0 go.opentelemetry.io/collector/internal/telemetry v0.143.0 go.opentelemetry.io/collector/internal/testutil v0.143.0 @@ -254,3 +255,5 @@ replace go.opentelemetry.io/collector/exporter/exporterhelper => ../exporter/exp replace go.opentelemetry.io/collector/config/configoptional => ../config/configoptional replace go.opentelemetry.io/collector/internal/testutil => ../internal/testutil + +replace go.opentelemetry.io/collector/internal/componentalias => ../internal/componentalias diff --git a/service/hostcapabilities/go.mod b/service/hostcapabilities/go.mod index 6a4294fac29f..d363c2a5c397 100644 --- a/service/hostcapabilities/go.mod +++ b/service/hostcapabilities/go.mod @@ -91,3 +91,5 @@ replace go.opentelemetry.io/collector/config/configoptional => ../../config/conf replace go.opentelemetry.io/collector/service/telemetry/telemetrytest => ../telemetry/telemetrytest replace go.opentelemetry.io/collector/internal/testutil => ../../internal/testutil + +replace go.opentelemetry.io/collector/internal/componentalias => ../../internal/componentalias diff --git a/service/internal/builders/builders.go b/service/internal/builders/builders.go index 4e332b3012a0..fd773d7b3b0d 100644 --- a/service/internal/builders/builders.go +++ b/service/internal/builders/builders.go @@ -5,10 +5,12 @@ package builders // import "go.opentelemetry.io/collector/service/internal/build import ( "errors" + "fmt" "go.uber.org/zap" "go.opentelemetry.io/collector/component" + "go.opentelemetry.io/collector/internal/componentalias" ) var ( @@ -26,3 +28,15 @@ func logStabilityLevel(logger *zap.Logger, sl component.StabilityLevel) { logger.Info(sl.LogMessage()) } } + +// logDeprecatedTypeAlias checks if the provided type is a deprecated alias and logs a warning if so. +func logDeprecatedTypeAlias(logger *zap.Logger, factory component.Factory, usedType component.Type) { + tah, ok := factory.(componentalias.TypeAliasHolder) + if !ok { + return + } + alias := tah.DeprecatedAlias() + if alias.String() != "" && usedType == alias { + logger.Warn(fmt.Sprintf("%q alias is deprecated; use %q instead", alias.String(), factory.Type().String())) + } +} diff --git a/service/internal/builders/builders_test.go b/service/internal/builders/builders_test.go new file mode 100644 index 000000000000..c158fd37e21b --- /dev/null +++ b/service/internal/builders/builders_test.go @@ -0,0 +1,128 @@ +// Copyright The OpenTelemetry Authors +// SPDX-License-Identifier: Apache-2.0 + +package builders + +import ( + "testing" + + "go.uber.org/zap" + "go.uber.org/zap/zaptest/observer" + + "go.opentelemetry.io/collector/component" + "go.opentelemetry.io/collector/internal/componentalias" +) + +// mockFactory is a test factory that implements component.Factory +type mockFactory struct { + factoryType component.Type +} + +func (m *mockFactory) Type() component.Type { + return m.factoryType +} + +func (m *mockFactory) CreateDefaultConfig() component.Config { + return nil +} + +// mockFactoryWithAlias is a test factory that implements both component.Factory and componentalias.TypeAliasHolder +type mockFactoryWithAlias struct { + factoryType component.Type + aliasHolder componentalias.TypeAliasHolder +} + +func (m *mockFactoryWithAlias) Type() component.Type { + return m.factoryType +} + +func (m *mockFactoryWithAlias) CreateDefaultConfig() component.Config { + return nil +} + +func (m *mockFactoryWithAlias) DeprecatedAlias() component.Type { + return m.aliasHolder.DeprecatedAlias() +} + +func (m *mockFactoryWithAlias) SetDeprecatedAlias(alias component.Type) { + m.aliasHolder.SetDeprecatedAlias(alias) +} + +func TestLogDeprecatedTypeAlias(t *testing.T) { + tests := []struct { + name string + factory component.Factory + usedType component.Type + expectWarning bool + }{ + { + name: "no_alias_holder", + factory: &mockFactory{factoryType: component.MustNewType("test")}, + usedType: component.MustNewType("test"), + expectWarning: false, + }, + { + name: "no_alias_set", + factory: &mockFactoryWithAlias{ + factoryType: component.MustNewType("test"), + aliasHolder: componentalias.NewTypeAliasHolder(), + }, + usedType: component.MustNewType("test"), + expectWarning: false, + }, + { + name: "using_current_type", + factory: func() component.Factory { + f := &mockFactoryWithAlias{ + factoryType: component.MustNewType("new"), + aliasHolder: componentalias.NewTypeAliasHolder(), + } + f.aliasHolder.SetDeprecatedAlias(component.MustNewType("old")) + return f + }(), + usedType: component.MustNewType("new"), + expectWarning: false, + }, + { + name: "using_deprecated_alias", + factory: func() component.Factory { + f := &mockFactoryWithAlias{ + factoryType: component.MustNewType("new"), + aliasHolder: componentalias.NewTypeAliasHolder(), + } + f.aliasHolder.SetDeprecatedAlias(component.MustNewType("old")) + return f + }(), + usedType: component.MustNewType("old"), + expectWarning: true, + }, + { + name: "using_unrelated_type", + factory: func() component.Factory { + f := &mockFactoryWithAlias{ + factoryType: component.MustNewType("new"), + aliasHolder: componentalias.NewTypeAliasHolder(), + } + f.aliasHolder.SetDeprecatedAlias(component.MustNewType("old")) + return f + }(), + usedType: component.MustNewType("other"), + expectWarning: false, + }, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + core, logs := observer.New(zap.WarnLevel) + logger := zap.New(core) + + logDeprecatedTypeAlias(logger, tt.factory, tt.usedType) + + if tt.expectWarning && logs.Len() != 1 { + t.Errorf("expected 1 warning log but got %d", logs.Len()) + } else if !tt.expectWarning && logs.Len() > 0 { + t.Errorf("expected no warning log but got %d", logs.Len()) + } + }) + } +} diff --git a/service/internal/builders/connector.go b/service/internal/builders/connector.go index dffc3bb0f653..27519be1fd84 100644 --- a/service/internal/builders/connector.go +++ b/service/internal/builders/connector.go @@ -47,6 +47,7 @@ func (b *ConnectorBuilder) CreateTracesToTraces(ctx context.Context, set connect return nil, fmt.Errorf("connector factory not available for: %q", set.ID) } + logDeprecatedTypeAlias(set.Logger, f, set.ID.Type()) logStabilityLevel(set.Logger, f.TracesToTracesStability()) return f.CreateTracesToTraces(ctx, set, cfg, next) } @@ -66,6 +67,7 @@ func (b *ConnectorBuilder) CreateTracesToMetrics(ctx context.Context, set connec return nil, fmt.Errorf("connector factory not available for: %q", set.ID) } + logDeprecatedTypeAlias(set.Logger, f, set.ID.Type()) logStabilityLevel(set.Logger, f.TracesToMetricsStability()) return f.CreateTracesToMetrics(ctx, set, cfg, next) } @@ -85,6 +87,7 @@ func (b *ConnectorBuilder) CreateTracesToLogs(ctx context.Context, set connector return nil, fmt.Errorf("connector factory not available for: %q", set.ID) } + logDeprecatedTypeAlias(set.Logger, f, set.ID.Type()) logStabilityLevel(set.Logger, f.TracesToLogsStability()) return f.CreateTracesToLogs(ctx, set, cfg, next) } @@ -109,6 +112,7 @@ func (b *ConnectorBuilder) CreateTracesToProfiles(ctx context.Context, set conne return nil, errDataTypes(set.ID, pipeline.SignalTraces, xpipeline.SignalProfiles) } + logDeprecatedTypeAlias(set.Logger, f, set.ID.Type()) logStabilityLevel(set.Logger, f.TracesToProfilesStability()) return f.CreateTracesToProfiles(ctx, set, cfg, next) } @@ -128,6 +132,7 @@ func (b *ConnectorBuilder) CreateMetricsToTraces(ctx context.Context, set connec return nil, fmt.Errorf("connector factory not available for: %q", set.ID) } + logDeprecatedTypeAlias(set.Logger, f, set.ID.Type()) logStabilityLevel(set.Logger, f.MetricsToTracesStability()) return f.CreateMetricsToTraces(ctx, set, cfg, next) } @@ -147,6 +152,7 @@ func (b *ConnectorBuilder) CreateMetricsToMetrics(ctx context.Context, set conne return nil, fmt.Errorf("connector factory not available for: %q", set.ID) } + logDeprecatedTypeAlias(set.Logger, f, set.ID.Type()) logStabilityLevel(set.Logger, f.MetricsToMetricsStability()) return f.CreateMetricsToMetrics(ctx, set, cfg, next) } @@ -166,6 +172,7 @@ func (b *ConnectorBuilder) CreateMetricsToLogs(ctx context.Context, set connecto return nil, fmt.Errorf("connector factory not available for: %q", set.ID) } + logDeprecatedTypeAlias(set.Logger, f, set.ID.Type()) logStabilityLevel(set.Logger, f.MetricsToLogsStability()) return f.CreateMetricsToLogs(ctx, set, cfg, next) } @@ -190,6 +197,7 @@ func (b *ConnectorBuilder) CreateMetricsToProfiles(ctx context.Context, set conn return nil, errDataTypes(set.ID, pipeline.SignalMetrics, xpipeline.SignalProfiles) } + logDeprecatedTypeAlias(set.Logger, f, set.ID.Type()) logStabilityLevel(set.Logger, f.MetricsToProfilesStability()) return f.CreateMetricsToProfiles(ctx, set, cfg, next) } @@ -209,6 +217,7 @@ func (b *ConnectorBuilder) CreateLogsToTraces(ctx context.Context, set connector return nil, fmt.Errorf("connector factory not available for: %q", set.ID) } + logDeprecatedTypeAlias(set.Logger, f, set.ID.Type()) logStabilityLevel(set.Logger, f.LogsToTracesStability()) return f.CreateLogsToTraces(ctx, set, cfg, next) } @@ -228,6 +237,7 @@ func (b *ConnectorBuilder) CreateLogsToMetrics(ctx context.Context, set connecto return nil, fmt.Errorf("connector factory not available for: %q", set.ID) } + logDeprecatedTypeAlias(set.Logger, f, set.ID.Type()) logStabilityLevel(set.Logger, f.LogsToMetricsStability()) return f.CreateLogsToMetrics(ctx, set, cfg, next) } @@ -247,6 +257,7 @@ func (b *ConnectorBuilder) CreateLogsToLogs(ctx context.Context, set connector.S return nil, fmt.Errorf("connector factory not available for: %q", set.ID) } + logDeprecatedTypeAlias(set.Logger, f, set.ID.Type()) logStabilityLevel(set.Logger, f.LogsToLogsStability()) return f.CreateLogsToLogs(ctx, set, cfg, next) } @@ -271,6 +282,7 @@ func (b *ConnectorBuilder) CreateLogsToProfiles(ctx context.Context, set connect return nil, errDataTypes(set.ID, pipeline.SignalLogs, xpipeline.SignalProfiles) } + logDeprecatedTypeAlias(set.Logger, f, set.ID.Type()) logStabilityLevel(set.Logger, f.LogsToProfilesStability()) return f.CreateLogsToProfiles(ctx, set, cfg, next) } @@ -295,6 +307,7 @@ func (b *ConnectorBuilder) CreateProfilesToTraces(ctx context.Context, set conne return nil, errDataTypes(set.ID, xpipeline.SignalProfiles, pipeline.SignalTraces) } + logDeprecatedTypeAlias(set.Logger, f, set.ID.Type()) logStabilityLevel(set.Logger, f.ProfilesToTracesStability()) return f.CreateProfilesToTraces(ctx, set, cfg, next) } @@ -319,6 +332,7 @@ func (b *ConnectorBuilder) CreateProfilesToMetrics(ctx context.Context, set conn return nil, errDataTypes(set.ID, xpipeline.SignalProfiles, pipeline.SignalMetrics) } + logDeprecatedTypeAlias(set.Logger, f, set.ID.Type()) logStabilityLevel(set.Logger, f.ProfilesToMetricsStability()) return f.CreateProfilesToMetrics(ctx, set, cfg, next) } @@ -343,6 +357,7 @@ func (b *ConnectorBuilder) CreateProfilesToLogs(ctx context.Context, set connect return nil, errDataTypes(set.ID, xpipeline.SignalProfiles, pipeline.SignalLogs) } + logDeprecatedTypeAlias(set.Logger, f, set.ID.Type()) logStabilityLevel(set.Logger, f.ProfilesToLogsStability()) return f.CreateProfilesToLogs(ctx, set, cfg, next) } @@ -367,6 +382,7 @@ func (b *ConnectorBuilder) CreateProfilesToProfiles(ctx context.Context, set con return nil, errDataTypes(set.ID, xpipeline.SignalProfiles, xpipeline.SignalProfiles) } + logDeprecatedTypeAlias(set.Logger, f, set.ID.Type()) logStabilityLevel(set.Logger, f.ProfilesToProfilesStability()) return f.CreateProfilesToProfiles(ctx, set, cfg, next) } diff --git a/service/internal/builders/exporter.go b/service/internal/builders/exporter.go index bb2367d22b74..9520eb4eddb6 100644 --- a/service/internal/builders/exporter.go +++ b/service/internal/builders/exporter.go @@ -37,6 +37,7 @@ func (b *ExporterBuilder) CreateTraces(ctx context.Context, set exporter.Setting return nil, fmt.Errorf("exporter factory not available for: %q", set.ID) } + logDeprecatedTypeAlias(set.Logger, f, set.ID.Type()) logStabilityLevel(set.Logger, f.TracesStability()) return f.CreateTraces(ctx, set, cfg) } @@ -53,6 +54,7 @@ func (b *ExporterBuilder) CreateMetrics(ctx context.Context, set exporter.Settin return nil, fmt.Errorf("exporter factory not available for: %q", set.ID) } + logDeprecatedTypeAlias(set.Logger, f, set.ID.Type()) logStabilityLevel(set.Logger, f.MetricsStability()) return f.CreateMetrics(ctx, set, cfg) } @@ -69,6 +71,7 @@ func (b *ExporterBuilder) CreateLogs(ctx context.Context, set exporter.Settings) return nil, fmt.Errorf("exporter factory not available for: %q", set.ID) } + logDeprecatedTypeAlias(set.Logger, f, set.ID.Type()) logStabilityLevel(set.Logger, f.LogsStability()) return f.CreateLogs(ctx, set, cfg) } @@ -90,6 +93,7 @@ func (b *ExporterBuilder) CreateProfiles(ctx context.Context, set exporter.Setti return nil, pipeline.ErrSignalNotSupported } + logDeprecatedTypeAlias(set.Logger, f, set.ID.Type()) logStabilityLevel(set.Logger, f.ProfilesStability()) return f.CreateProfiles(ctx, set, cfg) } diff --git a/service/internal/builders/processor.go b/service/internal/builders/processor.go index 8e19bed3ea9a..023f41d17a5b 100644 --- a/service/internal/builders/processor.go +++ b/service/internal/builders/processor.go @@ -43,6 +43,7 @@ func (b *ProcessorBuilder) CreateTraces(ctx context.Context, set processor.Setti return nil, fmt.Errorf("processor factory not available for: %q", set.ID) } + logDeprecatedTypeAlias(set.Logger, f, set.ID.Type()) logStabilityLevel(set.Logger, f.TracesStability()) return f.CreateTraces(ctx, set, cfg, next) } @@ -62,6 +63,7 @@ func (b *ProcessorBuilder) CreateMetrics(ctx context.Context, set processor.Sett return nil, fmt.Errorf("processor factory not available for: %q", set.ID) } + logDeprecatedTypeAlias(set.Logger, f, set.ID.Type()) logStabilityLevel(set.Logger, f.MetricsStability()) return f.CreateMetrics(ctx, set, cfg, next) } @@ -81,6 +83,7 @@ func (b *ProcessorBuilder) CreateLogs(ctx context.Context, set processor.Setting return nil, fmt.Errorf("processor factory not available for: %q", set.ID) } + logDeprecatedTypeAlias(set.Logger, f, set.ID.Type()) logStabilityLevel(set.Logger, f.LogsStability()) return f.CreateLogs(ctx, set, cfg, next) } @@ -104,6 +107,7 @@ func (b *ProcessorBuilder) CreateProfiles(ctx context.Context, set processor.Set if !ok { return nil, pipeline.ErrSignalNotSupported } + logDeprecatedTypeAlias(set.Logger, f, set.ID.Type()) logStabilityLevel(set.Logger, f.ProfilesStability()) return f.CreateProfiles(ctx, set, cfg, next) } diff --git a/service/internal/builders/receiver.go b/service/internal/builders/receiver.go index 2568392622be..2277b1b4ca36 100644 --- a/service/internal/builders/receiver.go +++ b/service/internal/builders/receiver.go @@ -44,6 +44,7 @@ func (b *ReceiverBuilder) CreateTraces(ctx context.Context, set receiver.Setting return nil, fmt.Errorf("receiver factory not available for: %q", set.ID) } + logDeprecatedTypeAlias(set.Logger, f, set.ID.Type()) logStabilityLevel(set.Logger, f.TracesStability()) return f.CreateTraces(ctx, set, cfg, next) } @@ -63,6 +64,7 @@ func (b *ReceiverBuilder) CreateMetrics(ctx context.Context, set receiver.Settin return nil, fmt.Errorf("receiver factory not available for: %q", set.ID) } + logDeprecatedTypeAlias(set.Logger, f, set.ID.Type()) logStabilityLevel(set.Logger, f.MetricsStability()) return f.CreateMetrics(ctx, set, cfg, next) } @@ -82,6 +84,7 @@ func (b *ReceiverBuilder) CreateLogs(ctx context.Context, set receiver.Settings, return nil, fmt.Errorf("receiver factory not available for: %q", set.ID) } + logDeprecatedTypeAlias(set.Logger, f, set.ID.Type()) logStabilityLevel(set.Logger, f.LogsStability()) return f.CreateLogs(ctx, set, cfg, next) } @@ -106,6 +109,7 @@ func (b *ReceiverBuilder) CreateProfiles(ctx context.Context, set receiver.Setti return nil, pipeline.ErrSignalNotSupported } + logDeprecatedTypeAlias(set.Logger, f, set.ID.Type()) logStabilityLevel(set.Logger, f.ProfilesStability()) return f.CreateProfiles(ctx, set, cfg, next) } diff --git a/service/telemetry/telemetrytest/go.mod b/service/telemetry/telemetrytest/go.mod index a44b795e35d5..1697541be1ae 100644 --- a/service/telemetry/telemetrytest/go.mod +++ b/service/telemetry/telemetrytest/go.mod @@ -176,3 +176,5 @@ replace go.opentelemetry.io/collector/component/componenttest => ../../../compon replace go.opentelemetry.io/collector/component/componentstatus => ../../../component/componentstatus replace go.opentelemetry.io/collector/internal/testutil => ../../../internal/testutil + +replace go.opentelemetry.io/collector/internal/componentalias => ../../../internal/componentalias diff --git a/versions.yaml b/versions.yaml index 0883c7afaffd..6be7234f3fcd 100644 --- a/versions.yaml +++ b/versions.yaml @@ -34,6 +34,7 @@ module-sets: version: v0.143.0 modules: - go.opentelemetry.io/collector + - go.opentelemetry.io/collector/internal/componentalias - go.opentelemetry.io/collector/internal/memorylimiter - go.opentelemetry.io/collector/internal/fanoutconsumer - go.opentelemetry.io/collector/internal/sharedcomponent