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

…and] to collector package (open-telemetry#6608)

* Instrument obsreport.Processor (open-telemetry#6607)

* Instrument obsreport.Processor

* add processor promchecker tests

* add chloggen

* run make genpdata and fix linter errors

* address review feedback and retest

* pass cfg into createOtelMetrics

* Update otelcol/moved.go

Co-authored-by: Alex Boten <alex@boten.ca>

* Update service/collector.go

Co-authored-by: Alex Boten <alex@boten.ca>

Co-authored-by: Moh Osman <59479562+moh-osman3@users.noreply.github.com>
Co-authored-by: Alex Boten <alex@boten.ca>

.chloggen/depcollector.yaml

@@ -0,0 +1,22 @@
+# 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 otelcol package"
+
+# One or more tracking issues or pull requests related to the change
+issues: [6608]
+
+subtext: |-
+  - Deprecate `service.Config` in favor of `otelcol.Config`.
+  - Deprecate `service.ConfigProvider` in favor of `otelcol.ConfigProvider`.
+  - Deprecate `service.NewConfigProvider` in favor of `otelcol.NewConfigProvider`.
+  - Deprecate `service.CollectorSettings` in favor of `otelcol.CollectorSettings`.
+  - Deprecate `service.Collector` in favor of `otelcol.Collector`.
+  - Deprecate `service.New` in favor of `otelcol.NewCollector`.
+  - Deprecate `service.State` in favor of `otelcol.State`.
+  - Deprecate `service.NewSvcHandler` in favor of `otelcol.NewSvcHandler`.
+  - Deprecate `service.NewCommand` in favor of `otelcol.NewCommand`.

service/collector_windows_test.go → otelcol/collector_windows_test.go

@@ -15,7 +15,7 @@
 //go:build windows
 // +build windows
 
-package service
+package otelcol
 
 import (
 	"os"

service/command_test.go → otelcol/command_test.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package service
+package otelcol
 
 import (
 	"path/filepath"
@@ -23,6 +23,9 @@ 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) {
@@ -42,7 +45,14 @@ 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})

service/config_provider_test.go → otelcol/config_provider_test.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package service
+package otelcol
 
 import (
 	"context"
@@ -31,6 +31,7 @@ import (
 	"go.opentelemetry.io/collector/confmap/provider/fileprovider"
 	"go.opentelemetry.io/collector/confmap/provider/yamlprovider"
 	"go.opentelemetry.io/collector/extension/extensiontest"
+	"go.opentelemetry.io/collector/service"
 	"go.opentelemetry.io/collector/service/telemetry"
 )
 
@@ -39,9 +40,9 @@ var configNop = &Config{
 	Processors: map[component.ID]component.Config{component.NewID("nop"): componenttest.NewNopProcessorFactory().CreateDefaultConfig()},
 	Exporters:  map[component.ID]component.Config{component.NewID("nop"): componenttest.NewNopExporterFactory().CreateDefaultConfig()},
 	Extensions: map[component.ID]component.Config{component.NewID("nop"): extensiontest.NewNopFactory().CreateDefaultConfig()},
-	Service: ConfigService{
+	Service: service.ConfigService{
 		Extensions: []component.ID{component.NewID("nop")},
-		Pipelines: map[component.ID]*ConfigServicePipeline{
+		Pipelines: map[component.ID]*service.ConfigServicePipeline{
 			component.NewID("traces"): {
 				Receivers:  []component.ID{component.NewID("nop")},
 				Processors: []component.ID{component.NewID("nop")},

otelcol/moved.go

@@ -0,0 +1,69 @@
+// 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 otelcol handles the command-line, configuration, and runs the
+// OpenTelemetry Collector.
+package otelcol // import "go.opentelemetry.io/collector/otelcol"
+
+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
+
+// NewCollector creates and returns a new instance of Collector.
+var NewCollector = service.New //nolint:staticcheck
+
+// CollectorSettings holds configuration for creating a new Collector.
+type CollectorSettings = service.CollectorSettings //nolint:staticcheck
+
+// 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
+
+// NewCommand constructs a new cobra.Command using the given CollectorSettings.
+var NewCommand = service.NewCommand //nolint:staticcheck
+
+// Config defines the configuration for the various elements of collector or agent.
+type Config = service.Config //nolint:staticcheck

otelcol/moved_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 otelcol // import "go.opentelemetry.io/collector/otelcol"
+
+import (
+	"go.opentelemetry.io/collector/service"
+)
+
+// NewSvcHandler constructs a new svc.Handler using the given CollectorSettings.
+var NewSvcHandler = service.NewSvcHandler //nolint:staticcheck

service/servicetest/configprovider.go → otelcol/otelcoltest/config.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package servicetest // import "go.opentelemetry.io/collector/service/servicetest"
+package otelcoltest // import "go.opentelemetry.io/collector/otelcol/otelcoltest"
 
 import (
 	"context"
@@ -24,13 +24,13 @@ import (
 	"go.opentelemetry.io/collector/confmap/provider/fileprovider"
 	"go.opentelemetry.io/collector/confmap/provider/httpprovider"
 	"go.opentelemetry.io/collector/confmap/provider/yamlprovider"
-	"go.opentelemetry.io/collector/service"
+	"go.opentelemetry.io/collector/otelcol"
 )
 
 // LoadConfig loads a config.Config  from file, and does NOT validate the configuration.
-func LoadConfig(fileName string, factories component.Factories) (*service.Config, error) {
+func LoadConfig(fileName string, factories component.Factories) (*otelcol.Config, error) {
 	// Read yaml config from file
-	provider, err := service.NewConfigProvider(service.ConfigProviderSettings{
+	provider, err := otelcol.NewConfigProvider(otelcol.ConfigProviderSettings{
 		ResolverSettings: confmap.ResolverSettings{
 			URIs:       []string{fileName},
 			Providers:  makeMapProvidersMap(fileprovider.New(), envprovider.New(), yamlprovider.New(), httpprovider.New()),
@@ -44,7 +44,7 @@ func LoadConfig(fileName string, factories component.Factories) (*service.Config
 }
 
 // LoadConfigAndValidate loads a config from the file, and validates the configuration.
-func LoadConfigAndValidate(fileName string, factories component.Factories) (*service.Config, error) {
+func LoadConfigAndValidate(fileName string, factories component.Factories) (*otelcol.Config, error) {
 	cfg, err := LoadConfig(fileName, factories)
 	if err != nil {
 		return nil, err

service/servicetest/configprovider_test.go → otelcol/otelcoltest/config_test.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package servicetest
+package otelcoltest
 
 import (
 	"path/filepath"

otelcol/testdata/otelcol-invalid.yaml

@@ -0,0 +1,18 @@
+receivers:
+  nop:
+
+processors:
+  nop:
+
+exporters:
+  nop:
+
+service:
+  telemetry:
+    metrics:
+      address: localhost:8888
+  pipelines:
+    traces:
+      receivers: [nop]
+      processors: [invalid]
+      exporters: [nop]

otelcol/testdata/otelcol-nop.yaml

@@ -0,0 +1,30 @@
+receivers:
+  nop:
+
+processors:
+  nop:
+
+exporters:
+  nop:
+
+extensions:
+  nop:
+
+service:
+  telemetry:
+    metrics:
+      address: localhost:8888
+  extensions: [nop]
+  pipelines:
+    traces:
+      receivers: [nop]
+      processors: [nop]
+      exporters: [nop]
+    metrics:
+      receivers: [nop]
+      processors: [nop]
+      exporters: [nop]
+    logs:
+      receivers: [nop]
+      processors: [nop]
+      exporters: [nop]

service/collector.go

@@ -34,12 +34,17 @@ import (
 )
 
 // State defines Collector's state.
+// Deprecated: [v0.67.0] use otelcol.State
 type State int
 
 const (
+	// Deprecated: [v0.67.0] use otelcol.StateStarting
 	StateStarting State = iota
+	// Deprecated: [v0.67.0] use otelcol.StateRunning
 	StateRunning
+	// Deprecated: [v0.67.0] use otelcol.StateClosing
 	StateClosing
+	// Deprecated: [v0.67.0] use otelcol.StateClosed
 	StateClosed
 )
 
@@ -69,6 +74,7 @@ func (s State) String() string {
 // - Users can call (*Collector).Shutdown anytime to shut down the collector.
 
 // Collector represents a server providing the OpenTelemetry Collector service.
+// Deprecated: [v0.67.0] use otelcol.Collector
 type Collector struct {
 	set CollectorSettings
 
@@ -86,6 +92,7 @@ type Collector struct {
 }
 
 // New creates and returns a new instance of Collector.
+// Deprecated: [v0.67.0] use otelcol.NewCollector
 func New(set CollectorSettings) (*Collector, error) {
 	if set.ConfigProvider == nil {
 		return nil, errors.New("invalid nil config provider")

service/collector_windows.go

@@ -40,6 +40,7 @@ type windowsService struct {
 }
 
 // NewSvcHandler constructs a new svc.Handler using the given CollectorSettings.
+// Deprecated: [v0.67.0] use otelcol.NewSvcHandler
 func NewSvcHandler(set CollectorSettings) svc.Handler {
 	return &windowsService{settings: set, flags: flags()}
 }

service/config.go

@@ -30,7 +30,7 @@ var (
 	errMissingServicePipelineExporters = errors.New("must have at least one exporter")
 )
 
-// Config defines the configuration for the various elements of collector or agent.
+// Deprecated: [v0.67.0] use otelcol.Config
 type Config struct {
 	// Receivers is a map of ComponentID to Receivers.
 	Receivers map[component.ID]component.Config

service/config_provider.go

@@ -37,6 +37,8 @@ import (
 //	cfgProvider.Watch() // wait for an event.
 //	// repeat Get/Watch cycle until it is time to shut down the Collector process.
 //	cfgProvider.Shutdown()
+//
+// Deprecated: [v0.67.0] use otelcol.ConfigProvider
 type ConfigProvider interface {
 	// Get returns the service configuration, or error otherwise.
 	//
@@ -66,6 +68,7 @@ type configProvider struct {
 }
 
 // ConfigProviderSettings are the settings to configure the behavior of the ConfigProvider.
+// Deprecated: [v0.67.0] use otelcol.ConfigProviderSettings
 type ConfigProviderSettings struct {
 	// ResolverSettings are the settings to configure the behavior of the confmap.Resolver.
 	ResolverSettings confmap.ResolverSettings
@@ -87,6 +90,7 @@ func newDefaultConfigProviderSettings(uris []string) ConfigProviderSettings {
 //   - Then applies all the confmap.Converter in the given order.
 //
 // * Then unmarshalls the confmap.Conf into the service Config.
+// Deprecated: [v0.67.0] use otelcol.NewConfigProvider
 func NewConfigProvider(set ConfigProviderSettings) (ConfigProvider, error) {
 	mr, err := confmap.NewResolver(set.ResolverSettings)
 	if err != nil {

service/servicetest/deprecated.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.
+
+package servicetest // import "go.opentelemetry.io/collector/service/servicetest"
+
+import (
+	"go.opentelemetry.io/collector/otelcol/otelcoltest"
+)
+
+// Deprecated: [v0.67.0] use otelcoltest.LoadConfig
+var LoadConfig = otelcoltest.LoadConfig
+
+// Deprecated: [v0.67.0] use otelcoltest.LoadConfigAndValidate
+var LoadConfigAndValidate = otelcoltest.LoadConfigAndValidate

service/settings.go

@@ -42,6 +42,7 @@ type settings struct {
 }
 
 // CollectorSettings holds configuration for creating a new Collector.
+// Deprecated: [v0.66.0] use otelcol.CollectorSettings.
 type CollectorSettings struct {
 	// Factories component factories.
 	Factories component.Factories