[component] Move component status features to its own module

Makefile

@@ -258,6 +258,7 @@ check-contrib:
 	@$(MAKE) -C $(CONTRIB_PATH) for-all CMD="$(GOCMD) mod edit \
 		-replace go.opentelemetry.io/collector=$(CURDIR) \
 		-replace go.opentelemetry.io/collector/component=$(CURDIR)/component  \
+		-replace go.opentelemetry.io/collector/component/componentstatus=$(CURDIR)/component/componentstatus  \
 		-replace go.opentelemetry.io/collector/config/configauth=$(CURDIR)/config/configauth  \
 		-replace go.opentelemetry.io/collector/config/configcompression=$(CURDIR)/config/configcompression  \
 		-replace go.opentelemetry.io/collector/config/configgrpc=$(CURDIR)/config/configgrpc  \
@@ -319,6 +320,7 @@ restore-contrib:
 	@$(MAKE) -C $(CONTRIB_PATH) for-all CMD="$(GOCMD) mod edit \
 		-dropreplace go.opentelemetry.io/collector \
 		-dropreplace go.opentelemetry.io/collector/component \
+		-dropreplace go.opentelemetry.io/collector/component/componentstatus \
 		-dropreplace go.opentelemetry.io/collector/config/configauth  \
 		-dropreplace go.opentelemetry.io/collector/config/configcompression  \
 		-dropreplace go.opentelemetry.io/collector/config/configgrpc  \

cmd/builder/internal/builder/main_test.go

@@ -41,6 +41,7 @@ var (
 	replaceModules = []string{
 		"",
 		"/component",
+		"/component/componentstatus",
 		"/config/configauth",
 		"/config/configcompression",
 		"/config/configgrpc",

cmd/builder/test/core.builder.yaml

@@ -20,6 +20,7 @@ exporters:
 replaces:
   - go.opentelemetry.io/collector => ${WORKSPACE_DIR}
   - go.opentelemetry.io/collector/component => ${WORKSPACE_DIR}/component
+  - go.opentelemetry.io/collector/component/componentstatus => ${WORKSPACE_DIR}/component/componentstatus
   - go.opentelemetry.io/collector/config/configauth => ${WORKSPACE_DIR}/config/configauth
   - go.opentelemetry.io/collector/config/configcompression => ${WORKSPACE_DIR}/config/configcompression
   - go.opentelemetry.io/collector/config/configgrpc => ${WORKSPACE_DIR}/config/configgrpc

cmd/mdatagen/go.mod

@@ -100,3 +100,5 @@ replace go.opentelemetry.io/collector/internal/globalgates => ../../internal/glo
 replace go.opentelemetry.io/collector/consumer/consumerprofiles => ../../consumer/consumerprofiles
 
 replace go.opentelemetry.io/collector/consumer/consumertest => ../../consumer/consumertest
+
+replace go.opentelemetry.io/collector/component/componentstatus => ../../component/componentstatus

cmd/otelcorecol/builder-config.yaml

@@ -44,6 +44,7 @@ replaces:
   - go.opentelemetry.io/collector/internal/globalgates => ../../internal/globalgates
   - go.opentelemetry.io/collector/otelcol => ../../otelcol
   - go.opentelemetry.io/collector/component => ../../component
+  - go.opentelemetry.io/collector/component/componentstatus => ../../component/componentstatus
   - go.opentelemetry.io/collector/config/configauth => ../../config/configauth
   - go.opentelemetry.io/collector/config/configcompression => ../../config/configcompression
   - go.opentelemetry.io/collector/config/configgrpc => ../../config/configgrpc

cmd/otelcorecol/go.mod

@@ -81,6 +81,7 @@ require (
 	github.com/yusufpapurcu/wmi v1.2.4 // indirect
 	go.opencensus.io v0.24.0 // indirect
 	go.opentelemetry.io/collector v0.105.0 // indirect
+	go.opentelemetry.io/collector/component/componentstatus v0.105.0 // indirect
 	go.opentelemetry.io/collector/config/configauth v0.105.0 // indirect
 	go.opentelemetry.io/collector/config/configcompression v1.12.0 // indirect
 	go.opentelemetry.io/collector/config/configgrpc v0.105.0 // indirect
@@ -145,6 +146,8 @@ replace go.opentelemetry.io/collector/otelcol => ../../otelcol
 
 replace go.opentelemetry.io/collector/component => ../../component
 
+replace go.opentelemetry.io/collector/component/componentstatus => ../../component/componentstatus
+
 replace go.opentelemetry.io/collector/config/configauth => ../../config/configauth
 
 replace go.opentelemetry.io/collector/config/configcompression => ../../config/configcompression

component/component.go

@@ -189,10 +189,3 @@ type CreateDefaultConfigFunc func() Config
 func (f CreateDefaultConfigFunc) CreateDefaultConfig() Config {
 	return f()
 }
-
-// InstanceID uniquely identifies a component instance
-type InstanceID struct {
-	ID          ID
-	Kind        Kind
-	PipelineIDs map[ID]struct{}
-}

component/componentstatus/Makefile

@@ -0,0 +1 @@
+include ../../Makefile.Common

component/componentstatus/go.mod

@@ -0,0 +1,36 @@
+module go.opentelemetry.io/collector/component/componentstatus
+
+go 1.21.0
+
+toolchain go1.21.12
+
+require (
+	github.com/stretchr/testify v1.9.0
+	go.opentelemetry.io/collector/component v0.105.0
+)
+
+require (
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/gogo/protobuf v1.3.2 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	go.opentelemetry.io/collector/config/configtelemetry v0.105.0 // indirect
+	go.opentelemetry.io/collector/pdata v1.12.0 // indirect
+	go.opentelemetry.io/otel v1.28.0 // indirect
+	go.opentelemetry.io/otel/metric v1.28.0 // indirect
+	go.opentelemetry.io/otel/trace v1.28.0 // indirect
+	go.uber.org/multierr v1.11.0 // indirect
+	go.uber.org/zap v1.27.0 // indirect
+	golang.org/x/net v0.26.0 // indirect
+	golang.org/x/sys v0.21.0 // indirect
+	golang.org/x/text v0.16.0 // indirect
+	google.golang.org/genproto/googleapis/rpc v0.0.0-20240528184218-531527333157 // indirect
+	google.golang.org/grpc v1.65.0 // indirect
+	google.golang.org/protobuf v1.34.2 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+)
+
+replace go.opentelemetry.io/collector/pdata => ../../pdata
+
+replace go.opentelemetry.io/collector/config/configtelemetry => ../../config/configtelemetry
+
+replace go.opentelemetry.io/collector/component => ../

component/componentstatus/instance.go

@@ -0,0 +1,13 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package componentstatus // import "go.opentelemetry.io/collector/component/componentstatus"
+
+import "go.opentelemetry.io/collector/component"
+
+// InstanceID uniquely identifies a component instance
+type InstanceID struct {
+	ID          component.ID
+	Kind        component.Kind
+	PipelineIDs map[component.ID]struct{}
+}

component/status.go → component/componentstatus/status.go

@@ -1,12 +1,22 @@
 // Copyright The OpenTelemetry Authors
 // SPDX-License-Identifier: Apache-2.0
 
-package component // import "go.opentelemetry.io/collector/component"
+package componentstatus // import "go.opentelemetry.io/collector/component/componentstatus"
 
 import (
 	"time"
+
+	"go.opentelemetry.io/collector/component"
 )
 
+type Reporter interface {
+	// Report allows a component to report runtime changes in status. The service
+	// will automatically report status for a component during startup and shutdown. Components can
+	// use this method to report status after start and before shutdown. For more details about
+	// component status reporting see: https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/component-status.md
+	Report(*Event)
+}
+
 type Status int32
 
 // Enumeration of possible component statuses
@@ -50,59 +60,59 @@ func (s Status) String() string {
 	return "StatusNone"
 }
 
-// StatusEvent contains a status and timestamp, and can contain an error
-type StatusEvent struct {
+// Event contains a status and timestamp, and can contain an error
+type Event struct {
 	status    Status
 	err       error
 	timestamp time.Time
 }
 
-// Status returns the Status (enum) associated with the StatusEvent
-func (ev *StatusEvent) Status() Status {
+// Status returns the Status (enum) associated with the Event
+func (ev *Event) Status() Status {
 	return ev.status
 }
 
-// Err returns the error associated with the StatusEvent.
-func (ev *StatusEvent) Err() error {
+// Err returns the error associated with the Event.
+func (ev *Event) Err() error {
 	return ev.err
 }
 
-// Timestamp returns the timestamp associated with the StatusEvent
-func (ev *StatusEvent) Timestamp() time.Time {
+// Timestamp returns the timestamp associated with the Event
+func (ev *Event) Timestamp() time.Time {
 	return ev.timestamp
 }
 
-// NewStatusEvent creates and returns a StatusEvent with the specified status and sets the timestamp
+// NewStatusEvent creates and returns a Event with the specified status and sets the timestamp
 // time.Now(). To set an error on the event for an error status use one of the dedicated
 // constructors (e.g. NewRecoverableErrorEvent, NewPermanentErrorEvent, NewFatalErrorEvent)
-func NewStatusEvent(status Status) *StatusEvent {
-	return &StatusEvent{
+func NewStatusEvent(status Status) *Event {
+	return &Event{
 		status:    status,
 		timestamp: time.Now(),
 	}
 }
 
 // NewRecoverableErrorEvent wraps a transient error
-// passed as argument as a StatusEvent with a status StatusRecoverableError
+// passed as argument as a Event with a status StatusRecoverableError
 // and a timestamp set to time.Now().
-func NewRecoverableErrorEvent(err error) *StatusEvent {
+func NewRecoverableErrorEvent(err error) *Event {
 	ev := NewStatusEvent(StatusRecoverableError)
 	ev.err = err
 	return ev
 }
 
 // NewPermanentErrorEvent wraps an error requiring human intervention to fix
-// passed as argument as a StatusEvent with a status StatusPermanentError
+// passed as argument as a Event with a status StatusPermanentError
 // and a timestamp set to time.Now().
-func NewPermanentErrorEvent(err error) *StatusEvent {
+func NewPermanentErrorEvent(err error) *Event {
 	ev := NewStatusEvent(StatusPermanentError)
 	ev.err = err
 	return ev
 }
 
-// NewFatalErrorEvent wraps the fatal runtime error passed as argument as a StatusEvent
+// NewFatalErrorEvent wraps the fatal runtime error passed as argument as a Event
 // with a status StatusFatalError and a timestamp set to time.Now().
-func NewFatalErrorEvent(err error) *StatusEvent {
+func NewFatalErrorEvent(err error) *Event {
 	ev := NewStatusEvent(StatusFatalError)
 	ev.err = err
 	return ev
@@ -116,7 +126,7 @@ func NewFatalErrorEvent(err error) *StatusEvent {
 //  5. An instance is Stopped, but not all instances are Stopped, we must be in the process of Stopping the component.
 //  6. If any instance is in a Recoverable Error state, the component status is Recoverable Error.
 //  7. By process of elimination, the only remaining state is starting.
-func AggregateStatus[K comparable](eventMap map[K]*StatusEvent) Status {
+func AggregateStatus[K comparable](eventMap map[K]*Event) Status {
 	seen := make(map[Status]struct{})
 	for _, ev := range eventMap {
 		seen[ev.Status()] = struct{}{}
@@ -168,8 +178,8 @@ func StatusIsError(status Status) bool {
 //   - The timestamp is set to the latest timestamp of the events in the eventMap
 //   - For an error status, the event will have same error as the most current event of the same
 //     error type from the eventMap
-func AggregateStatusEvent[K comparable](eventMap map[K]*StatusEvent) *StatusEvent {
-	var lastEvent, lastMatchingEvent *StatusEvent
+func AggregateStatusEvent[K comparable](eventMap map[K]*Event) *Event {
+	var lastEvent, lastMatchingEvent *Event
 	aggregateStatus := AggregateStatus[K](eventMap)
 
 	for _, ev := range eventMap {
@@ -188,7 +198,7 @@ func AggregateStatusEvent[K comparable](eventMap map[K]*StatusEvent) *StatusEven
 	}
 
 	// the effective status requires a synthetic event
-	aggregateEvent := &StatusEvent{
+	aggregateEvent := &Event{
 		status:    aggregateStatus,
 		timestamp: lastEvent.timestamp,
 	}
@@ -198,3 +208,12 @@ func AggregateStatusEvent[K comparable](eventMap map[K]*StatusEvent) *StatusEven
 
 	return aggregateEvent
 }
+
+// ReportStatus is a helper function that handles checking if the component.Host has implemented Reporter.
+// If it has, the Event is reported. Otherwise, nothing happens.
+func ReportStatus(host component.Host, e *Event) {
+	statusReporter, ok := host.(Reporter)
+	if ok {
+		statusReporter.Report(e)
+	}
+}