Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
Broker currently has pretty good diagnostics through tracing and error messages, and we’re working on user-facing diagnostics through broker fix. However, all these diagnostics are confusing to users if they see something like “failed to upload scan” sometime after startup, instead of a more specific “Broker couldn’t reach FOSSA” at startup.
In order to catch obvious network misconfiguration early, we should add preflight checks to broker run. Most likely this is using the work implemented for broker fix, but with less output to the user unless there is an issue.
Acceptance criteria
When broker run is executed and after config values are parsed, Broker runs preflight checks.
These checks:
Validate that Broker can reach FOSSA using POST requests.
Validate that Broker can reach at least one integration.
Output detailed diagnostics for users explaining issues discovered during preflight checks.
Testing plan
Risks
References
Checklist