Skip to content
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.

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

Improve logging of API failures #2245

Merged
merged 1 commit into from
Oct 1, 2024
Merged

Improve logging of API failures #2245

merged 1 commit into from
Oct 1, 2024

Conversation

legoktm
Copy link
Member

@legoktm legoktm commented Sep 30, 2024

Status

Ready for review

Description

Add more debug and error logging to make it easier to trace why things have failed.

Roughly, every failure branch should have an error-level log entry. In some cases where knowing additional context would be useful, a debug-level entry is also created with unredacted information.

Fixes #2206.

Test Plan

  • visual review, specifically that no sensitive-looking info should appear in error level logs.

Checklist

If these changes modify code paths involving cryptography, the opening of files in VMs or network (via the RPC service) traffic, Qubes testing in the staging environment is required. For fine tuning of the graphical user interface, testing in any environment in Qubes is required. Please check as applicable:

  • These changes should not need testing in Qubes

If these changes add or remove files other than client code, the AppArmor profile may need to be updated. Please check as applicable:

  • No update to the AppArmor profile is required for these changes

If these changes modify the database schema, you should include a database migration. Please check as applicable:

  • No database schema changes are needed

@legoktm legoktm requested a review from a team as a code owner September 30, 2024 16:30
Add more debug and error logging to make it easier to trace why things
have failed.

Roughly, every failure branch should have an error-level log entry. In
some cases where knowing additional context would be useful, a
debug-level entry is also created with unredacted information.

Fixes #2206.
Copy link
Member

@cfm cfm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice. And I quite like the guidelines you've articulated:

Roughly, every failure branch should have an error-level log entry. In some cases where knowing additional context would be useful, a debug-level entry is also created with unredacted information.

@cfm cfm added this pull request to the merge queue Oct 1, 2024
Merged via the queue into main with commit ac38fcc Oct 1, 2024
58 checks passed
@cfm cfm deleted the better-logs branch October 1, 2024 23:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Logging for download failures
2 participants