# datasette-sentry
[](https://pypi.org/project/datasette-sentry/)
[](https://github.com/simonw/datasette-sentry/releases)
[](https://github.com/simonw/datasette-sentry/actions?query=workflow%3ATest)
[](https://github.com/simonw/datasette-sentry/blob/main/LICENSE)
Datasette plugin for configuring Sentry for error reporting
## Installation
```bash
pip install datasette-sentry
```
## Usage
This plugin only takes effect if your `metadata.json` file contains relevant top-level plugin configuration in a `"datasette-sentry"` configuration key.
You will need a Sentry DSN - see their [Getting Started instructions](https://docs.sentry.io/error-reporting/quickstart/?platform=python).
Add it to `metadata.json` like this:
```json
{
"plugins": {
"datasette-sentry": {
"dsn": "https://KEY@sentry.io/PROJECTID"
}
}
}
```
Settings in `metadata.json` are visible to anyone who visits the `/-/metadata` URL so this is a good place to take advantage of Datasette's [secret configuration values](https://datasette.readthedocs.io/en/stable/plugins.html#secret-configuration-values), in which case your configuration will look more like this:
```json
{
"plugins": {
"datasette-sentry": {
"dsn": {
"$env": "SENTRY_DSN"
}
}
}
}
```
Then make a `SENTRY_DSN` environment variable available to Datasette.
## Configuration
In addition to the `dsn` setting, you can also configure the Sentry [sample rate](https://docs.sentry.io/platforms/python/configuration/sampling/) by setting `sample_rate` to a floating point number between 0 and 1.
For example, to capture 25% of errors you would do this:
```json
{
"plugins": {
"datasette-sentry": {
"dsn": {
"$env": "SENTRY_DSN"
},
"sample_rate": 0.25
}
}
}
```
### Performance monitoring
Sentry [Performance Monitoring](https://docs.sentry.io/product/performance/) records full traces of page for further analysis, in addition to tracking errors.
You can enable that by adding "enable_tracing" to your plugin configuration:
```json
{
"plugins": {
"datasette-sentry": {
"dsn": {
"$env": "SENTRY_DSN"
},
"enable_tracing": true
}
}
}
```
The default sample rate if you do this will be `1.0`, meaning every response will be traced. This can get expensive - you can adjust the tracing rate using `traces_sample_rate`. Set that to `0.1` to sample 10% of requests, for example:
```json
{
"plugins": {
"datasette-sentry": {
"dsn": {
"$env": "SENTRY_DSN"
},
"enable_tracing": true,
"traces_sample_rate": 0.1
}
}
}
```
Raw data
{
"_id": null,
"home_page": "https://github.com/simonw/datasette-sentry",
"name": "datasette-sentry",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Simon Willison",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/fc/6c/a4f5fd7f3ffe06c05cf49ad8363f2cdb3e8f0099d544d511e6ae15ad1ef0/datasette-sentry-0.4.tar.gz",
"platform": null,
"description": "# datasette-sentry\n\n[](https://pypi.org/project/datasette-sentry/)\n[](https://github.com/simonw/datasette-sentry/releases)\n[](https://github.com/simonw/datasette-sentry/actions?query=workflow%3ATest)\n[](https://github.com/simonw/datasette-sentry/blob/main/LICENSE)\n\nDatasette plugin for configuring Sentry for error reporting\n \n## Installation\n```bash\npip install datasette-sentry\n```\n## Usage\n\nThis plugin only takes effect if your `metadata.json` file contains relevant top-level plugin configuration in a `\"datasette-sentry\"` configuration key.\n\nYou will need a Sentry DSN - see their [Getting Started instructions](https://docs.sentry.io/error-reporting/quickstart/?platform=python).\n\nAdd it to `metadata.json` like this:\n\n```json\n{\n \"plugins\": {\n \"datasette-sentry\": {\n \"dsn\": \"https://KEY@sentry.io/PROJECTID\"\n }\n }\n}\n```\nSettings in `metadata.json` are visible to anyone who visits the `/-/metadata` URL so this is a good place to take advantage of Datasette's [secret configuration values](https://datasette.readthedocs.io/en/stable/plugins.html#secret-configuration-values), in which case your configuration will look more like this:\n```json\n{\n \"plugins\": {\n \"datasette-sentry\": {\n \"dsn\": {\n \"$env\": \"SENTRY_DSN\"\n }\n }\n }\n}\n```\nThen make a `SENTRY_DSN` environment variable available to Datasette.\n\n## Configuration\n\nIn addition to the `dsn` setting, you can also configure the Sentry [sample rate](https://docs.sentry.io/platforms/python/configuration/sampling/) by setting `sample_rate` to a floating point number between 0 and 1.\n\nFor example, to capture 25% of errors you would do this:\n\n```json\n{\n \"plugins\": {\n \"datasette-sentry\": {\n \"dsn\": {\n \"$env\": \"SENTRY_DSN\"\n },\n \"sample_rate\": 0.25\n }\n }\n}\n```\n\n### Performance monitoring\n\nSentry [Performance Monitoring](https://docs.sentry.io/product/performance/) records full traces of page for further analysis, in addition to tracking errors.\n\nYou can enable that by adding \"enable_tracing\" to your plugin configuration:\n\n```json\n{\n \"plugins\": {\n \"datasette-sentry\": {\n \"dsn\": {\n \"$env\": \"SENTRY_DSN\"\n },\n \"enable_tracing\": true\n }\n }\n}\n```\nThe default sample rate if you do this will be `1.0`, meaning every response will be traced. This can get expensive - you can adjust the tracing rate using `traces_sample_rate`. Set that to `0.1` to sample 10% of requests, for example:\n\n```json\n{\n \"plugins\": {\n \"datasette-sentry\": {\n \"dsn\": {\n \"$env\": \"SENTRY_DSN\"\n },\n \"enable_tracing\": true,\n \"traces_sample_rate\": 0.1\n }\n }\n}\n```\n",
"bugtrack_url": null,
"license": "Apache License, Version 2.0",
"summary": "Datasette plugin for configuring Sentry",
"version": "0.4",
"project_urls": {
"Homepage": "https://github.com/simonw/datasette-sentry"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ab2f46a300bb5fdee640481692547e1e10746bc2a8defce3bf64898bcf06ab77",
"md5": "866766484848de887b99c6cfd6bdba22",
"sha256": "9dc7276039d7c5688b904416e3ceeb94773c23dcb0b20a450e2ea282b201f8ca"
},
"downloads": -1,
"filename": "datasette_sentry-0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "866766484848de887b99c6cfd6bdba22",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 7416,
"upload_time": "2023-11-21T19:23:37",
"upload_time_iso_8601": "2023-11-21T19:23:37.239362Z",
"url": "https://files.pythonhosted.org/packages/ab/2f/46a300bb5fdee640481692547e1e10746bc2a8defce3bf64898bcf06ab77/datasette_sentry-0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fc6ca4f5fd7f3ffe06c05cf49ad8363f2cdb3e8f0099d544d511e6ae15ad1ef0",
"md5": "ef403364a1fa3e195f2f0fe9139a3dbe",
"sha256": "662b00661f8f0f6b91de0504d7c356d991eddf36bfe61d43afd36c7ca3472df3"
},
"downloads": -1,
"filename": "datasette-sentry-0.4.tar.gz",
"has_sig": false,
"md5_digest": "ef403364a1fa3e195f2f0fe9139a3dbe",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 7032,
"upload_time": "2023-11-21T19:23:38",
"upload_time_iso_8601": "2023-11-21T19:23:38.922752Z",
"url": "https://files.pythonhosted.org/packages/fc/6c/a4f5fd7f3ffe06c05cf49ad8363f2cdb3e8f0099d544d511e6ae15ad1ef0/datasette-sentry-0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-21 19:23:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "simonw",
"github_project": "datasette-sentry",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "datasette-sentry"
}
JSON
