structlog-sentry-logger 0.2.0

A logger that automagically wraps Structlog with Sentry integration (via `structlog-sentry`) with a set of multi-purpose pre-configured options.

Structlog-Sentry-Logger

A logger that automagically wraps Structlog with Sentry integration via structlog-sentry with a set of multi-purpose pre-configured options.

Benefits:

1. Makes logging as easy as using print statements, but prettier and less smelly!
2. Highly opinionated! There is literally nothing you are allowed to configure!
3. Structured logs in JSON format means they are ready to be ingested by many favorite log analysis tools!

Save your tears for what you do best: writing fancy computer mumbo jumbo to make the world a better place!

Usage

Out-of-the-box

At the top of your Python module, import and instantiate the logger:

from structlog_sentry_logger import logger
LOGGER = logger.get_logger()

Now anytime you want to print anything, don't. Instead do this:

LOGGER.info("Information that's useful for future me and others", extra_field="extra_value")

Sentry Integration

Export your Sentry DSN into a local .env file

   CI_ENVIRONMENT_SLUG=dev-local

SENTRY_DSN=YOUR_SENTRY_DSN
echo "SENTRY_DSN=${SENTRY_DSN}" > .env

Note: all the regular Python logging levels are supported.

{
    "event": "Information that's useful for future me and others",
    "extra_field": "extra_value",
    "level": "info",
    "logger": "<input>",
    "timestamp": "2020-09-25 17:21:26",
}

You can even incorporate custom messages in your exception handling:

import uuid

from structlog_sentry_logger import logger
LOGGER = logger.get_logger()

curr_user_logger = LOGGER.bind(uuid=uuid.uuid4().hex)  # LOGGER instance with bound UUID
try:
    curr_user_logger.warn("A dummy error for testing purposes is about to be thrown!")
    assert False
except AssertionError as err:
    err_msg = ("I threw an error on purpose for this example!\n"
               "Now throwing another that explicitly chains from that one!")
    curr_user_logger.exception(err_msg)
    raise RuntimeError(err_msg) from err

{
    "event": "A dummy error for testing purposes is about to be thrown!",
    "level": "warning",
    "logger": "<input>",
    "timestamp": "2020-09-25 17:19:02",
    "uuid": "68f595440e69478a97a26b002f9cbf44",
}
{
    "event": "I threw an error on purpose for this example!\nNow throwing another that explicitly chains from that one!",
    "exception": 'Traceback (most recent call last):\n  File "<input>", line 8, in <module>\nAssertionError',
    "level": "error",
    "logger": "<input>",
    "timestamp": "2020-09-25 17:19:02",
    "uuid": "68f595440e69478a97a26b002f9cbf44",
}
Traceback (most recent call last):
  File "<input>", line 8, in <module>
AssertionError
The above exception was the direct cause of the following exception:
Traceback (most recent call last):
  File "<input>", line 13, in <module>
RuntimeError: I threw an error on purpose for this example!
Now throwing another that explicitly chains from that one!

Output: Formatting & Storage

The default behavior is to stream JSON logs directly to the standard output stream like a proper 12 Factor App.

For local development, it often helps to prettify logging to stdout and save JSON logs to a .logs folder at the root of your project directory. To enable this behavior, set the following environment variable*:

CI_ENVIRONMENT_SLUG=dev-local

In doing so, with our previous exception handling example we would get:

Summary

That's it. Now no excuses. Get out there and program with pride knowing no one will laugh at you in production! For not logging properly, that is. You're on your own for that other observability stuff.

Further Reading

Structlog: Structured Logging for Python

Sentry: Monitor and fix crashes in realtime.

structlog-sentry: Provides the structlog SentryProcessor for Sentry integration.