Set Up Logs
Structured logs allow you to send, view and query logs sent from your applications within Sentry.
With Sentry Structured Logs, you can send text based log information from your applications to Sentry. Once in Sentry, these logs can be viewed alongside relevant errors, searched by text-string, or searched using their individual attributes.
Logs for Python are supported in Sentry Python SDK version 2.28.0 and above.
pip install "sentry-sdk"
To enable logging, you need to initialize the SDK with the _experiments["enable_logs"] option set to True.
sentry_sdk.init(
dsn="https://examplePublicKey@o0.ingest.sentry.io/0",
_experiments={
"enable_logs": True,
},
)
Once the feature is enabled on the SDK and the SDK is initialized, you can send logs using the sentry_sdk.logger APIs.
The logger namespace exposes six methods that you can use to log messages at different log levels: trace, debug, info, warning, error, and fatal.
You can pass additional attributes directly to the logging functions. These properties will be sent to Sentry, and can be searched from within the Logs UI, and even added to the Logs views as a dedicated column.
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.warning('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")
Sentry automatically instruments Python loggers via its LoggingIntegration.
import sentry_sdk
import logging
sentry_sdk.init(
dsn="https://examplePublicKey@o0.ingest.sentry.io/0",
_experiments={
"enable_logs": True
}
)
# Your existing logging setup
my_logger = logging.getLogger(__name__)
my_logger.setLevel(logging.INFO)
my_value = 42
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)
By default, the logging integration sends INFO-level logs and higher to Sentry logs. You can set a different threshold via the LoggingIntegration's sentry_logs_level parameter. However, regardless of the sentry_logs_level setting, the SDK only sends logs if they are at or above the logger's level.
import sentry_sdk
import logging
from sentry_sdk.integrations.logging import LoggingIntegration
sentry_sdk.init(
dsn="https://examplePublicKey@o0.ingest.sentry.io/0",
_experiments={
"enable_logs": True
},
integrations=[
# Only send WARNING (and higher) logs to Sentry logs,
# even if the logger is set to a lower level.
LoggingIntegration(sentry_logs_level=logging.WARNING),
]
)
my_logger = logging.getLogger(__name__)
my_logger.setLevel(logging.INFO)
my_value = 42
my_logger.info('This will not be sent to Sentry logs, even though the logger is set to INFO. my_value=%s', my_value)
my_logger.warning('This will be sent to Sentry logs. my_value=%s', my_value)
my_logger.setLevel(logging.ERROR)
my_logger.warning('Now, this log message will not be sent to Sentry logs, since the logger is set to ERROR.')
The logging integration automatically monkeypatches a handler into all loggers except for the root logger. If you'd like to manually configure the handler, you can do that like so:
import sentry_sdk
from sentry_sdk.integrations.logging import SentryLogsHandler
from sentry_sdk.integrations.logging import LoggingIntegration
sentry_sdk.init(
dsn="...",
_experiments={
"enable_logs": True
},
integrations=[
LoggingIntegration(sentry_logs_level=None), # Do not monkeypatch the sentry handler
]
}
# Instead, configure the root logger to send INFO-level logs to Sentry
logging.basicConfig(level=logging.INFO, handlers=[SentryLogsHandler(level=logging.INFO)])
To filter logs, or update them before they are sent to Sentry, you can use the _experiments["before_send_log"] option.
import sentry_sdk
from sentry_sdk.types import Log, Hint
from typing import Optional
def before_log(log: Log, _hint: Hint) -> Optional[Log]:
# Filter out all info level logs
if log["severity_text"] == "info":
return None
return log
sentry_sdk.init(
dsn="https://examplePublicKey@o0.ingest.sentry.io/0",
_experiments={
"enable_logs": True,
"before_send_log": before_log,
},
)
The before_send_log function receives a log object, and should return the log object if you want it to be sent to Sentry, or None if you want to discard it.
The log dict has the following keys:
severity_text: (str- one oftrace,debug,info,warning,error,fatal) The log level.severity_number: (int) The log level as a number ranging from 1 to 24, as per the OpenTelemetry specification ofSeverityNumber.body: (str) The log message.attributes: (dict[str, str | bool | float | int]) Additional attributes to be sent with the log.time_unix_nano: (int) The timestamp of the log in nanoseconds since the Unix epoch.trace_id: (Optional[str]) The trace ID of the trace this log belongs to.
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) or suggesting an update ("yeah, this would be better").