Skip to content

Log the name of the component that failed to start #10426

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
yurishkuro opened this issue Jun 18, 2024 · 3 comments
Open

Log the name of the component that failed to start #10426

yurishkuro opened this issue Jun 18, 2024 · 3 comments
Labels
bug Something isn't working help wanted Good issue for contributors to OpenTelemetry Service to pick up

Comments

@yurishkuro
Copy link
Member

Describe the bug
I have a component (processor) that fails to start due to misconfiguration of the pipeline.

Steps to reproduce
A processor whose Start method returns an error.

What did you expect to see?
An error logged indicating which component failed.

What did you see instead?

Error: cannot start pipelines: <<my error message here>>
2024/06/17 22:11:03 cannot start pipelines: <<my error message here>>

What version did you use?
v0.102.1

Additional context
I am forced to enrich the error myself with the name of the component. I think instead that should be coming directly from the framework that initializes the pipeline.
@yurishkuro yurishkuro added the bug Something isn't working label Jun 18, 2024
@atoulme atoulme added the help wanted Good issue for contributors to OpenTelemetry Service to pick up label Jul 21, 2024
@terakoya76
Copy link
Contributor

This may have been resolved by #10440 ?

@rogercoll
Copy link
Contributor

#10440 did improve the component's error visibility but service's returned error does not contain the component ID yet:

2024-12-10T08:54:05.084+0100    error   graph/graph.go:426      Failed to start component       {"error": "start function error in processor", "type": "Processor", "id": "geoip"}
2024-12-10T08:54:05.084+0100    info    [email protected]/service.go:303 Starting shutdown...
2024-12-10T08:54:05.084+0100    info    extensions/extensions.go:66     Stopping extensions...
2024-12-10T08:54:05.084+0100    info    [email protected]/service.go:317 Shutdown complete.
Error: cannot start pipelines: start function error in processor
2024/12/10 08:54:05 collector server run finished with error: cannot start pipelines: start function error in processor

If telemetry logging level is set to fatal, there will be no way to tell which component produced the error:

Error: cannot start pipelines: start function error in processor
2024/12/10 09:02:25 collector server run finished with error: cannot start pipelines: start function error in processor

@rogercoll rogercoll mentioned this issue Dec 10, 2024
Merged
@rogercoll
Copy link
Contributor

Ongoing PR to fix this issue #11837

github-merge-queue bot pushed a commit that referenced this issue Mar 7, 2025
@rogercoll @bogdandrutu @evan-bradley
[service] Include component id/type in start error (#11837)
af659fa 
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description

Wraps the component ID and type into the component's start retuned
error. If `telemetry::logs::level` is < error (e.g fatal), the service
error message does not give information about which pipeline component
failed:

Current error message:
```
 $ otelcontribcol --config config.yaml
Error: cannot start pipelines: start function error
2024/12/10 10:07:25 collector server run finished with error: cannot start pipelines: start function error
```
 
 With these changes:
 
 ```
 $ otelcontribcol --config config.yaml
Error: cannot start pipelines: failed to start geoip processor: start
function error
2024/12/10 09:58:29 collector server run finished with error: cannot
start pipelines: failed to start geoip processor: start function error
```
 

<!-- Issue number if applicable -->
#### Link to tracking issue 

#10426

<!--Describe what testing was performed and which tests were added.-->
#### Testing

<!--Describe the documentation added.-->
#### Documentation

<!--Please delete paragraphs that you did not use before submitting.-->

---------

Co-authored-by: Bogdan Drutu <[email protected]>
Co-authored-by: Evan Bradley <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working help wanted Good issue for contributors to OpenTelemetry Service to pick up
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@atoulme @yurishkuro @terakoya76 @rogercoll