microsoft / microsoft/component-detection
Standardize detector failure reporting and exception handling
@cobya is already working on this.
Since May 23, 2024.
- Dominant language
- C#
- Stars
- 553
- Forks
- 135
- Avg merge
- 20h 58m
- Merged PRs (30d)
- 6
Description
Across the various component detectors, there is a lack of standardized exception handling and error reporting via logger output. This leads to inconsistent user experience when detection for a specific ecosystem fails.
```[tasklist]
### Tasks
- [ ] Define a standard exception handling and log output practice across detectors
- [ ] Update all related exception handling
- [ ] Create a standard telemetry object which will be published on
- [ ] Docs updates for the new detector guidance
```
This change will be released with other breaking changes planned for Component Detection v5. See tracking issue TBD.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.