Add a bit more context to the debugging for failing signature verify #2926
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.
Description
Working with customers to debug signature verification and one issue found was it could be hard to locate debug messages which highlight specific failure cases.
Context
This is security code, so we need to be suitably vague when reporting errors while in production, however for those looking to enable debugging and troubleshoot issues it would be good to provide some consistent patterns to look for in logs.
Changes
Following existing log messages within the agent I have added a bit more context to the debug logging prefix making it easier to filter and locate in logs.
Testing
go test ./...
). Buildkite employees may check this if the pipeline has run automatically.go fmt ./...
)