Repository files navigation

Welcome to the official Python SDK forSentry.

You need a Sentryaccount andproject.

Getting Sentry into your project is straightforward. Just run this command in your terminal:

pip install --upgrade sentry-sdk

Here's a quick configuration example to get Sentry up and running:

importsentry_sdksentry_sdk.init("https://12927b5f211046b575ee51fd8b1ac34f@o1.ingest.sentry.io/1",# Your DSN here# Set traces_sample_rate to 1.0 to capture 100%# of traces for performance monitoring.traces_sample_rate=1.0,)

With this configuration, Sentry will monitor for exceptions and performance issues.

To generate some events that will show up in Sentry, you can log messages or capture errors:

importsentry_sdksentry_sdk.init(...)# same as abovesentry_sdk.capture_message("Hello Sentry!")# You'll see this in your Sentry dashboard.raiseValueError("Oops, something went wrong!")# This will create an error event in Sentry.

For more details on advanced usage, integrations, and customization, check out the full documentation onhttps://docs.sentry.io.

Sentry integrates with a ton of popular Python libraries and frameworks, includingFastAPI,Django,Celery,OpenAI and many, many more. Check out thefull list of integrations to get the full picture.

If you're using the older1.x version of the SDK, now's the time to upgrade to2.x. It includes significant upgrades and new features. Check ourmigration guide for assistance.

Using the legacyraven-python client? It's now in maintenance mode, and we recommend migrating to the new SDK for an improved experience. Get all the details in ourmigration guide.

We'd love your help in improving the Sentry SDK! Whether it's fixing bugs, adding features, writing new integrations, or enhancing documentation, every contribution is valuable.

For details on how to contribute, please read ourcontribution guide and explore theopen issues.

If you encounter issues or need help setting up or configuring the SDK, don't hesitate to reach out to theSentry Community on Discord. There is a ton of great people there ready to help!

Here are all resources to help you make the most of Sentry:

• Documentation - Official documentation to get started.
• Discord - Join our Discord community.
• X/Twitter - Follow us on X (Twitter) for updates.
• Stack Overflow - Questions and answers related to Sentry.

The SDK is open-source and available under the MIT license. Check out theLICENSE file for more information.

Thanks to everyone who has helped improve the SDK!