Skip to content

docs(monitoring): document Botasaurus Sentry support and update compose snippets #1241

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.

Sign up for GitHub

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

Closed
gildesmarais wants to merge 1 commit into from
Closed

docs(monitoring): document Botasaurus Sentry support and update compose snippets #1241

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions examples/deployment/docker-compose.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,6 @@ services:
botasaurus:
image: html2rss/botasaurus-scrape-api:latest
restart: unless-stopped
environment:
SENTRY_DSN: ${BOTASAURUS_SENTRY_DSN:-${SENTRY_DSN:-}}

7 changes: 6 additions & 1 deletion src/components/docs/DockerComposeSnippet.astro
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ const snippets: Record<Props["variant"], string> = {
botasaurus:
image: ${botasaurusImage}
restart: unless-stopped
environment:
SENTRY_DSN: \${BOTASAURUS_SENTRY_DSN:-\${SENTRY_DSN:-}}

volumes:
caddy_data:`,
Expand All @@ -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}
Expand Down
5 changes: 4 additions & 1 deletion src/content/docs/web-application/reference/monitoring.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Loading