diff --git a/src/platforms/python/common/configuration/integrations/clickhouse-driver.mdx b/src/platforms/python/common/configuration/integrations/clickhouse-driver.mdx new file mode 100644 index 0000000000000..949df8216eaec --- /dev/null +++ b/src/platforms/python/common/configuration/integrations/clickhouse-driver.mdx @@ -0,0 +1,40 @@ +--- +title: clickhouse-driver +description: "Learn about importing the clickhouse-driver integration and how it captures queries from clickhouse-driver as breadcrumbs." +sidebar_order: 27 +--- + +The clickhouse-driver integration captures queries from +[clickhouse-driver](https://github.com/mymarilyn/clickhouse-driver) as breadcrumbs and spans. +The integration is available for clickhouse-driver 0.2.0 or later. + +## Install + +Install `sentry-sdk` with the `clickhouse-driver` extra. + +```bash +pip install --upgrade 'sentry-sdk[clickhouse-driver]' +``` + +## Configure + +Add `ClickhouseDriverIntegration()` to your `integrations` list: + +```python +import sentry_sdk +from sentry_sdk.integrations.clickhouse_driver import ClickhouseDriverIntegration + +sentry_sdk.init( + dsn="___PUBLIC_DSN___", + integrations=[ + ClickhouseDriverIntegration(), + ], +) +``` + +By default, the parameters of the query are not retrieved. To see the query parameters in Sentry, enable `send_default_pii`. See Basic Options for details. + +## Supported Versions + +- clickhouse-driver >= 0.2.0 +- python >= 3.8 diff --git a/src/platforms/python/common/configuration/integrations/index.mdx b/src/platforms/python/common/configuration/integrations/index.mdx index 5956c4ebb0d32..e68612621b7da 100644 --- a/src/platforms/python/common/configuration/integrations/index.mdx +++ b/src/platforms/python/common/configuration/integrations/index.mdx @@ -18,6 +18,7 @@ If you don't want integrations to be enabled automatically, set the `default_int - [ASGI](asgi/) - [asyncio](asyncio/) +- [clickhouse-driver](clickhouse-driver/) - [Cloud Resource Context](cloudresourcecontext/) - [Enhanced Locals](pure_eval/) - [GNU Backtrace](gnu_backtrace/)