add Sentry docs (#9791)

airbytehq · Jan 25, 2022 · 20d6009 · 20d6009
1 parent 579923d
commit 20d6009
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 0 deletions.
diff --git a/docs/.gitbook/assets/sentry-flow-v1.png b/docs/.gitbook/assets/sentry-flow-v1.png
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
@@ -30,6 +30,7 @@
     * [Transformations with dbt (Part 2/3)](operator-guides/transformation-and-normalization/transformations-with-dbt.md)
     * [Transformations with Airbyte (Part 3/3)](operator-guides/transformation-and-normalization/transformations-with-airbyte.md)
   * [Configuring Airbyte](operator-guides/configuring-airbyte.md)
+    * [Sentry Integration](operator-guides/sentry-integration.md)
   * [Scaling Airbyte](operator-guides/scaling-airbyte.md)
   * [Securing Airbyte](operator-guides/securing-airbyte.md)
 * [Connector Catalog](integrations/README.md)

diff --git a/docs/operator-guides/configuring-airbyte.md b/docs/operator-guides/configuring-airbyte.md
@@ -80,6 +80,7 @@ The following variables are relevant to both Docker and Kubernetes.
 2. `MAX_CHECK_WORKERS` - Define the maximum number of Check workers each Airbyte Worker container can support. Defaults to 5.
 3. `MAX_SYNC_WORKERS` - Define the maximum number of Sync workers each Airbyte Worker container can support. Defaults to 5.
 4. `MAX_DISCOVER_WORKERS` - Define the maximum number of Discover workers each Airbyte Worker container can support. Defaults to 5.
+5. `SENTRY_DSN` - Define the [DSN](https://docs.sentry.io/product/sentry-basics/dsn-explainer/) of necessary Sentry instance. Defaults to empty. Integration with Sentry is explained [here](./sentry-integration.md) 
 
 #### Scheduler
 1. `SUBMITTER_NUM_THREADS` - Define the maximum number of concurrent jobs the Scheduler schedules. Defaults to 5.

diff --git a/docs/operator-guides/sentry-integration.md b/docs/operator-guides/sentry-integration.md
@@ -0,0 +1,11 @@
+# Sentry Integration
+
+Airbyte provides an opportunity to aggregate connectors' exceptions and errors via [Sentry](https://https://sentry.io/).
+By default, this option is off. There are 2 possible mechanisms for its activation:
+1. Define the `SENTRY_DSN` environment variable into Dockerfile of necessary connectors.
+2. Define the `SENTRY_DSN` into the workspace environment file (`.env`). Workers will add this variable to all docker connectors automatically.
+
+Most connectors written using the Airbyte Python or Java CDKs automatically detect this environment variable and activate Sentry profiling accordingly. 
+
+## UML diagram
+![](../.gitbook/assets/sentry-flow-v1.png)