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.
End-user friendly description of the problem this fixes or functionality that this introduces.
Add the option of structured logging in JSON for better observability. You can turn this on by setting the LOG_JSON environment variable.
Give a summary of what the PR does, explaining any non-trivial design decisions.
Add an option to use LOG_JSON env var to switch the main logger to output JSON lines instead of plaintext. This will allow observability pipelines to cleanly read long errors as one event and extract
extra={...}
fields in a structured way.This is fairly vendor agnostic. Adding the LOG_JSON_LEVEL_KEY env var to rename
level
should be enough to work in AWS, Google Cloud, Splunk and Elastic Stack.This uses the python library json-logger to allow existing log statements to be unchanged.
Example
Alternatives
this doc shows how to do this in the plain Python SDK, but it requires changing all the log statements to something non-standard - not desirable.
Another multi-vendor o11y option would be OpenTelemetry, which might be a nice option at some point but seems like more of a commitment, whereas making existing logs structured is high-value for low-investment.
Recently we added the MonitoringListener class, it's possible these structured logs could remove the need for that more complicated solution.
Link of any specific issues this addresses.