Skip to content

simonkern/sentry-python

 
 

Repository files navigation

Bad software is everywhere, and we're tired of it. Sentry is on a mission to help developers write better software faster, so we can get back to enjoying technology. If you want to join us Check out our open positions

Official Sentry SDK for Python

Build Status PyPi page link -- version Discord

This is the official Python SDK for Sentry


Migrate From sentry-raven

The old raven-python client has entered maintenance mode and was moved here.

If you're using raven-python, we recommend you to migrate to this new SDK. You can find the benefits of migrating and how to do it in our migration guide.

Getting Started

Install

pip install --upgrade sentry-sdk

Configuration

import sentry_sdk

sentry_sdk.init(
    "https://12927b5f211046b575ee51fd8b1ac34f@o1.ingest.sentry.io/1",

    # Set traces_sample_rate to 1.0 to capture 100%
    # of transactions for performance monitoring.
    # We recommend adjusting this value in production.
    traces_sample_rate=1.0,
)

Usage

from sentry_sdk import capture_message
capture_message("Hello World")  # Will create an event in Sentry.

raise ValueError()  # Will also create an event in Sentry.

Integrations

Contributing to the SDK

Please refer to CONTRIBUTING.md.

Getting help/support

If you need help setting up or configuring the Python SDK (or anything else in the Sentry universe) please head over to the Sentry Community on Discord. There is a ton of great people in our Discord community ready to help you!

Versioning Policy

This project follows semver, with three additions:

  • Semver says that major version 0 can include breaking changes at any time. Still, it is common practice to assume that only 0.x releases (minor versions) can contain breaking changes while 0.x.y releases (patch versions) are used for backwards-compatible changes (bugfixes and features). This project also follows that practice.

  • All undocumented APIs are considered internal. They are not part of this contract.

  • Certain features (e.g. integrations) may be explicitly called out as "experimental" or "unstable" in the documentation. They come with their own versioning policy described in the documentation.

We recommend to pin your version requirements against 1.x.* or 1.x.y. Either one of the following is fine:

sentry-sdk>=1.0.0,<2.0.0
sentry-sdk==1.5.0

A major release N implies the previous release N-1 will no longer receive updates. We generally do not backport bugfixes to older versions unless they are security relevant. However, feel free to ask for backports of specific commits on the bugtracker.

Resources

  • Documentation
  • Forum
  • Discord
  • Stack Overflow
  • Twitter Follow

License

Licensed under the BSD license, see LICENSE

About

The official Python SDK for Sentry.io

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 99.6%
  • Other 0.4%