sentry-sdk


Namesentry-sdk JSON
Version 1.31.0 PyPI version JSON
download
home_pagehttps://github.com/getsentry/sentry-python
SummaryPython client for Sentry (https://sentry.io)
upload_time2023-09-13 11:09:41
maintainer
docs_urlNone
authorSentry Team and Contributors
requires_python
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <p align="center">
  <a href="https://sentry.io/?utm_source=github&utm_medium=logo" target="_blank">
    <img src="https://sentry-brand.storage.googleapis.com/sentry-wordmark-dark-280x84.png" alt="Sentry" width="280" height="84">
  </a>
</p>

_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 [<kbd>**Check out our open positions**</kbd>](https://sentry.io/careers/)_

# Official Sentry SDK for Python

[![Build Status](https://github.com/getsentry/sentry-python/actions/workflows/ci.yml/badge.svg)](https://github.com/getsentry/sentry-python/actions/workflows/ci.yml)
[![PyPi page link -- version](https://img.shields.io/pypi/v/sentry-sdk.svg)](https://pypi.python.org/pypi/sentry-sdk)
[![Discord](https://img.shields.io/discord/621778831602221064)](https://discord.gg/cWnMQeA)

This is the official Python SDK for [Sentry](http://sentry.io/)

---

## Getting Started

### Install

```bash
pip install --upgrade sentry-sdk
```

### Configuration

```python
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

```python
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.
```

- To learn more about how to use the SDK [refer to our docs](https://docs.sentry.io/platforms/python/)
- Are you coming from raven-python? [Use this migration guide](https://docs.sentry.io/platforms/python/migration/)
- To learn about internals use the [API Reference](https://getsentry.github.io/sentry-python/)

## Integrations

(If you want to create a new integration have a look at the [Adding a new integration checklist](CONTRIBUTING.md#adding-a-new-integration-checklist).)

- [Django](https://docs.sentry.io/platforms/python/guides/django/)
- [Flask](https://docs.sentry.io/platforms/python/guides/flask/)
- [Bottle](https://docs.sentry.io/platforms/python/guides/bottle/)
- [AWS Lambda](https://docs.sentry.io/platforms/python/guides/aws-lambda/)
- [Google Cloud Functions](https://docs.sentry.io/platforms/python/guides/gcp-functions/)
- [WSGI](https://docs.sentry.io/platforms/python/guides/wsgi/)
- [ASGI](https://docs.sentry.io/platforms/python/guides/asgi/)
- [Starlette](https://docs.sentry.io/platforms/python/guides/starlette/)
- [FastAPI](https://docs.sentry.io/platforms/python/guides/fastapi/)
- [AIOHTTP](https://docs.sentry.io/platforms/python/guides/aiohttp/)
- [RQ (Redis Queue)](https://docs.sentry.io/platforms/python/guides/rq/)
- [Celery](https://docs.sentry.io/platforms/python/guides/celery/)
- [Chalice](https://docs.sentry.io/platforms/python/guides/chalice/)
- [Falcon](https://docs.sentry.io/platforms/python/guides/falcon/)
- [Quart](https://docs.sentry.io/platforms/python/guides/quart/)
- [Sanic](https://docs.sentry.io/platforms/python/guides/sanic/)
- [Tornado](https://docs.sentry.io/platforms/python/guides/tornado/)
- [Tryton](https://docs.sentry.io/platforms/python/guides/tryton/)
- [Pyramid](https://docs.sentry.io/platforms/python/guides/pyramid/)
- [Logging](https://docs.sentry.io/platforms/python/guides/logging/)
- [Apache Airflow](https://docs.sentry.io/platforms/python/guides/airflow/)
- [Apache Beam](https://docs.sentry.io/platforms/python/guides/beam/)
- [Apache Spark](https://docs.sentry.io/platforms/python/guides/pyspark/)

## Migrate From sentry-raven

The old `raven-python` client has entered maintenance mode and was moved [here](https://github.com/getsentry/raven-python).

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](https://docs.sentry.io/platforms/python/migration/).

## Contributing to the SDK

Please refer to [CONTRIBUTING.md](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](https://discord.com/invite/Ww9hbqr). There is a ton of great people in our Discord community ready to help you!

## Resources

- [![Documentation](https://img.shields.io/badge/documentation-sentry.io-green.svg)](https://docs.sentry.io/quickstart/)
- [![Forum](https://img.shields.io/badge/forum-sentry-green.svg)](https://forum.sentry.io/c/sdks)
- [![Discord](https://img.shields.io/discord/621778831602221064)](https://discord.gg/Ww9hbqr)
- [![Stack Overflow](https://img.shields.io/badge/stack%20overflow-sentry-green.svg)](http://stackoverflow.com/questions/tagged/sentry)
- [![Twitter Follow](https://img.shields.io/twitter/follow/getsentry?label=getsentry&style=social)](https://twitter.com/intent/follow?screen_name=getsentry)

## License

Licensed under the MIT license, see [`LICENSE`](LICENSE)

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/getsentry/sentry-python",
    "name": "sentry-sdk",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "",
    "author": "Sentry Team and Contributors",
    "author_email": "hello@sentry.io",
    "download_url": "https://files.pythonhosted.org/packages/29/45/2c3558c8b47d8b763413c5bbaff68b8c9335e9fe8419a8bd85950aaaa3ec/sentry-sdk-1.31.0.tar.gz",
    "platform": null,
    "description": "<p align=\"center\">\n  <a href=\"https://sentry.io/?utm_source=github&utm_medium=logo\" target=\"_blank\">\n    <img src=\"https://sentry-brand.storage.googleapis.com/sentry-wordmark-dark-280x84.png\" alt=\"Sentry\" width=\"280\" height=\"84\">\n  </a>\n</p>\n\n_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 [<kbd>**Check out our open positions**</kbd>](https://sentry.io/careers/)_\n\n# Official Sentry SDK for Python\n\n[![Build Status](https://github.com/getsentry/sentry-python/actions/workflows/ci.yml/badge.svg)](https://github.com/getsentry/sentry-python/actions/workflows/ci.yml)\n[![PyPi page link -- version](https://img.shields.io/pypi/v/sentry-sdk.svg)](https://pypi.python.org/pypi/sentry-sdk)\n[![Discord](https://img.shields.io/discord/621778831602221064)](https://discord.gg/cWnMQeA)\n\nThis is the official Python SDK for [Sentry](http://sentry.io/)\n\n---\n\n## Getting Started\n\n### Install\n\n```bash\npip install --upgrade sentry-sdk\n```\n\n### Configuration\n\n```python\nimport sentry_sdk\n\nsentry_sdk.init(\n    \"https://12927b5f211046b575ee51fd8b1ac34f@o1.ingest.sentry.io/1\",\n\n    # Set traces_sample_rate to 1.0 to capture 100%\n    # of transactions for performance monitoring.\n    # We recommend adjusting this value in production.\n    traces_sample_rate=1.0,\n)\n```\n\n### Usage\n\n```python\nfrom sentry_sdk import capture_message\ncapture_message(\"Hello World\")  # Will create an event in Sentry.\n\nraise ValueError()  # Will also create an event in Sentry.\n```\n\n- To learn more about how to use the SDK [refer to our docs](https://docs.sentry.io/platforms/python/)\n- Are you coming from raven-python? [Use this migration guide](https://docs.sentry.io/platforms/python/migration/)\n- To learn about internals use the [API Reference](https://getsentry.github.io/sentry-python/)\n\n## Integrations\n\n(If you want to create a new integration have a look at the [Adding a new integration checklist](CONTRIBUTING.md#adding-a-new-integration-checklist).)\n\n- [Django](https://docs.sentry.io/platforms/python/guides/django/)\n- [Flask](https://docs.sentry.io/platforms/python/guides/flask/)\n- [Bottle](https://docs.sentry.io/platforms/python/guides/bottle/)\n- [AWS Lambda](https://docs.sentry.io/platforms/python/guides/aws-lambda/)\n- [Google Cloud Functions](https://docs.sentry.io/platforms/python/guides/gcp-functions/)\n- [WSGI](https://docs.sentry.io/platforms/python/guides/wsgi/)\n- [ASGI](https://docs.sentry.io/platforms/python/guides/asgi/)\n- [Starlette](https://docs.sentry.io/platforms/python/guides/starlette/)\n- [FastAPI](https://docs.sentry.io/platforms/python/guides/fastapi/)\n- [AIOHTTP](https://docs.sentry.io/platforms/python/guides/aiohttp/)\n- [RQ (Redis Queue)](https://docs.sentry.io/platforms/python/guides/rq/)\n- [Celery](https://docs.sentry.io/platforms/python/guides/celery/)\n- [Chalice](https://docs.sentry.io/platforms/python/guides/chalice/)\n- [Falcon](https://docs.sentry.io/platforms/python/guides/falcon/)\n- [Quart](https://docs.sentry.io/platforms/python/guides/quart/)\n- [Sanic](https://docs.sentry.io/platforms/python/guides/sanic/)\n- [Tornado](https://docs.sentry.io/platforms/python/guides/tornado/)\n- [Tryton](https://docs.sentry.io/platforms/python/guides/tryton/)\n- [Pyramid](https://docs.sentry.io/platforms/python/guides/pyramid/)\n- [Logging](https://docs.sentry.io/platforms/python/guides/logging/)\n- [Apache Airflow](https://docs.sentry.io/platforms/python/guides/airflow/)\n- [Apache Beam](https://docs.sentry.io/platforms/python/guides/beam/)\n- [Apache Spark](https://docs.sentry.io/platforms/python/guides/pyspark/)\n\n## Migrate From sentry-raven\n\nThe old `raven-python` client has entered maintenance mode and was moved [here](https://github.com/getsentry/raven-python).\n\nIf 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](https://docs.sentry.io/platforms/python/migration/).\n\n## Contributing to the SDK\n\nPlease refer to [CONTRIBUTING.md](CONTRIBUTING.md).\n\n## Getting help/support\n\nIf 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](https://discord.com/invite/Ww9hbqr). There is a ton of great people in our Discord community ready to help you!\n\n## Resources\n\n- [![Documentation](https://img.shields.io/badge/documentation-sentry.io-green.svg)](https://docs.sentry.io/quickstart/)\n- [![Forum](https://img.shields.io/badge/forum-sentry-green.svg)](https://forum.sentry.io/c/sdks)\n- [![Discord](https://img.shields.io/discord/621778831602221064)](https://discord.gg/Ww9hbqr)\n- [![Stack Overflow](https://img.shields.io/badge/stack%20overflow-sentry-green.svg)](http://stackoverflow.com/questions/tagged/sentry)\n- [![Twitter Follow](https://img.shields.io/twitter/follow/getsentry?label=getsentry&style=social)](https://twitter.com/intent/follow?screen_name=getsentry)\n\n## License\n\nLicensed under the MIT license, see [`LICENSE`](LICENSE)\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Python client for Sentry (https://sentry.io)",
    "version": "1.31.0",
    "project_urls": {
        "Changelog": "https://github.com/getsentry/sentry-python/blob/master/CHANGELOG.md",
        "Documentation": "https://docs.sentry.io/platforms/python/",
        "Homepage": "https://github.com/getsentry/sentry-python"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "623a765a7699a26884dcbf8b071dbe2a2486cc1cafcfb5f5d2e64ffe745dd0c6",
                "md5": "a8832083c7152ca1266994a355908f3f",
                "sha256": "64a7141005fb775b9db298a30de93e3b83e0ddd1232dc6f36eb38aebc1553291"
            },
            "downloads": -1,
            "filename": "sentry_sdk-1.31.0-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a8832083c7152ca1266994a355908f3f",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 224769,
            "upload_time": "2023-09-13T11:09:41",
            "upload_time_iso_8601": "2023-09-13T11:09:41.132448Z",
            "url": "https://files.pythonhosted.org/packages/62/3a/765a7699a26884dcbf8b071dbe2a2486cc1cafcfb5f5d2e64ffe745dd0c6/sentry_sdk-1.31.0-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "29452c3558c8b47d8b763413c5bbaff68b8c9335e9fe8419a8bd85950aaaa3ec",
                "md5": "6e69f337d76519bdbf4f0ac7928c58b5",
                "sha256": "6de2e88304873484207fed836388e422aeff000609b104c802749fd89d56ba5b"
            },
            "downloads": -1,
            "filename": "sentry-sdk-1.31.0.tar.gz",
            "has_sig": false,
            "md5_digest": "6e69f337d76519bdbf4f0ac7928c58b5",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 202711,
            "upload_time": "2023-09-13T11:09:41",
            "upload_time_iso_8601": "2023-09-13T11:09:41.131062Z",
            "url": "https://files.pythonhosted.org/packages/29/45/2c3558c8b47d8b763413c5bbaff68b8c9335e9fe8419a8bd85950aaaa3ec/sentry-sdk-1.31.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-09-13 11:09:41",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "getsentry",
    "github_project": "sentry-python",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "sentry-sdk"
}
        
Elapsed time: 0.17964s