Sentry Structured Logging for Python

[AbhiPrasad]

Sentry is adding support for structured logs, so you can view and query your logs alongside your traces and errors—all in one place.

Note

To get early access to the Sentry logging product and to see how it works, see the announcement post.

To use the new Logging APIs to send application logs directly to Sentry, you'll have to upgrade to 2.25.1 of the Python SDK or higher.

pip install --upgrade sentry-sdk

Logging is gated by an experimental option, _experiments.enable_logs.

sentry_sdk.init(
    dsn=...,
    _experiments={
        "enable_logs": True,
    },
)

Then you can import and use methods from the logger namespace to send logs to Sentry.

from sentry_sdk import logger as sentry_logger

sentry_logger.trace('Starting database connection {database}', database="users");
sentry_logger.debug('Cache miss for user {user_id}', user_id=123);
sentry_logger.info('Updated global cache');
sentry_logger.warn('Rate limit reached for endpoint {endpoint}', endpoint='/api/results/' });
sentry_logger.error('Failed to process payment. Order: {order_id}. Amount: {amount}', order_id="or_2342", amount=99.99);
sentry_logger.fatal('Database {database} connection pool exhausted', database="users");

You can also configure the SDK to send logs via the Python logging standard library, using Sentry's LoggingIntegration.

import logging
from sentry_sdk.integrations.logging import LoggingIntegration

# Setup Sentry SDK to send log messages with a level of "info" or higher to Sentry.
sentry_sdk.init(
  dsn="...",
  _experiments={
      "enable_logs": True
  }
  integrations=[
    LoggingIntegration(sentry_logs_level=logging.INFO),
  ]
)

# Your existing logging setup
my_logger = logging.Logger("some-logger")

my_logger.debug('In this example debug events will not be sent to Sentry logs. my_value=%s', my_value)
my_logger.info('But info events will be sent to Sentry logs. my_value=%s', my_value)

To filter logs, or update them before they are sent to Sentry, you can use the _experiments.before_send_log option.

[antonpirker]

Just a note: this is yet experimental and right now is not optimized, so it will make a lot of http requests to Sentry at the moment. So please be careful and do not enable this in your production system yet! :-)

Edit: We added batching in 2.25.1 of the Python SDK, and have updated the instructions to reflect this. Please only use logging with Python SDK 2.25.1+

[AbhiPrasad]

We’ve released 2.26.0 of the Python SDK which contains some improvements around logging. We added a variety of new default attributes like server name and sdk name/version which should make debugging easier.

https://github.com/getsentry/sentry-python/releases/tag/2.26.0

Please upgrade and give it a try!