From d38a57e924ddf8073dcef55697798752e45b34a9 Mon Sep 17 00:00:00 2001 From: Osmar Coronel Date: Fri, 9 Aug 2019 01:55:28 -0700 Subject: [PATCH 1/3] Added beam documentation --- __tests__/__snapshots__/documentation.js.snap | 1 + .../_documentation/platforms/python/beam.md | 21 +++++++++++++++++++ 2 files changed, 22 insertions(+) create mode 100644 src/collections/_documentation/platforms/python/beam.md diff --git a/__tests__/__snapshots__/documentation.js.snap b/__tests__/__snapshots__/documentation.js.snap index b79bdb544b93a..9a45df90ee924 100644 --- a/__tests__/__snapshots__/documentation.js.snap +++ b/__tests__/__snapshots__/documentation.js.snap @@ -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", diff --git a/src/collections/_documentation/platforms/python/beam.md b/src/collections/_documentation/platforms/python/beam.md new file mode 100644 index 0000000000000..41b0c7ad6fe5b --- /dev/null +++ b/src/collections/_documentation/platforms/python/beam.md @@ -0,0 +1,21 @@ +--- +title: Apache Beam +sidebar_order: 2 +--- + +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). + +**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. + +Add ``BeamIntegration()`` to your ``integrations`` list: + +```python +import sentry_sdk +from sentry_sdk.integrations.beam import BeamIntegration + +sentry_sdk.init("___PUBLIC_DSN___", integrations=[BeamIntegration()]) +``` + + \ No newline at end of file From 68ee29616a676b5f76aefdc12ae95b64222530a0 Mon Sep 17 00:00:00 2001 From: Osmar Coronel Date: Fri, 9 Aug 2019 10:32:21 -0700 Subject: [PATCH 2/3] Fixed grammar --- src/collections/_documentation/platforms/python/beam.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/collections/_documentation/platforms/python/beam.md b/src/collections/_documentation/platforms/python/beam.md index 41b0c7ad6fe5b..fbe119c47eb55 100644 --- a/src/collections/_documentation/platforms/python/beam.md +++ b/src/collections/_documentation/platforms/python/beam.md @@ -7,7 +7,7 @@ The Beam integration currently parses the functions in [ParDo](https://github.co 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). -**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. +**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 properties within Beam. Add ``BeamIntegration()`` to your ``integrations`` list: From 16a7c523ccda2ce14e2d6fe2625118e4df308455 Mon Sep 17 00:00:00 2001 From: Osmar Coronel Date: Fri, 9 Aug 2019 14:42:21 -0700 Subject: [PATCH 3/3] Fixed beam.md --- .../_documentation/platforms/python/beam.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/src/collections/_documentation/platforms/python/beam.md b/src/collections/_documentation/platforms/python/beam.md index fbe119c47eb55..f469ef5354411 100644 --- a/src/collections/_documentation/platforms/python/beam.md +++ b/src/collections/_documentation/platforms/python/beam.md @@ -5,8 +5,6 @@ sidebar_order: 2 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). - **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 properties within Beam. Add ``BeamIntegration()`` to your ``integrations`` list: @@ -18,4 +16,13 @@ from sentry_sdk.integrations.beam import BeamIntegration sentry_sdk.init("___PUBLIC_DSN___", integrations=[BeamIntegration()]) ``` - \ No newline at end of file + + + +## Behavior + +* 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). + +* The integration requires sentry to be installed on all the worker computers using a `--requirements_file`. + +* The main computer invoking the pipeline requires the same version of sentry as the worker nodes. \ No newline at end of file