Remove deprecated comonent.Config.[ID|SetIDName]; Deprecate config.*S…

…ettings (open-telemetry#6718)

* Remove deprecated comonent.Config.[ID|SetIDName]; Deprecate config.*Settings

Signed-off-by: Bogdan Drutu <[email protected]>

* Update .chloggen/rmcfgid-1.yaml

Co-authored-by: Pablo Baeyens <[email protected]>

Signed-off-by: Bogdan Drutu <[email protected]>
Co-authored-by: Pablo Baeyens <[email protected]>

.chloggen/rmcfgid-1.yaml

@@ -0,0 +1,11 @@
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: breaking
+
+# The name of the component, or a single word describing the area of concern, (e.g. otlpreceiver)
+component: config
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Remove deprecated `component.Config.[ID|SetIDName]`.
+
+# One or more tracking issues or pull requests related to the change
+issues: [4714]

.chloggen/rmcfgid-2.yaml

@@ -0,0 +1,11 @@
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: deprecation
+
+# The name of the component, or a single word describing the area of concern, (e.g. otlpreceiver)
+component: config
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Deprecate `config.[Extension|Exporter|Connector|Receiver|Processor]Settings`.
+
+# One or more tracking issues or pull requests related to the change
+issues: [6718]

component/componenttest/nop_component.go

@@ -22,3 +22,5 @@ type nopComponent struct {
 	component.StartFunc
 	component.ShutdownFunc
 }
+
+type nopConfig struct{}

component/componenttest/nop_exporter.go

@@ -18,7 +18,6 @@ import (
 	"context"
 
 	"go.opentelemetry.io/collector/component"
-	"go.opentelemetry.io/collector/config"
 	"go.opentelemetry.io/collector/consumer/consumertest"
 	"go.opentelemetry.io/collector/exporter"
 )
@@ -31,19 +30,11 @@ func NewNopExporterCreateSettings() exporter.CreateSettings {
 	}
 }
 
-type nopExporterConfig struct {
-	config.ExporterSettings `mapstructure:",squash"` // squash ensures fields are correctly decoded in embedded struct
-}
-
 // Deprecated: [v0.67.0] use exportertest.NewNopFactory.
 func NewNopExporterFactory() exporter.Factory {
 	return exporter.NewFactory(
 		"nop",
-		func() component.Config {
-			return &nopExporterConfig{
-				ExporterSettings: config.NewExporterSettings(component.NewID("nop")),
-			}
-		},
+		func() component.Config { return &nopConfig{} },
 		exporter.WithTraces(createTracesExporter, component.StabilityLevelStable),
 		exporter.WithMetrics(createMetricsExporter, component.StabilityLevelStable),
 		exporter.WithLogs(createLogsExporter, component.StabilityLevelStable),

component/componenttest/nop_extension.go

@@ -18,7 +18,6 @@ import (
 	"context"
 
 	"go.opentelemetry.io/collector/component"
-	"go.opentelemetry.io/collector/config"
 	"go.opentelemetry.io/collector/extension"
 )
 
@@ -30,18 +29,12 @@ func NewNopExtensionCreateSettings() extension.CreateSettings {
 	}
 }
 
-type nopExtensionConfig struct {
-	config.ExtensionSettings `mapstructure:",squash"` // squash ensures fields are correctly decoded in embedded struct
-}
-
 // Deprecated: [v0.67.0] use extensiontest.NewNopFactory.
 func NewNopExtensionFactory() extension.Factory {
 	return extension.NewFactory(
 		"nop",
 		func() component.Config {
-			return &nopExtensionConfig{
-				ExtensionSettings: config.NewExtensionSettings(component.NewID("nop")),
-			}
+			return &nopConfig{}
 		},
 		func(context.Context, component.ExtensionCreateSettings, component.Config) (component.Extension, error) {
 			return nopExtensionInstance, nil

component/componenttest/nop_processor.go

@@ -18,7 +18,6 @@ import (
 	"context"
 
 	"go.opentelemetry.io/collector/component"
-	"go.opentelemetry.io/collector/config"
 	"go.opentelemetry.io/collector/consumer"
 	"go.opentelemetry.io/collector/consumer/consumertest"
 	"go.opentelemetry.io/collector/processor"
@@ -32,19 +31,11 @@ func NewNopProcessorCreateSettings() processor.CreateSettings {
 	}
 }
 
-type nopProcessorConfig struct {
-	config.ProcessorSettings `mapstructure:",squash"` // squash ensures fields are correctly decoded in embedded struct
-}
-
 // Deprecated: [v0.68.0] use processortest.NewNopFactory.
 func NewNopProcessorFactory() processor.Factory {
 	return processor.NewFactory(
 		"nop",
-		func() component.Config {
-			return &nopProcessorConfig{
-				ProcessorSettings: config.NewProcessorSettings(component.NewID("nop")),
-			}
-		},
+		func() component.Config { return &nopConfig{} },
 		processor.WithTraces(createTracesProcessor, component.StabilityLevelStable),
 		processor.WithMetrics(createMetricsProcessor, component.StabilityLevelStable),
 		processor.WithLogs(createLogsProcessor, component.StabilityLevelStable),

component/componenttest/nop_receiver.go

@@ -18,7 +18,6 @@ import (
 	"context"
 
 	"go.opentelemetry.io/collector/component"
-	"go.opentelemetry.io/collector/config"
 	"go.opentelemetry.io/collector/consumer"
 	"go.opentelemetry.io/collector/receiver"
 )
@@ -31,19 +30,11 @@ func NewNopReceiverCreateSettings() receiver.CreateSettings {
 	}
 }
 
-type nopReceiverConfig struct {
-	config.ReceiverSettings `mapstructure:",squash"` // squash ensures fields are correctly decoded in embedded struct
-}
-
 // Deprecated: [v0.67.0] use receivertest.NewNopFactory
 func NewNopReceiverFactory() receiver.Factory {
 	return receiver.NewFactory(
 		"nop",
-		func() component.Config {
-			return &nopReceiverConfig{
-				ReceiverSettings: config.NewReceiverSettings(component.NewID("nop")),
-			}
-		},
+		func() component.Config { return &nopConfig{} },
 		receiver.WithTraces(createTraces, component.StabilityLevelStable),
 		receiver.WithMetrics(createMetrics, component.StabilityLevelStable),
 		receiver.WithLogs(createLogs, component.StabilityLevelStable))

component/config.go

@@ -29,15 +29,7 @@ import (
 // (e.g. check if a required field is present).
 //
 // A valid implementation MUST pass the check componenttest.CheckConfigStruct (return nil error).
-type Config interface {
-	// Deprecated: [v0.67.0] use Settings.ID.
-	ID() ID
-
-	// Deprecated: [v0.67.0] use Settings.ID.
-	SetIDName(idName string)
-
-	privateConfig()
-}
+type Config interface{}
 
 // As interface types are only used for static typing, a common idiom to find the reflection Type
 // for an interface type Foo is to use a *Foo value.

config/connector.go

@@ -18,17 +18,10 @@ import (
 	"go.opentelemetry.io/collector/component"
 )
 
-// ConnectorSettings defines common settings for a component.Connector configuration.
-// Specific connectors can embed this struct and extend it with more fields if needed.
-//
-// When embedded in the exporter config, it must be with `mapstructure:",squash"` tag.
-type ConnectorSettings struct {
-	settings
-}
+// Deprecated: [v0.68.0] will be removed soon, Config no longer requires to embed this.
+type ConnectorSettings struct{}
 
-// NewConnectorSettings return a new ConnectorSettings with the given ComponentID.
-func NewConnectorSettings(id component.ID) ConnectorSettings {
-	return ConnectorSettings{settings: newSettings(id)}
+// Deprecated: [v0.68.0] will be removed soon, Config no longer requires to embed this.
+func NewConnectorSettings(component.ID) ConnectorSettings {
+	return ConnectorSettings{}
 }
-
-var _ component.Config = (*ConnectorSettings)(nil)

config/exporter.go

@@ -18,17 +18,10 @@ import (
 	"go.opentelemetry.io/collector/component"
 )
 
-// ExporterSettings defines common settings for a component.Exporter configuration.
-// Specific exporters can embed this struct and extend it with more fields if needed.
-//
-// When embedded in the exporter config, it must be with `mapstructure:",squash"` tag.
-type ExporterSettings struct {
-	settings
-}
+// Deprecated: [v0.68.0] will be removed soon, Config no longer requires to embed this.
+type ExporterSettings struct{}
 
-// NewExporterSettings return a new ExporterSettings with the given ComponentID.
+// Deprecated: [v0.68.0] will be removed soon, Config no longer requires to embed this.
 func NewExporterSettings(id component.ID) ExporterSettings {
-	return ExporterSettings{settings: newSettings(id)}
+	return ExporterSettings{}
 }
-
-var _ component.Config = (*ExporterSettings)(nil)

config/extension.go

@@ -13,21 +13,16 @@
 // limitations under the License.
 
 package config // import "go.opentelemetry.io/collector/config"
+
 import (
 	"go.opentelemetry.io/collector/component"
 )
 
-// ExtensionSettings defines common settings for a component.Extension configuration.
-// Specific processors can embed this struct and extend it with more fields if needed.
-//
-// When embedded in the extension config, it must be with `mapstructure:",squash"` tag.
+// Deprecated: [v0.68.0] will be removed soon, Config no longer requires to embed this.
 type ExtensionSettings struct {
-	settings
 }
 
-// NewExtensionSettings return a new ExtensionSettings with the given ID.
-func NewExtensionSettings(id component.ID) ExtensionSettings {
-	return ExtensionSettings{settings: newSettings(id)}
+// Deprecated: [v0.68.0] will be removed soon, Config no longer requires to embed this.
+func NewExtensionSettings(component.ID) ExtensionSettings {
+	return ExtensionSettings{}
 }
-
-var _ component.Config = (*ExtensionSettings)(nil)

config/processor.go

@@ -13,21 +13,15 @@
 // limitations under the License.
 
 package config // import "go.opentelemetry.io/collector/config"
+
 import (
 	"go.opentelemetry.io/collector/component"
 )
 
-// ProcessorSettings defines common settings for a component.Processor configuration.
-// Specific processors can embed this struct and extend it with more fields if needed.
-//
-// When embedded in the processor config it must be with `mapstructure:",squash"` tag.
-type ProcessorSettings struct {
-	settings
-}
+// Deprecated: [v0.68.0] will be removed soon, Config no longer requires to embed this.
+type ProcessorSettings struct{}
 
-// NewProcessorSettings return a new ProcessorSettings with the given ComponentID.
-func NewProcessorSettings(id component.ID) ProcessorSettings {
-	return ProcessorSettings{settings: newSettings(id)}
+// Deprecated: [v0.68.0] will be removed soon, Config no longer requires to embed this.
+func NewProcessorSettings(component.ID) ProcessorSettings {
+	return ProcessorSettings{}
 }
-
-var _ component.Config = (*ProcessorSettings)(nil)

config/receiver.go

@@ -13,21 +13,15 @@
 // limitations under the License.
 
 package config // import "go.opentelemetry.io/collector/config"
+
 import (
 	"go.opentelemetry.io/collector/component"
 )
 
-// ReceiverSettings defines common settings for a receiver.Receiver configuration.
-// Specific receivers can embed this struct and extend it with more fields if needed.
-//
-// When embedded in the receiver config it must be with `mapstructure:",squash"` tag.
-type ReceiverSettings struct {
-	settings
-}
+// Deprecated: [v0.68.0] will be removed soon, Config no longer requires to embed this.
+type ReceiverSettings struct{}
 
-// NewReceiverSettings return a new ReceiverSettings with the given ID.
-func NewReceiverSettings(id component.ID) ReceiverSettings {
-	return ReceiverSettings{settings: newSettings(id)}
+// Deprecated: [v0.68.0] will be removed soon, Config no longer requires to embed this.
+func NewReceiverSettings(component.ID) ReceiverSettings {
+	return ReceiverSettings{}
 }
-
-var _ component.Config = (*ReceiverSettings)(nil)

connector/connector_test.go

@@ -21,13 +21,12 @@ import (
 	"github.com/stretchr/testify/assert"
 
 	"go.opentelemetry.io/collector/component"
-	"go.opentelemetry.io/collector/config"
 	"go.opentelemetry.io/collector/consumer"
 )
 
 func TestNewConnectorFactory_NoOptions(t *testing.T) {
 	const typeStr = "test"
-	defaultCfg := config.NewConnectorSettings(component.NewID(typeStr))
+	defaultCfg := struct{}{}
 	factory := NewFactory(typeStr, func() component.Config { return &defaultCfg })
 	assert.EqualValues(t, typeStr, factory.Type())
 	assert.EqualValues(t, &defaultCfg, factory.CreateDefaultConfig())
@@ -56,7 +55,7 @@ func TestNewConnectorFactory_NoOptions(t *testing.T) {
 
 func TestNewConnectorFactory_WithSameTypes(t *testing.T) {
 	const typeStr = "test"
-	defaultCfg := config.NewConnectorSettings(component.NewID(typeStr))
+	defaultCfg := struct{}{}
 	factory := NewFactory(typeStr, func() component.Config { return &defaultCfg },
 		WithTracesToTraces(createTracesToTraces, component.StabilityLevelAlpha),
 		WithMetricsToMetrics(createMetricsToMetrics, component.StabilityLevelBeta),
@@ -94,7 +93,7 @@ func TestNewConnectorFactory_WithSameTypes(t *testing.T) {
 
 func TestNewConnectorFactory_WithTranslateTypes(t *testing.T) {
 	const typeStr = "test"
-	defaultCfg := config.NewConnectorSettings(component.NewID(typeStr))
+	defaultCfg := struct{}{}
 	factory := NewFactory(typeStr, func() component.Config { return &defaultCfg },
 		WithTracesToMetrics(createTracesToMetrics, component.StabilityLevelDevelopment),
 		WithTracesToLogs(createTracesToLogs, component.StabilityLevelAlpha),
@@ -139,7 +138,7 @@ func TestNewConnectorFactory_WithTranslateTypes(t *testing.T) {
 
 func TestNewConnectorFactory_WithAllTypes(t *testing.T) {
 	const typeStr = "test"
-	defaultCfg := config.NewConnectorSettings(component.NewID(typeStr))
+	defaultCfg := struct{}{}
 	factory := NewFactory(typeStr, func() component.Config { return &defaultCfg },
 		WithTracesToTraces(createTracesToTraces, component.StabilityLevelAlpha),
 		WithTracesToMetrics(createTracesToMetrics, component.StabilityLevelDevelopment),