Raven Client for Sentry

6.10.0 · maintenance · verified Fri Apr 10

Raven is the legacy Python client for Sentry, providing error and exception tracking for Python applications. It offers integrations for frameworks like Django and Flask, and supports general WSGI applications. The library is currently in maintenance mode, with new feature development and most bug fixes now occurring exclusively in the successor `sentry-sdk` library.

Warnings

breaking Raven is the legacy Sentry client and is largely deprecated in favor of `sentry-sdk`. New projects should use `sentry-sdk` for an improved experience and all new features. Migrating from `raven` to `sentry-sdk` involves significant API changes.
Fix: For new projects, use `pip install sentry-sdk` and follow its documentation. For existing Raven users, consult the official Sentry migration guide from Raven to `sentry-sdk`.
breaking The `raven.conf.load` function was removed, and binding transports via a scheme prefix on DSNs was deprecated in version 5.4.0. The `aiohttp` transport was also moved to a separate `raven-aiohttp` package.
Fix: Adjust configuration to use direct `Client` instantiation with DSN and explicitly configure transports if needed, using `raven-aiohttp` for aiohttp integration.
breaking The UDP transport was removed in version 5.3.0. Additionally, server configuration *must* now be specified with a DSN.
Fix: Ensure your Sentry DSN is correctly configured and avoid using UDP transport options. Use a DSN for all server configurations.
gotcha In Raven versions prior to 6.10.0, stackframes in some situations could be in inverse order, and `NaN` local variables might be sent as non-standard JSON, potentially causing issues with Sentry event processing.
Fix: Upgrade to Raven 6.10.0 or later to ensure correct stackframe order and proper handling of `NaN` local variables. If migrating to `sentry-sdk` is not an immediate option, ensure you are on the latest `raven` release.

Install

pip install raven Install Raven

Imports

Client
```
from raven import Client
```
captureException
```
client.captureException()
```
The `sentry_sdk` library uses a different API for capturing exceptions.

Quickstart

This quickstart demonstrates how to initialize the Raven client with a DSN and then capture an exception and a simple message. Replace the placeholder DSN with your actual Sentry DSN.

import os
from raven import Client

# Get your DSN from Sentry (e.g., from environment variables)
dsn = os.environ.get('SENTRY_DSN', 'https://examplePublicKey@o0.ingest.sentry.io/0')

# Initialize the Raven client
client = Client(dsn)

try:
    1 / 0
except ZeroDivisionError:
    client.captureException()
    print("Error captured by Raven (check your Sentry dashboard).")

client.captureMessage('This is a test message from Raven.')
print("Message captured by Raven.")

view raw JSON →