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

improves error messages for better error logging/troubleshooting #212

Conversation

tonytheleg
Copy link
Contributor

PR Template:

Describe your changes

The goal of this PR is to update any error messages/logs where the issue may not be clear what failed. That includes:

  • Methods that have multiple error checks -- each error returned now at least explains what failed
  • Methods that don't return errors but have error checks, errors are now logged to know what failed
  • Any instantiation that may call external packages where the error is clear but the reason its being called is not.

These should all loop back to a logger as it bubbles up, which will ensure any error logs can be easily correlated to some code logic hopefully and make troubleshooting easier

Ticket reference (if applicable)

For RHCLOUD-35835

Checklist

  • Are the agreed upon acceptance criteria fulfilled?

  • Was the 4-eye-principle applied? (async PR review, pairing, ensembling)

  • Do your changes have passing automated tests and sufficient observability?

  • Are the work steps you introduced repeatable by others, either through automation or documentation?

    • If automation is possible but not done due to other constraints, a ticket to the tech debt sprint is added
    • An SOP (Standard Operating Procedure) was created
  • The Changes were automatically built, tested, and - if needed, behind a feature flag - deployed to our production environment. (Please check this when the new deployment is done and you could verify it.)

  • Are the agreed upon coding/architectural practices applied?

  • Are security needs fullfilled? (e.g. no internal URL)

  • Is the corresponding Ticket in the right state? (should be on "review" now, put to done when this change made it to production)

  • For changes to the public API / code dependencies: Was the whole team (or a sufficient amount of ppl) able to review?

@tonytheleg tonytheleg force-pushed the RHCLOUD-35835-enhance-error-messages branch from 425fa23 to c5f8afe Compare October 30, 2024 19:35
Copy link
Contributor

@josejulio josejulio left a comment

Choose a reason for hiding this comment

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

lgtm

@tonytheleg tonytheleg merged commit 07b4018 into project-kessel:main Oct 30, 2024
9 checks passed
@tonytheleg tonytheleg deleted the RHCLOUD-35835-enhance-error-messages branch October 30, 2024 20:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants