Remove reference to defaultcomponents in core and deprecate include_core flag

.github/workflows/build-and-test.yml

@@ -81,7 +81,7 @@ jobs:
           path: /home/runner/go/bin
           key: tools-${{ runner.os }}-${{ hashFiles('./internal/tools/go.mod', './cmd/mdatagen/go.mod', './cmd/mdatagen/*.go') }}
       - name: Lint
-        run: make -j5 checklicense misspell checkdoc goimpi golint
+        run: make -j5 checklicense misspell goimpi golint
       - name: Gen Metadata
         run: |
           make genmdata

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 ## 🛑 Breaking changes 🛑
 
+- Remove `defaultcomponents` from core (#4087). 
 - Move configcheck.ValidateConfigFromFactories as internal function in service package (#3876).
 
 ## v0.36.0 Beta

Makefile

@@ -28,7 +28,6 @@ BUILD_INFO=-ldflags "-X $(BUILD_INFO_IMPORT_PATH).Version=$(VERSION)"
 
 RUN_CONFIG?=examples/local/otel-config.yaml
 CONTRIB_PATH=$(CURDIR)/../opentelemetry-collector-contrib
-COMP_REL_PATH=service/defaultcomponents/defaults.go
 MOD_NAME=go.opentelemetry.io/collector
 
 GO_ACC=go-acc
@@ -399,11 +398,6 @@ certs:
 certs-dryrun:
 	@internal/buildscripts/gen-certs.sh -d
 
-# Verify existence of READMEs for components specified as default components in the collector.
-.PHONY: checkdoc
-checkdoc:
-	checkdoc --project-path $(CURDIR) --component-rel-path $(COMP_REL_PATH) --module-name $(MOD_NAME)
-
 # Construct new API state snapshots
 .PHONY: apidiff-build
 apidiff-build:

cmd/otelcol/main.go

@@ -21,13 +21,13 @@ import (
 	"log"
 
 	"go.opentelemetry.io/collector/component"
+	"go.opentelemetry.io/collector/internal/testcomponents"
 	"go.opentelemetry.io/collector/internal/version"
 	"go.opentelemetry.io/collector/service"
-	"go.opentelemetry.io/collector/service/defaultcomponents"
 )
 
 func main() {
-	factories, err := defaultcomponents.Components()
+	factories, err := testcomponents.DefaultComponents()
 	if err != nil {
 		log.Fatalf("failed to build default components: %v", err)
 	}

exporter/doc.go

@@ -18,5 +18,5 @@
 // interface and component.Exporter interface.
 //
 // To make the custom exporter part of the Collector build the factory must be added
-// to defaultcomponents.Components() function.
+// to testcomponents.DefaultComponents() function.
 package exporter

internal/testcomponents/example_factories.go

@@ -16,6 +16,15 @@ package testcomponents
 
 import (
 	"go.opentelemetry.io/collector/component"
+	"go.opentelemetry.io/collector/consumer/consumererror"
+	"go.opentelemetry.io/collector/exporter/loggingexporter"
+	"go.opentelemetry.io/collector/exporter/otlpexporter"
+	"go.opentelemetry.io/collector/exporter/otlphttpexporter"
+	"go.opentelemetry.io/collector/extension/ballastextension"
+	"go.opentelemetry.io/collector/extension/zpagesextension"
+	"go.opentelemetry.io/collector/processor/batchprocessor"
+	"go.opentelemetry.io/collector/processor/memorylimiterprocessor"
+	"go.opentelemetry.io/collector/receiver/otlpreceiver"
 )
 
 // ExampleComponents registers example factories. This is only used by tests.
@@ -39,3 +48,52 @@ func ExampleComponents() (
 
 	return
 }
+
+// DefaultComponents returns the default set of components used by the OpenTelemetry collector.
+func DefaultComponents() (
+	component.Factories,
+	error,
+) {
+	var errs []error
+
+	extensions, err := component.MakeExtensionFactoryMap(
+		zpagesextension.NewFactory(),
+		ballastextension.NewFactory(),
+	)
+	if err != nil {
+		errs = append(errs, err)
+	}
+
+	receivers, err := component.MakeReceiverFactoryMap(
+		otlpreceiver.NewFactory(),
+	)
+	if err != nil {
+		errs = append(errs, err)
+	}
+
+	exporters, err := component.MakeExporterFactoryMap(
+		loggingexporter.NewFactory(),
+		otlpexporter.NewFactory(),
+		otlphttpexporter.NewFactory(),
+	)
+	if err != nil {
+		errs = append(errs, err)
+	}
+
+	processors, err := component.MakeProcessorFactoryMap(
+		batchprocessor.NewFactory(),
+		memorylimiterprocessor.NewFactory(),
+	)
+	if err != nil {
+		errs = append(errs, err)
+	}
+
+	factories := component.Factories{
+		Extensions: extensions,
+		Receivers:  receivers,
+		Processors: processors,
+		Exporters:  exporters,
+	}
+
+	return factories, consumererror.Combine(errs)
+}

service/collector_test.go

@@ -36,14 +36,14 @@ import (
 	"go.opentelemetry.io/collector/component"
 	"go.opentelemetry.io/collector/config/configparser"
 	"go.opentelemetry.io/collector/config/configunmarshaler"
+	"go.opentelemetry.io/collector/internal/testcomponents"
 	"go.opentelemetry.io/collector/internal/testutil"
-	"go.opentelemetry.io/collector/service/defaultcomponents"
 	"go.opentelemetry.io/collector/service/internal/builder"
 	"go.opentelemetry.io/collector/service/parserprovider"
 )
 
 func TestCollector_Start(t *testing.T) {
-	factories, err := defaultcomponents.Components()
+	factories, err := testcomponents.DefaultComponents()
 	require.NoError(t, err)
 
 	loggingHookCalled := false
@@ -117,7 +117,7 @@ func TestCollector_ReportError(t *testing.T) {
 	collectorTelemetry = &mockColTelemetry{}
 	defer func() { collectorTelemetry = preservedAppTelemetry }()
 
-	factories, err := defaultcomponents.Components()
+	factories, err := testcomponents.DefaultComponents()
 	require.NoError(t, err)
 
 	col, err := New(CollectorSettings{BuildInfo: component.DefaultBuildInfo(), Factories: factories})
@@ -141,7 +141,7 @@ func TestCollector_ReportError(t *testing.T) {
 }
 
 func TestCollector_StartAsGoRoutine(t *testing.T) {
-	factories, err := defaultcomponents.Components()
+	factories, err := testcomponents.DefaultComponents()
 	require.NoError(t, err)
 
 	set := CollectorSettings{
@@ -279,7 +279,7 @@ func (epl *errParserLoader) Close(context.Context) error {
 }
 
 func TestCollector_reloadService(t *testing.T) {
-	factories, err := defaultcomponents.Components()
+	factories, err := testcomponents.DefaultComponents()
 	require.NoError(t, err)
 	ctx := context.Background()
 	sentinelError := errors.New("sentinel error")

service/collector_windows_test.go

@@ -26,13 +26,13 @@ import (
 	"golang.org/x/sys/windows/svc"
 
 	"go.opentelemetry.io/collector/component"
-	"go.opentelemetry.io/collector/service/defaultcomponents"
+	"go.opentelemetry.io/collector/internal/testcomponents"
 )
 
 func TestWindowsService_Execute(t *testing.T) {
 	os.Args = []string{"otelcol", "--config", "testdata/otelcol-config-minimal.yaml"}
 
-	factories, err := defaultcomponents.Components()
+	factories, err := testcomponents.DefaultComponents()
 	require.NoError(t, err)
 
 	s := NewWindowsService(CollectorSettings{BuildInfo: component.DefaultBuildInfo(), Factories: factories})

service/configcheck_test.go

@@ -22,19 +22,19 @@ import (
 
 	"go.opentelemetry.io/collector/component"
 	"go.opentelemetry.io/collector/config"
-	"go.opentelemetry.io/collector/service/defaultcomponents"
+	"go.opentelemetry.io/collector/internal/testcomponents"
 )
 
 func TestValidateConfigFromFactories_Success(t *testing.T) {
-	factories, err := defaultcomponents.Components()
+	factories, err := testcomponents.DefaultComponents()
 	require.NoError(t, err)
 
 	err = validateConfigFromFactories(factories)
 	require.NoError(t, err)
 }
 
 func TestValidateConfigFromFactories_Failure(t *testing.T) {
-	factories, err := defaultcomponents.Components()
+	factories, err := testcomponents.DefaultComponents()
 	require.NoError(t, err)
 
 	// Add a factory returning config not following pattern to force error.