Skip to content

Commit 4382341

Browse files
authored
feat: Document changes for sentry.python 0.7.7 (#850)
* feat: Document changes for sentry.python 0.7.7 * fix: Styleguide
1 parent f2f937a commit 4382341

File tree

6 files changed

+50
-9
lines changed

6 files changed

+50
-9
lines changed

__tests__/__snapshots__/documentation.js.snap

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -371,6 +371,7 @@ Array [
371371
"platforms/python/default-integrations/index.html",
372372
"platforms/python/django/index.html",
373373
"platforms/python/flask/index.html",
374+
"platforms/python/gnu_backtrace/index.html",
374375
"platforms/python/index.html",
375376
"platforms/python/logging/index.html",
376377
"platforms/python/pyramid/index.html",

src/collections/_documentation/platforms/python/aiohttp.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,21 @@ sidebar_order: 4
1010

1111
The AIOHTTP integration adds support for the [AIOHTTP-Server Web
1212
Framework](https://docs.aiohttp.org/en/stable/web.html). A Python version of
13-
3.7 or greater is required.
13+
3.6 or greater is required.
1414

1515
1. Install `sentry-sdk` from PyPI:
1616

1717
```bash
1818
$ pip install --upgrade 'sentry-sdk=={% sdk_version sentry.python %}'
1919
```
2020

21-
2. Initialize the SDK before starting the server:
21+
2. If you're on Python 3.6, you also need the `aiocontextvars` package:
22+
23+
```bash
24+
$ pip install --upgrade aiocontextvars
25+
```
26+
27+
3. Initialize the SDK before starting the server:
2228
2329
```python
2430
import sentry_sdk
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
title: GNU Backtrace
3+
sidebar_order: 2
4+
---
5+
<!-- WIZARD -->
6+
*Import name: `sentry_sdk.integrations.gnu_backtrace.GnuBacktraceIntegration`*
7+
8+
The GNU backtrace integration parses native stack trace produced by [`backtrace_symbols`](https://linux.die.net/man/3/backtrace_symbols) from error messages and concatenates them with the Python traceback.
9+
10+
It is currently tested to work with server exceptions raised by [`clickhouse-driver`](https://github.com/mymarilyn/clickhouse-driver).
11+
12+
**This integration is experimental.** It may be removed in minor versions. When enabling this integration, expect to see new event groups due to new stack trace frames.
13+
14+
Add ``GnuBacktraceIntegration()`` to your ``integrations`` list:
15+
16+
```python
17+
import sentry_sdk
18+
from sentry_sdk.integrations.celery import CeleryIntegration
19+
20+
sentry_sdk.init("___PUBLIC_DSN___", integrations=[GnuBacktraceIntegration()])
21+
```
22+
23+
<!-- ENDWIZARD -->

src/collections/_documentation/platforms/python/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ SDK. A call to `sentry_sdk.init` configures integrations. Unless you set `defaul
4040
### Other Integrations
4141

4242
* [Logging]({% link _documentation/platforms/python/logging.md %})
43+
* [GNU Backtrace]({% link _documentation/platforms/python/gnu_backtrace.md %})
4344
* [Default integrations]({% link _documentation/platforms/python/default-integrations.md %})
4445

4546
{% capture __alert_content -%}

src/collections/_documentation/platforms/python/sanic.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,22 @@ sidebar_order: 3
99
*Import name: `sentry_sdk.integrations.sanic.SanicIntegration`*
1010

1111
The Sanic integration adds support for the [Sanic Web
12-
Framework](https://github.com/huge-success/sanic).
12+
Framework](https://github.com/huge-success/sanic). A Python version of 3.6 or
13+
greater is required.
1314

1415
1. Install `sentry-sdk` from PyPI:
1516

1617
```bash
1718
$ pip install --upgrade 'sentry-sdk=={% sdk_version sentry.python %}'
1819
```
1920

20-
2. To configure the SDK, initialize it with the integration before or after your app has been initialized:
21+
2. If you're on Python 3.6, you also need the `aiocontextvars` package:
22+
23+
```bash
24+
$ pip install --upgrade aiocontextvars
25+
```
26+
27+
3. To configure the SDK, initialize it with the integration before or after your app has been initialized:
2128
2229
```python
2330
import sentry_sdk

src/collections/_documentation/platforms/python/tornado.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,21 @@ sidebar_order: 4
1010

1111
The Tornado integration adds support for the [Tornado Web
1212
Framework](https://www.tornadoweb.org/). A Tornado version of 5 or greater and
13-
Python 3.7 or greater is required.
13+
Python 3.6 or greater is required.
1414

1515
1. Install `sentry-sdk` from PyPI:
1616

1717
```bash
1818
$ pip install --upgrade sentry-sdk=={% sdk_version sentry.python %}
1919
```
2020

21-
2. Initialize the SDK before starting the server:
21+
2. If you're on Python 3.6, you also need the `aiocontextvars` package:
22+
23+
```bash
24+
$ pip install --upgrade aiocontextvars
25+
```
26+
27+
3. Initialize the SDK before starting the server:
2228
2329
```python
2430
import sentry_sdk
@@ -45,9 +51,6 @@ Python 3.7 or greater is required.
4551
4652
* {% include platforms/python/request-data.md %}
4753
48-
*Note: The tornado integration currently does not capture formdata.* See [the
49-
relevant GitHub issue](https://github.com/getsentry/sentry-python/issues/221)
50-
5154
* Logging with any logger will create breadcrumbs when
5255
the [Logging]({% link _documentation/platforms/python/logging.md %})
5356
integration is enabled (done by default).

0 commit comments

Comments
 (0)