Move service.[Collector|NewSvcHandler|CollectorSettings|State|NewComm…

…and] to collector package

Signed-off-by: Bogdan Drutu <bogdandrutu@gmail.com>

.chloggen/depcollector.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: service
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Deprecate service.[Collector|NewSvcHandler|CollectorSettings|State|NewCommand] in favor of collector package"
+
+# One or more tracking issues or pull requests related to the change
+issues: [6608]

cmd/builder/internal/builder/templates/main.go.tmpl

@@ -6,8 +6,8 @@ package main
 import (
 	"log"
 
+	"go.opentelemetry.io/collector/collector"
 	"go.opentelemetry.io/collector/component"
-	"go.opentelemetry.io/collector/service"
 )
 
 func main() {
@@ -22,13 +22,13 @@ func main() {
 		Version:     "{{ .Distribution.Version }}",
 	}
 
-	if err := run(service.CollectorSettings{BuildInfo: info, Factories: factories}); err != nil {
+	if err := run(collector.Settings{BuildInfo: info, Factories: factories}); err != nil {
 		log.Fatal(err)
 	}
 }
 
-func runInteractive(params service.CollectorSettings) error {
-	cmd := service.NewCommand(params)
+func runInteractive(params collector.Settings) error {
+	cmd := collector.NewCommand(params)
 	if err := cmd.Execute(); err != nil {
 		log.Fatalf("collector server run finished with error: %v", err)
 	}

cmd/builder/internal/builder/templates/main_others.go.tmpl

@@ -5,8 +5,8 @@
 
 package main
 
-import "go.opentelemetry.io/collector/service"
+import "go.opentelemetry.io/collector/collector"
 
-func run(params service.CollectorSettings) error {
+func run(params collector.Settings) error {
 	return runInteractive(params)
 }

cmd/builder/internal/builder/templates/main_windows.go.tmpl

@@ -11,10 +11,10 @@ import (
 
 	"golang.org/x/sys/windows/svc"
 
-	"go.opentelemetry.io/collector/service"
+	"go.opentelemetry.io/collector/collector"
 )
 
-func run(params service.CollectorSettings) error {
+func run(params collector.Settings) error {
 	if useInteractiveMode, err := checkUseInteractiveMode(); err != nil {
 		return err
 	} else if useInteractiveMode {
@@ -40,9 +40,9 @@ func checkUseInteractiveMode() (bool, error) {
 	return isInteractiveSession, nil
 }
 
-func runService(params service.CollectorSettings) error {
+func runService(params collector.Settings) error {
 	// do not need to supply service name when startup is invoked through Service Control Manager directly
-	if err := svc.Run("", service.NewSvcHandler(params)); err != nil {
+	if err := svc.Run("", collector.NewSvcHandler(params)); err != nil {
 		return fmt.Errorf("failed to start collector server: %w", err)
 	}
 

collector/collector.go

@@ -0,0 +1,37 @@
+// Copyright The OpenTelemetry Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//       http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+// Package collector handles the command-line, configuration, and runs the
+// OpenTelemetry Collector.
+package collector // import "go.opentelemetry.io/collector/collector"
+
+import (
+	"go.opentelemetry.io/collector/service"
+)
+
+// State defines Collector's state.
+type State = service.State //nolint:staticcheck
+
+const (
+	StateStarting = service.StateStarting //nolint:staticcheck
+	StateRunning  = service.StateRunning  //nolint:staticcheck
+	StateClosing  = service.StateClosing  //nolint:staticcheck
+	StateClosed   = service.StateClosed   //nolint:staticcheck
+)
+
+// Collector represents a server providing the OpenTelemetry Collector service.
+type Collector = service.Collector //nolint:staticcheck
+
+// New creates and returns a new instance of Collector.
+var New = service.New //nolint:staticcheck

collector/collector_windows.go

@@ -0,0 +1,25 @@
+// Copyright The OpenTelemetry Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//       http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+//go:build windows
+// +build windows
+
+package collector // import "go.opentelemetry.io/collector/collector"
+
+import (
+	"go.opentelemetry.io/collector/service"
+)
+
+// NewSvcHandler constructs a new svc.Handler using the given CollectorSettings.
+var NewSvcHandler = service.NewSvcHandler //nolint:staticcheck

service/collector_windows_test.go → collector/collector_windows_test.go

@@ -15,7 +15,7 @@
 //go:build windows
 // +build windows
 
-package service
+package collector
 
 import (
 	"os"
@@ -38,7 +38,7 @@ func TestNewSvcHandler(t *testing.T) {
 	factories, err := componenttest.NopFactories()
 	require.NoError(t, err)
 
-	s := NewSvcHandler(CollectorSettings{BuildInfo: component.NewDefaultBuildInfo(), Factories: factories})
+	s := NewSvcHandler(Settings{BuildInfo: component.NewDefaultBuildInfo(), Factories: factories})
 
 	colDone := make(chan struct{})
 	requests := make(chan svc.ChangeRequest)

collector/command.go

@@ -0,0 +1,22 @@
+// Copyright The OpenTelemetry Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//       http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package collector // import "go.opentelemetry.io/collector/collector"
+
+import (
+	"go.opentelemetry.io/collector/service"
+)
+
+// NewCommand constructs a new cobra.Command using the given CollectorSettings.
+var NewCommand = service.NewCommand //nolint:staticcheck

service/command_test.go → collector/command_test.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package service
+package collector
 
 import (
 	"path/filepath"
@@ -23,28 +23,38 @@ import (
 
 	"go.opentelemetry.io/collector/component"
 	"go.opentelemetry.io/collector/component/componenttest"
+	"go.opentelemetry.io/collector/confmap"
+	"go.opentelemetry.io/collector/confmap/converter/expandconverter"
+	"go.opentelemetry.io/collector/confmap/provider/fileprovider"
 )
 
 func TestNewCommandVersion(t *testing.T) {
-	cmd := NewCommand(CollectorSettings{BuildInfo: component.BuildInfo{Version: "test_version"}})
+	cmd := NewCommand(Settings{BuildInfo: component.BuildInfo{Version: "test_version"}})
 	assert.Equal(t, "test_version", cmd.Version)
 }
 
 func TestNewCommandNoConfigURI(t *testing.T) {
 	factories, err := componenttest.NopFactories()
 	require.NoError(t, err)
 
-	cmd := NewCommand(CollectorSettings{Factories: factories})
+	cmd := NewCommand(Settings{Factories: factories})
 	require.Error(t, cmd.Execute())
 }
 
 func TestNewCommandInvalidComponent(t *testing.T) {
 	factories, err := componenttest.NopFactories()
 	require.NoError(t, err)
 
-	cfgProvider, err := NewConfigProvider(newDefaultConfigProviderSettings([]string{filepath.Join("testdata", "otelcol-invalid.yaml")}))
+	cfgProvider, err := NewConfigProvider(
+		ConfigProviderSettings{
+			ResolverSettings: confmap.ResolverSettings{
+				URIs:       []string{filepath.Join("testdata", "otelcol-invalid.yaml")},
+				Providers:  map[string]confmap.Provider{"file": fileprovider.New()},
+				Converters: []confmap.Converter{expandconverter.New()},
+			},
+		})
 	require.NoError(t, err)
 
-	cmd := NewCommand(CollectorSettings{Factories: factories, ConfigProvider: cfgProvider})
+	cmd := NewCommand(Settings{Factories: factories, ConfigProvider: cfgProvider})
 	require.Error(t, cmd.Execute())
 }

collector/config_provider.go

@@ -0,0 +1,42 @@
+// Copyright The OpenTelemetry Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//       http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package collector // import "go.opentelemetry.io/collector/collector"
+
+import (
+	"go.opentelemetry.io/collector/service"
+)
+
+// ConfigProvider provides the service configuration.
+//
+// The typical usage is the following:
+//
+//	cfgProvider.Get(...)
+//	cfgProvider.Watch() // wait for an event.
+//	cfgProvider.Get(...)
+//	cfgProvider.Watch() // wait for an event.
+//	// repeat Get/Watch cycle until it is time to shut down the Collector process.
+//	cfgProvider.Shutdown()
+type ConfigProvider = service.ConfigProvider //nolint:staticcheck
+
+// ConfigProviderSettings are the settings to configure the behavior of the ConfigProvider.
+type ConfigProviderSettings = service.ConfigProviderSettings //nolint:staticcheck
+
+// NewConfigProvider returns a new ConfigProvider that provides the service configuration:
+// * Initially it resolves the "configuration map":
+//   - Retrieve the confmap.Conf by merging all retrieved maps from the given `locations` in order.
+//   - Then applies all the confmap.Converter in the given order.
+//
+// * Then unmarshalls the confmap.Conf into the service Config.
+var NewConfigProvider = service.NewConfigProvider //nolint:staticcheck

collector/settings.go

@@ -0,0 +1,22 @@
+// Copyright The OpenTelemetry Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//       http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package collector // import "go.opentelemetry.io/collector/collector"
+
+import (
+	"go.opentelemetry.io/collector/service"
+)
+
+// Settings holds configuration for creating a new Collector.
+type Settings = service.CollectorSettings //nolint:staticcheck

service/collector.go

@@ -33,13 +33,17 @@ import (
 	"go.opentelemetry.io/collector/service/internal/grpclog"
 )
 
-// State defines Collector's state.
+// Deprecated: [v0.66.0] use collector.State
 type State int
 
 const (
+	// Deprecated: [v0.66.0] use collector.StateStarting
 	StateStarting State = iota
+	// Deprecated: [v0.66.0] use collector.StateRunning
 	StateRunning
+	// Deprecated: [v0.66.0] use collector.StateClosing
 	StateClosing
+	// Deprecated: [v0.66.0] use collector.StateClosed
 	StateClosed
 )
 
@@ -68,7 +72,7 @@ func (s State) String() string {
 // - Upon shutdown, pipelines are notified, then pipelines and extensions are shut down.
 // - Users can call (*Collector).Shutdown anytime to shut down the collector.
 
-// Collector represents a server providing the OpenTelemetry Collector service.
+// Deprecated: [v0.66.0] use collector.Collector
 type Collector struct {
 	set CollectorSettings
 

service/collector_windows.go

@@ -39,7 +39,7 @@ type windowsService struct {
 	flags    *flag.FlagSet
 }
 
-// NewSvcHandler constructs a new svc.Handler using the given CollectorSettings.
+// Deprecated: [v0.66.0] use collector.NewSvcHandler
 func NewSvcHandler(set CollectorSettings) svc.Handler {
 	return &windowsService{settings: set, flags: flags()}
 }