feat: replace standard logging with structured logging #122
Conversation
| logger = logging.getLogger() | ||
| logger.setLevel(logging.INFO) | ||
| logging.getLogger('boto3').setLevel(logging.CRITICAL) | ||
| logging.getLogger('botocore').setLevel(logging.CRITICAL) |
There was a problem hiding this comment.
I found this guide with regards to working with the standard library, but I wasn't sure how I could make this applicable here. Otherwise, third party deps will continue using the standard logger unless someone can figure out if wrapping the logger is possible.
| # use structlog's production-ready, performant example config | ||
| # ref: https://www.structlog.org/en/stable/performance.html#example |
There was a problem hiding this comment.
Talking to this particular config, when I ran into the example in this document, it matched what I had in my head as a starting point. The company I work at have some opinions on things, though I wasn't going to impose them here.
| structlog.processors.add_log_level, | ||
| structlog.processors.format_exc_info, | ||
| structlog.processors.TimeStamper(fmt="iso", utc=True), | ||
| structlog.processors.EventRenamer("message"), |
There was a problem hiding this comment.
By default, this value is "event" though that term seems to be loaded since the Lambda accepts "events" and I thought that maybe message would be a good compromise. Though I am wary of long-term implications of this choice.
Either way, I don't have a strong opinion on whether it stays as this, we leave it as the default event, or we use a different name.
functions/replace-route/app.py
Outdated
| slogger.error("Unknown event", eventPayload=event) | ||
| return | ||
|
|
||
| if event.get("source") != "aws.events": | ||
| logger.error(f"Unable to handle unknown event type: {json.dumps(event)}") | ||
| slogger.error("Unable to handle unknown event type", eventPayload=json.dumps(event)) |
There was a problem hiding this comment.
As the diff indicates, this changed from a string interpolation to a key. As this comment alludes to, the term event is loaded.
I am inclined to drop this key and keep the string interpolation like I did everywhere else, or do a combination of both, or even leave that decision to another PR.
There was a problem hiding this comment.
I decided to preserve the string interpolation in a later commit and will leave changes to the log message contents themselves to a later PR.
therealvio
changed the title
This changes removes the addition of the eventPayload key that was imposed in the previous commit. I would rather leave the decision to the maintainers. Whether it be reverting *this* commit, or accepting this one, or leaving it to the future PR.
|
Thank you for the PR! I am a bit busy atm, but I hope to review & discuss in the coming days. Appreciate the patience! |
Purpose 🎯
These changes replace the standard library logging with structured logging using structlog. Structured logging provides easier-to-parse capabilities for toolings and humans when going through logs.
Context 🧠
bad events/all valid events, and right nowaws-alternatexercises a kind of "no news is good news" reporting.Notes 📓
structlogstructlog