Skip to content
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

Added beam documentation #1148

Merged
merged 3 commits into from
Aug 9, 2019
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions __tests__/__snapshots__/documentation.js.snap
Original file line number Diff line number Diff line change
Expand Up @@ -319,6 +319,7 @@ Array [
"platforms/python/aiohttp/index.html",
"platforms/python/asgi/index.html",
"platforms/python/aws_lambda/index.html",
"platforms/python/beam/index.html",
"platforms/python/bottle/index.html",
"platforms/python/celery/index.html",
"platforms/python/default-integrations/index.html",
Expand Down
21 changes: 21 additions & 0 deletions src/collections/_documentation/platforms/python/beam.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: Apache Beam
sidebar_order: 2
---
<!-- WIZARD -->
The Beam integration currently parses the functions in [ParDo](https://github.com/apache/beam/blob/release-2.13.0/sdks/python/apache_beam/transforms/core.py#L991) to return exceptions in their respective setup, start_bundle, process, and finish_bundle functions.

The functions get injected with an inspect function to patch getting the [function signature](https://github.com/apache/beam/blob/release-2.13.0/sdks/python/apache_beam/transforms/core.py#L288L298).
tiopi marked this conversation as resolved.
Show resolved Hide resolved

**This integration is experimental.** It may be removed in minor versions. When enabling this integration, expect to see incorrect server_name and ip due to some distributed within Beam.
tiopi marked this conversation as resolved.
Show resolved Hide resolved

Add ``BeamIntegration()`` to your ``integrations`` list:

```python
import sentry_sdk
from sentry_sdk.integrations.beam import BeamIntegration

sentry_sdk.init("___PUBLIC_DSN___", integrations=[BeamIntegration()])
```

<!-- ENDWIZARD -->