From a12416c2bd2c273eead00d24ac0496deb9d64d45 Mon Sep 17 00:00:00 2001 From: Gil Desmarais Date: Sat, 22 Aug 2026 11:53:02 +0200 Subject: [PATCH] docs(monitoring): document Botasaurus Sentry support and update compose snippets Update Starlight compose snippets, deployment example, and monitoring documentation to include SENTRY_DSN for the Botasaurus scrape service. --- examples/deployment/docker-compose.yml | 3 +++ src/components/docs/DockerComposeSnippet.astro | 7 ++++++- src/content/docs/web-application/reference/monitoring.mdx | 5 ++++- 3 files changed, 13 insertions(+), 2 deletions(-) diff --git a/examples/deployment/docker-compose.yml b/examples/deployment/docker-compose.yml index 3b796c3b..4b5939b7 100644 --- a/examples/deployment/docker-compose.yml +++ b/examples/deployment/docker-compose.yml @@ -16,3 +16,6 @@ services: botasaurus: image: html2rss/botasaurus-scrape-api:latest restart: unless-stopped + environment: + SENTRY_DSN: ${BOTASAURUS_SENTRY_DSN:-${SENTRY_DSN:-}} + diff --git a/src/components/docs/DockerComposeSnippet.astro b/src/components/docs/DockerComposeSnippet.astro index f8b58ebd..9ebfb2d3 100644 --- a/src/components/docs/DockerComposeSnippet.astro +++ b/src/components/docs/DockerComposeSnippet.astro @@ -56,6 +56,8 @@ const snippets: Record = { botasaurus: image: ${botasaurusImage} restart: unless-stopped + environment: + SENTRY_DSN: \${BOTASAURUS_SENTRY_DSN:-\${SENTRY_DSN:-}} volumes: caddy_data:`, @@ -77,7 +79,10 @@ volumes: botasaurus: image: ${botasaurusImage} - restart: unless-stopped`, + restart: unless-stopped + environment: + SENTRY_DSN: \${BOTASAURUS_SENTRY_DSN:-\${SENTRY_DSN:-}}`, + resourceGuardrails: `services: html2rss-web: image: ${webImage} diff --git a/src/content/docs/web-application/reference/monitoring.mdx b/src/content/docs/web-application/reference/monitoring.mdx index 0bd4d6f2..028528e3 100644 --- a/src/content/docs/web-application/reference/monitoring.mdx +++ b/src/content/docs/web-application/reference/monitoring.mdx @@ -39,4 +39,7 @@ Do not leave `CHANGE_ME_HEALTH_CHECK_TOKEN` anywhere in production. Once the pro ## Application Performance Monitoring using Sentry -When you specify `SENTRY_DSN` in your environment variables, the application will be setup to use Sentry. +When you specify `SENTRY_DSN` in your environment variables, `html2rss-web` is automatically configured to capture errors and structured logs. + +The `botasaurus` scrape API service also supports optional Sentry monitoring. In production Docker Compose setups, the `botasaurus` service uses `${BOTASAURUS_SENTRY_DSN:-${SENTRY_DSN:-}}`. This allows both services to share the same `SENTRY_DSN` by default, while enabling you to direct scraper errors to a dedicated project using `BOTASAURUS_SENTRY_DSN` when preferred. +