Merge pull request #219 from levoai/cf-worker-failure-mode

Document Cloudflare Worker Failure Modes
levoai · Apr 4, 2024 · 10f8285 · 10f8285
2 parents 2cc6798 + 0ca2298
commit 10f8285
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/docs/assets/cf-worker-route.png b/docs/assets/cf-worker-route.png
diff --git a/docs/install-traffic-capture-sensors/cloudflare-worker.md b/docs/install-traffic-capture-sensors/cloudflare-worker.md
@@ -43,3 +43,14 @@ Check the [repository's README](https://github.com/levoai/cf-worker/blob/main/RE
 ## Configuring Websites to use the Worker
 
 Follow the instructions in the [Cloudflare Docs](https://developers.cloudflare.com/workers/configuration/routing/routes/#set-up-a-route).
+
+:::caution
+When adding a worker route, ensure that the failure mode is set to "Fail open" to allow requests to bypass the worker in case of unexpected errors
+or if the [daily request limit](https://developers.cloudflare.com/workers/platform/limits/#daily-request) runs out.
+:::
+
+<img
+  src={require('../assets/cf-worker-route.png').default}
+  alt="Adding a Cloudflare Worker route"
+  style={{ display: 'block', margin: 'auto', paddingTop: '24px'}}
+/>