-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Add documentation for python clickhouse-driver integration #7129
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
antonpirker
merged 11 commits into
getsentry:master
from
mimre25:feat/python-clickhouse-driver-integration
Sep 13, 2023
Merged
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
8b0ea29
Add documentation for python clickhouse-driver integration
mimre25 1e670c7
Update clickhouse-driver.mdx
antonpirker 12a7b03
Update clickhouse-driver.mdx
antonpirker c62bc59
Linked to send_default_pii docs.
antonpirker 627900d
Update src/platforms/python/common/configuration/integrations/index.mdx
shanamatthews bd2d315
Update src/platforms/python/common/configuration/integrations/clickho…
shanamatthews 11b2b1f
Update src/platforms/python/common/configuration/integrations/clickho…
shanamatthews b0a8359
Update src/platforms/python/common/configuration/integrations/clickho…
shanamatthews 4b59679
Update src/platforms/python/common/configuration/integrations/clickho…
shanamatthews d8cc4ee
Update src/platforms/python/common/configuration/integrations/clickho…
shanamatthews 27c5d52
Trigger build
antonpirker File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
40 changes: 40 additions & 0 deletions
40
src/platforms/python/common/configuration/integrations/clickhouse-driver.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 <PlatformLink to="/configuration/options/#send-default-pii">Basic Options</PlatformLink> for details. | ||
|
||
## Supported Versions | ||
|
||
- clickhouse-driver >= 0.2.0 | ||
- python >= 3.8 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.