Remove CommonSettings struct,

Make SvcSettings private

Signed-off-by: Patryk Matyjasek <[email protected]>

Author: pmatyjasek-sumo

cmd/otelcol/main.go

@@ -31,17 +31,13 @@ func main() {
 	if err != nil {
 		log.Fatalf("failed to build default components: %v", err)
 	}
-
-	commonSettings := service.CommonSettings{
-		BuildInfo: component.BuildInfo{
-			Command:     "otelcol",
-			Description: "OpenTelemetry Collector",
-			Version:     version.Version,
-		},
-		Factories: factories,
+	info := component.BuildInfo{
+		Command:     "otelcol",
+		Description: "OpenTelemetry Collector",
+		Version:     version.Version,
 	}
 
-	if err := run(service.AppSettings{CommonSettings: commonSettings}); err != nil {
+	if err := run(service.AppSettings{BuildInfo: info, Factories: factories}); err != nil {
 		log.Fatal(err)
 	}
 }

component/component.go

@@ -17,8 +17,9 @@ package component
 import (
 	"context"
 
-	"go.opentelemetry.io/collector/config"
 	"go.uber.org/zap"
+
+	"go.opentelemetry.io/collector/config"
 )
 
 // Component is either a receiver, exporter, processor or an extension.

service/application.go

@@ -81,19 +81,19 @@ type Application struct {
 
 // New creates and returns a new instance of Application.
 func New(set AppSettings) (*Application, error) {
-	if err := configcheck.ValidateConfigFromFactories(set.CommonSettings.Factories); err != nil {
+	if err := configcheck.ValidateConfigFromFactories(set.Factories); err != nil {
 		return nil, err
 	}
 
 	app := &Application{
-		info:         set.CommonSettings.BuildInfo,
-		factories:    set.CommonSettings.Factories,
+		info:         set.BuildInfo,
+		factories:    set.Factories,
 		stateChannel: make(chan State, Closed+1),
 	}
 
 	rootCmd := &cobra.Command{
-		Use:     set.CommonSettings.BuildInfo.Command,
-		Version: set.CommonSettings.BuildInfo.Version,
+		Use:     set.BuildInfo.Command,
+		Version: set.BuildInfo.Version,
 		RunE: func(cmd *cobra.Command, args []string) error {
 			var err error
 			if app.logger, err = newLogger(set.LoggingOptions); err != nil {
@@ -220,13 +220,9 @@ func (app *Application) setupConfigurationComponents(ctx context.Context) error
 
 	app.logger.Info("Applying configuration...")
 
-	commonSettings := CommonSettings{
-		BuildInfo: app.info,
-		Factories: app.factories,
-	}
-
-	service, err := newService(&SvcSettings{
-		CommonSettings:    commonSettings,
+	service, err := newService(&svcSettings{
+		BuildInfo:         app.info,
+		Factories:         app.factories,
 		Config:            cfg,
 		Logger:            app.logger,
 		AsyncErrorChannel: app.asyncErrorChannel,

service/application_test.go

@@ -51,12 +51,11 @@ func TestApplication_Start(t *testing.T) {
 		return nil
 	}
 
-	commonSettings := CommonSettings{
-		BuildInfo: component.DefaultBuildInfo(),
-		Factories: factories,
-	}
-
-	app, err := New(AppSettings{CommonSettings: commonSettings, LoggingOptions: []zap.Option{zap.Hooks(hook)}})
+	app, err := New(AppSettings{
+		BuildInfo:      component.DefaultBuildInfo(),
+		Factories:      factories,
+		LoggingOptions: []zap.Option{zap.Hooks(hook)},
+	})
 	require.NoError(t, err)
 	assert.Equal(t, app.rootCmd, app.Command())
 
@@ -124,12 +123,7 @@ func TestApplication_ReportError(t *testing.T) {
 	factories, err := defaultcomponents.Components()
 	require.NoError(t, err)
 
-	commonSettings := CommonSettings{
-		BuildInfo: component.DefaultBuildInfo(),
-		Factories: factories,
-	}
-
-	app, err := New(AppSettings{CommonSettings: commonSettings})
+	app, err := New(AppSettings{BuildInfo: component.DefaultBuildInfo(), Factories: factories})
 	require.NoError(t, err)
 
 	app.rootCmd.SetArgs([]string{"--config=testdata/otelcol-config-minimal.yaml"})
@@ -152,16 +146,12 @@ func TestApplication_StartAsGoRoutine(t *testing.T) {
 	factories, err := defaultcomponents.Components()
 	require.NoError(t, err)
 
-	commonSettings := CommonSettings{
-		BuildInfo: component.DefaultBuildInfo(),
-		Factories: factories,
-	}
-
-	params := AppSettings{
-		CommonSettings: commonSettings,
+	set := AppSettings{
+		BuildInfo:      component.DefaultBuildInfo(),
+		Factories:      factories,
 		ParserProvider: new(minimalParserLoader),
 	}
-	app, err := New(params)
+	app, err := New(set)
 	require.NoError(t, err)
 
 	appDone := make(chan struct{})

service/application_windows_test.go

@@ -34,11 +34,7 @@ func TestWindowsService_Execute(t *testing.T) {
 	factories, err := defaultcomponents.Components()
 	require.NoError(t, err)
 
-	componentSettings := component.ComponentSettings{
-		BuildInfo: component.DefaultBuildInfo(),
-	}
-
-	s := NewWindowsService(Settings{Factories: factories, ComponentSettings: componentSettings})
+	s := NewWindowsService(svcSettings{BuildInfo: component.DefaultBuildInfo(), Factories: factories})
 
 	appDone := make(chan struct{})
 	requests := make(chan svc.ChangeRequest)

service/service.go

@@ -40,10 +40,10 @@ type service struct {
 	builtExtensions builder.Extensions
 }
 
-func newService(set *SvcSettings) (*service, error) {
+func newService(set *svcSettings) (*service, error) {
 	srv := &service{
-		factories:         set.CommonSettings.Factories,
-		buildInfo:         set.CommonSettings.BuildInfo,
+		factories:         set.Factories,
+		buildInfo:         set.BuildInfo,
 		config:            set.Config,
 		logger:            set.Logger,
 		asyncErrorChannel: set.AsyncErrorChannel,

service/service_test.go

@@ -103,15 +103,12 @@ func createExampleService(t *testing.T) *service {
 	require.NoError(t, err)
 	cfg, err := configtest.LoadConfigFile(t, path.Join(".", "testdata", "otelcol-nop.yaml"), factories)
 	require.NoError(t, err)
-	commonSettings := CommonSettings{
+
+	srv, err := newService(&svcSettings{
 		BuildInfo: component.DefaultBuildInfo(),
 		Factories: factories,
-	}
-
-	srv, err := newService(&SvcSettings{
-		CommonSettings: commonSettings,
-		Logger:         zap.NewNop(),
-		Config:         cfg,
+		Logger:    zap.NewNop(),
+		Config:    cfg,
 	})
 	require.NoError(t, err)
 	return srv

service/settings.go

@@ -22,19 +22,13 @@ import (
 	"go.opentelemetry.io/collector/service/parserprovider"
 )
 
-// CommonSettings holds common settings for Service and Application
-type CommonSettings struct {
+// svcSettings holds configuration for building a new service.
+type svcSettings struct {
 	// Factories component factories.
 	Factories component.Factories
 
 	// BuildInfo provides application start information.
 	BuildInfo component.BuildInfo
-}
-
-// SvcSettings holds configuration for building a new service.
-type SvcSettings struct {
-	// CommonSettings contains Factories and BuildInfo
-	CommonSettings CommonSettings
 
 	// Config represents the configuration of the service.
 	Config *config.Config
@@ -48,8 +42,11 @@ type SvcSettings struct {
 
 // AppSettings holds configuration for creating a new Application.
 type AppSettings struct {
-	// CommonSettings contains Factories and BuildInfo
-	CommonSettings CommonSettings
+	// Factories component factories.
+	Factories component.Factories
+
+	// BuildInfo provides application start information.
+	BuildInfo component.BuildInfo
 
 	// ParserProvider provides the configuration's Parser.
 	// If it is not provided a default provider is used. The default provider loads the configuration

testbed/testbed/otelcol_runner.go

@@ -84,15 +84,12 @@ func (ipp *InProcessCollector) PrepareConfig(configStr string) (configCleanup fu
 }
 
 func (ipp *InProcessCollector) Start(args StartParams) error {
-	commonSettings := service.CommonSettings{
+	settings := service.AppSettings{
 		BuildInfo: component.BuildInfo{
 			Command: "otelcol",
 			Version: version.Version,
 		},
-		Factories: ipp.factories,
-	}
-	settings := service.AppSettings{
-		CommonSettings: commonSettings,
+		Factories:      ipp.factories,
 		ParserProvider: parserprovider.NewInMemory(strings.NewReader(ipp.configStr)),
 	}
 	var err error