From b0c68af4f30d9c302f911566c611dc54ab971dd8 Mon Sep 17 00:00:00 2001 From: Roger Coll Date: Tue, 10 Dec 2024 09:59:17 +0100 Subject: [PATCH 1/4] feat: include component id/type in start error --- service/internal/graph/graph.go | 10 ++++++---- service/internal/graph/lifecycle_test.go | 4 ++-- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/service/internal/graph/graph.go b/service/internal/graph/graph.go index 26754e8fc34..96d2ca1915d 100644 --- a/service/internal/graph/graph.go +++ b/service/internal/graph/graph.go @@ -428,7 +428,7 @@ func (g *Graph) StartAll(ctx context.Context, host *Host) error { zap.String("type", instanceID.Kind().String()), zap.String("id", instanceID.ComponentID().String()), ) - return compErr + return fmt.Errorf("failed to start %s %s: %w", instanceID.ComponentID().String(), strings.ToLower(instanceID.Kind().String()), compErr) } host.Reporter.ReportOKIfStarting(instanceID) @@ -603,9 +603,11 @@ func connectorStability(f connector.Factory, expType, recType pipeline.Signal) c return component.StabilityLevelUndefined } -var _ getExporters = (*HostWrapper)(nil) -var _ component.Host = (*HostWrapper)(nil) -var _ componentstatus.Reporter = (*HostWrapper)(nil) +var ( + _ getExporters = (*HostWrapper)(nil) + _ component.Host = (*HostWrapper)(nil) + _ componentstatus.Reporter = (*HostWrapper)(nil) +) type HostWrapper struct { *Host diff --git a/service/internal/graph/lifecycle_test.go b/service/internal/graph/lifecycle_test.go index 9fb91f5af6f..6356671c645 100644 --- a/service/internal/graph/lifecycle_test.go +++ b/service/internal/graph/lifecycle_test.go @@ -162,7 +162,7 @@ func TestGraphStartStopComponentError(t *testing.T) { F: r1, T: e1, }) - require.EqualError(t, pg.StartAll(context.Background(), &Host{Reporter: status.NewReporter(func(*componentstatus.InstanceID, *componentstatus.Event) {}, func(error) {})}), "foo") + require.ErrorIs(t, pg.StartAll(context.Background(), &Host{Reporter: status.NewReporter(func(*componentstatus.InstanceID, *componentstatus.Event) {}, func(error) {})}), r1.startErr) assert.EqualError(t, pg.ShutdownAll(context.Background(), statustest.NewNopStatusReporter()), "bar") } @@ -428,7 +428,7 @@ func TestStatusReportedOnStartupShutdown(t *testing.T) { } pg.componentGraph.SetEdge(simple.Edge{F: e0, T: e1}) - assert.Equal(t, tt.startupErr, pg.StartAll(context.Background(), &Host{Reporter: rep})) + assert.ErrorIs(t, pg.StartAll(context.Background(), &Host{Reporter: rep}), tt.startupErr) assert.Equal(t, tt.shutdownErr, pg.ShutdownAll(context.Background(), rep)) assertEqualStatuses(t, tt.expectedStatuses, actualStatuses) }) From ab91323ae1acd59c9112ddc7d9c556f6ca552f81 Mon Sep 17 00:00:00 2001 From: Roger Coll Date: Tue, 10 Dec 2024 10:01:05 +0100 Subject: [PATCH 2/4] chore: add changelog entry --- .chloggen/improve_start_component_error.yaml | 25 ++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 .chloggen/improve_start_component_error.yaml diff --git a/.chloggen/improve_start_component_error.yaml b/.chloggen/improve_start_component_error.yaml new file mode 100644 index 00000000000..7f85dec2637 --- /dev/null +++ b/.chloggen/improve_start_component_error.yaml @@ -0,0 +1,25 @@ +# Use this changelog template to create an entry for release notes. + +# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' +change_type: 'enhancement' + +# 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: include component id/type in start error + +# One or more tracking issues or pull requests related to the change +issues: [10426] + +# (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. +# Use pipe (|) for multiline entries. +subtext: + +# Optional: The change log or logs in which this entry should be included. +# e.g. '[user]' or '[user, api]' +# Include 'user' if the change is relevant to end users. +# Include 'api' if there is a change to a library API. +# Default: '[user]' +change_logs: [] From 6210b90d604adcf7fa140eca820c774cb8803dfa Mon Sep 17 00:00:00 2001 From: Roger Coll Date: Tue, 10 Dec 2024 10:20:45 +0100 Subject: [PATCH 3/4] fix: require linter error --- service/internal/graph/lifecycle_test.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/service/internal/graph/lifecycle_test.go b/service/internal/graph/lifecycle_test.go index 6356671c645..8c34b86393b 100644 --- a/service/internal/graph/lifecycle_test.go +++ b/service/internal/graph/lifecycle_test.go @@ -428,7 +428,7 @@ func TestStatusReportedOnStartupShutdown(t *testing.T) { } pg.componentGraph.SetEdge(simple.Edge{F: e0, T: e1}) - assert.ErrorIs(t, pg.StartAll(context.Background(), &Host{Reporter: rep}), tt.startupErr) + require.ErrorIs(t, pg.StartAll(context.Background(), &Host{Reporter: rep}), tt.startupErr) assert.Equal(t, tt.shutdownErr, pg.ShutdownAll(context.Background(), rep)) assertEqualStatuses(t, tt.expectedStatuses, actualStatuses) }) From 5248a245af6e47bf8b19d2fbe8970e4260b92dc6 Mon Sep 17 00:00:00 2001 From: Roger Coll Date: Tue, 10 Dec 2024 20:02:03 +0100 Subject: [PATCH 4/4] Update service/internal/graph/graph.go Co-authored-by: Bogdan Drutu --- service/internal/graph/graph.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/service/internal/graph/graph.go b/service/internal/graph/graph.go index 96d2ca1915d..e9e68a70437 100644 --- a/service/internal/graph/graph.go +++ b/service/internal/graph/graph.go @@ -428,7 +428,7 @@ func (g *Graph) StartAll(ctx context.Context, host *Host) error { zap.String("type", instanceID.Kind().String()), zap.String("id", instanceID.ComponentID().String()), ) - return fmt.Errorf("failed to start %s %s: %w", instanceID.ComponentID().String(), strings.ToLower(instanceID.Kind().String()), compErr) + return fmt.Errorf("failed to start %q %s: %w", instanceID.ComponentID().String(), strings.ToLower(instanceID.Kind().String()), compErr) } host.Reporter.ReportOKIfStarting(instanceID)