Cleanup

.chloggen/automated-status-on-start.yaml

@@ -7,10 +7,10 @@ change_type: enhancement
 component: statusreporting
 
 # A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
-note: Automates status reporting when `Start` returns.
+note: Automates status reporting upon the completion of component.Start().
 
 # One or more tracking issues or pull requests related to the change
-issues: []
+issues: [7682]
 
 # (Optional) One or more lines of additional information to render under the primary note.
 # These lines will be padded with 2 spaces and then inserted directly into the document.

component/telemetry.go

@@ -31,8 +31,8 @@ type TelemetrySettingsBase struct {
 	Resource pcommon.Resource
 }
 
-// TelemetrySettings and servicetelemetry.Settings differ in the method signature for
-// ReportComponentStatus
+// TelemetrySettings and servicetelemetry.TelemetrySettings differ in their
+// mechanism for reporting component status.
 type TelemetrySettings struct {
 	*TelemetrySettingsBase
 

service/extensions/extensions.go

@@ -66,13 +66,22 @@ func (bes *Extensions) Shutdown(ctx context.Context) error {
 		extID := bes.extensionIDs[i]
 		instanceID := bes.instanceIDs[extID]
 		ext := bes.extMap[extID]
-		_ = bes.telemetry.Status.ReportComponentStatus(instanceID, component.NewStatusEvent(component.StatusStopping))
+		_ = bes.telemetry.Status.ReportComponentStatus(
+			instanceID,
+			component.NewStatusEvent(component.StatusStopping),
+		)
 		if err := ext.Shutdown(ctx); err != nil {
-			_ = bes.telemetry.Status.ReportComponentStatus(instanceID, component.NewPermanentErrorEvent(err))
+			_ = bes.telemetry.Status.ReportComponentStatus(
+				instanceID,
+				component.NewPermanentErrorEvent(err),
+			)
 			errs = multierr.Append(errs, err)
 			continue
 		}
-		_ = bes.telemetry.Status.ReportComponentStatus(instanceID, component.NewStatusEvent(component.StatusStopped))
+		_ = bes.telemetry.Status.ReportComponentStatus(
+			instanceID,
+			component.NewStatusEvent(component.StatusStopped),
+		)
 	}
 
 	return errs

service/internal/graph/graph.go

@@ -429,15 +429,24 @@ func (g *Graph) ShutdownAll(ctx context.Context) error {
 		}
 
 		instanceID := g.instanceIDs[node.ID()]
-		_ = g.telemetry.Status.ReportComponentStatus(instanceID, component.NewStatusEvent(component.StatusStopping))
+		_ = g.telemetry.Status.ReportComponentStatus(
+			instanceID,
+			component.NewStatusEvent(component.StatusStopping),
+		)
 
 		if compErr := comp.Shutdown(ctx); compErr != nil {
 			errs = multierr.Append(errs, compErr)
-			_ = g.telemetry.Status.ReportComponentStatus(instanceID, component.NewPermanentErrorEvent(compErr))
+			_ = g.telemetry.Status.ReportComponentStatus(
+				instanceID,
+				component.NewPermanentErrorEvent(compErr),
+			)
 			continue
 		}
 
-		_ = g.telemetry.Status.ReportComponentStatus(instanceID, component.NewStatusEvent(component.StatusStopped))
+		_ = g.telemetry.Status.ReportComponentStatus(
+			instanceID,
+			component.NewStatusEvent(component.StatusStopped),
+		)
 	}
 	return errs
 }

service/internal/servicetelemetry/telemetry_settings.go

@@ -8,9 +8,9 @@ import (
 	"go.opentelemetry.io/collector/service/internal/status"
 )
 
-// TelemetrySettings mirrors component.TelemetrySettings except for the method signature of
-// ReportComponentStatus. The service level TelemetrySettings is not bound a specific component, and
-// therefore takes a component.InstanceID as an argument.
+// TelemetrySettings mirrors component.TelemetrySettings except for the mechanism for reporting
+// status. Service-level status reporting has additional methods which can report status for
+// components by their InstanceID whereas the component versions are tied to a specific component.
 type TelemetrySettings struct {
 	*component.TelemetrySettingsBase
 	Status *status.Reporter

service/internal/status/status.go

@@ -100,7 +100,7 @@ type Reporter struct {
 	onStatusChange NotifyStatusFunc
 }
 
-// NewReporter a reporter that will invoke the NotifyStatusFunc when a component's status
+// NewReporter returns a reporter that will invoke the NotifyStatusFunc when a component's status
 // has changed.
 func NewReporter(onStatusChange NotifyStatusFunc) *Reporter {
 	return &Reporter{
@@ -148,6 +148,7 @@ func (r *Reporter) ReportComponentStatusIf(
 	return nil
 }
 
+// Note: a lock must be acquired before calling this method.
 func (r *Reporter) componentFSM(id *component.InstanceID) *fsm {
 	fsm, ok := r.fsmMap[id]
 	if !ok {