feat(logger): add support for exception notes

[leandrodamascena]

Issue number: #6441

Summary

This PR adds support for exception notes in the logger. When using logger.exception, any notes attached to exceptions will now be propagated and included in the log line under a new exception_notes key.

Exception notes provide additional context for errors, making debugging easier and logs more informative.

User experience

import requests

from aws_lambda_powertools import Logger
from aws_lambda_powertools.utilities.typing import LambdaContext

ENDPOINT = "http://httpbin.org/status/500"
logger = Logger(serialize_stacktrace=False)

try:
    ret = requests.get(ENDPOINT)
    ret.raise_for_status()
except requests.HTTPError as e:
    e.add_note("Can't connect to the endpoint")
    logger.exception(e)
    raise RuntimeError("Unable to fullfil request") from e

and the output:

{
    "level": "ERROR",
    "location": "collect.handler:15",
    "message": "Received a HTTP 5xx error",
    "timestamp": "2021-05-03 11:47:12,494+0000",
    "service": "payment",
    "exception_name": "RuntimeError",
    "exception": "Traceback (most recent call last):\n  File \"<input>\", line 2, in <module> RuntimeError: Unable to fullfil request",
    "exception_notes":[
       "Can't connect to the endpoint"
    ]
}

Checklist

If your change doesn't seem to apply, please leave them unchecked.

• Meet tenets criteria
• I have performed a self-review of this change
• Changes have been tested
• Changes are documented
• PR title follows conventional commit semantics

Is this a breaking change?

RFC issue number:

Checklist:

• Migration process documented
• Implement warnings (if it can live side by side)

Acknowledgment

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

[leandrodamascena]

Hey @anafalcao! Can you please review this?

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.33%. Comparing base (7482311) to head (5150288).
Report is 1 commits behind head on develop.

Additional details and impacted files

@@           Coverage Diff            @@
##           develop    #6465   +/-   ##
========================================
  Coverage    96.32%   96.33%           
========================================
  Files          243      243           
  Lines        11824    11826    +2     
  Branches       881      881           
========================================
+ Hits         11390    11392    +2     
  Misses         338      338           
  Partials        96       96           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[anafalcao]

Great PR! APPROVED 🚀