# Emmett-Sentry
Emmett-Sentry is an [Emmett framework](https://emmett.sh) extension integrating [Sentry](https://sentry.io) monitoring platform.
[](https://pypi.python.org/pypi/emmett-sentry)
## Installation
You can install Emmett-Sentry using pip:
pip install emmett-sentry
And add it to your Emmett application:
```python
from emmett_sentry import Sentry
sentry = app.use_extension(Sentry)
```
## Configuration
Here is the complete list of parameters of the extension configuration:
| param | default | description |
| --- | --- | --- |
| dsn | | Sentry project's DSN |
| environment | development | Application environment |
| release | | Application release |
| auto\_load | `True` | Automatically inject extension on routes |
| sample\_rate | 1 | Error sampling rate |
| integrations | | List of integrations to pass to the SDK |
| enable\_tracing | `False` | Enable tracing on routes |
| tracing\_sample\_rate | | Traces sampling rate |
| tracing\_exclude\_routes | | List of specific routes to exclude from tracing |
| trace\_websockets | `False` | Enable tracing on websocket routes |
| trace\_orm | `True` | Enable tracing on ORM queries |
| trace\_templates | `True` | Enable tracing on templates rendering |
| trace\_sessions | `True` | Enable tracing on sessions load/store |
| trace\_cache | `True` | Enable tracing on cache get/set |
| trace\_pipes | `False` | Enable tracing on pipes |
## Usage
The extension exposes two methods to manually track events:
- exception
- message
You call these methods directly within your code:
```python
# track an error
try:
1 / 0
except Exception:
sentry.exception()
# track a message
sentry.message("some event", level="info")
```
## License
Emmett-Sentry is released under BSD license.
Raw data
{
"_id": null,
"home_page": "https://github.com/emmett-framework/sentry",
"name": "emmett-sentry",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "sentry,logging,emmett",
"author": "Giovanni Barillari",
"author_email": "g@baro.dev",
"download_url": "https://files.pythonhosted.org/packages/64/80/c9f633358a3d3c9f5ff2e2b2303c05cd41fcb06fe7f52e057e708fb92370/emmett_sentry-0.6.1.tar.gz",
"platform": null,
"description": "# Emmett-Sentry\n\nEmmett-Sentry is an [Emmett framework](https://emmett.sh) extension integrating [Sentry](https://sentry.io) monitoring platform.\n\n[](https://pypi.python.org/pypi/emmett-sentry) \n\n## Installation\n\nYou can install Emmett-Sentry using pip:\n\n pip install emmett-sentry\n\nAnd add it to your Emmett application:\n\n```python\nfrom emmett_sentry import Sentry\n\nsentry = app.use_extension(Sentry)\n```\n\n## Configuration\n\nHere is the complete list of parameters of the extension configuration:\n\n| param | default | description |\n| --- | --- | --- |\n| dsn | | Sentry project's DSN |\n| environment | development | Application environment |\n| release | | Application release |\n| auto\\_load | `True` | Automatically inject extension on routes |\n| sample\\_rate | 1 | Error sampling rate |\n| integrations | | List of integrations to pass to the SDK |\n| enable\\_tracing | `False` | Enable tracing on routes |\n| tracing\\_sample\\_rate | | Traces sampling rate |\n| tracing\\_exclude\\_routes | | List of specific routes to exclude from tracing | \n| trace\\_websockets | `False` | Enable tracing on websocket routes |\n| trace\\_orm | `True` | Enable tracing on ORM queries |\n| trace\\_templates | `True` | Enable tracing on templates rendering |\n| trace\\_sessions | `True` | Enable tracing on sessions load/store |\n| trace\\_cache | `True` | Enable tracing on cache get/set |\n| trace\\_pipes | `False` | Enable tracing on pipes |\n\n## Usage\n\nThe extension exposes two methods to manually track events:\n\n- exception\n- message\n\nYou call these methods directly within your code:\n\n```python\n# track an error\ntry:\n 1 / 0\nexcept Exception:\n sentry.exception()\n\n# track a message\nsentry.message(\"some event\", level=\"info\")\n```\n\n## License\n\nEmmett-Sentry is released under BSD license.\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Sentry extension for Emmett framework",
"version": "0.6.1",
"project_urls": {
"Homepage": "https://github.com/emmett-framework/sentry",
"Issue Tracker": "https://github.com/emmett-framework/sentry/issues",
"Repository": "https://github.com/emmett-framework/sentry"
},
"split_keywords": [
"sentry",
"logging",
"emmett"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b35095c8d67162d0bbedba1492717bf00fc54df8b48a34cc484dcc3ac1b8252e",
"md5": "f6d9803db78d6f6dcc864945af2149c4",
"sha256": "6bc95b7ce842e4cff87b8763bcdecf8ab84916c07fa6124e0275e236d657b06a"
},
"downloads": -1,
"filename": "emmett_sentry-0.6.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f6d9803db78d6f6dcc864945af2149c4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 8515,
"upload_time": "2023-10-06T14:43:33",
"upload_time_iso_8601": "2023-10-06T14:43:33.843932Z",
"url": "https://files.pythonhosted.org/packages/b3/50/95c8d67162d0bbedba1492717bf00fc54df8b48a34cc484dcc3ac1b8252e/emmett_sentry-0.6.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6480c9f633358a3d3c9f5ff2e2b2303c05cd41fcb06fe7f52e057e708fb92370",
"md5": "f730499de42b7828967f102a0948f56c",
"sha256": "7df7f5f73aa7f172c6456f441f684c324dafeb270652ae0b327ca6baf4361fdf"
},
"downloads": -1,
"filename": "emmett_sentry-0.6.1.tar.gz",
"has_sig": false,
"md5_digest": "f730499de42b7828967f102a0948f56c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 7450,
"upload_time": "2023-10-06T14:43:35",
"upload_time_iso_8601": "2023-10-06T14:43:35.111279Z",
"url": "https://files.pythonhosted.org/packages/64/80/c9f633358a3d3c9f5ff2e2b2303c05cd41fcb06fe7f52e057e708fb92370/emmett_sentry-0.6.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-06 14:43:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "emmett-framework",
"github_project": "sentry",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "emmett-sentry"
}
JSON
