Skip to content

Monitoring

html2rss-web exposes these health endpoints:

  • GET /api/v1/health/live: liveness probe, no auth
  • GET /api/v1/health/ready: readiness probe, no auth
  • GET /api/v1/health: authenticated health probe, bearer token required

Use GET /api/v1/health when you want an authenticated operator-facing probe.

Set the environment variable HEALTH_CHECK_TOKEN, then send it as a bearer token:

Terminal window
curl -H "Authorization: Bearer $HEALTH_CHECK_TOKEN" http://localhost:4000/api/v1/health

The response is JSON and reports the current status, timestamp, environment, uptime, and reserved checks payload.

  • Use /api/v1/health/live for a simple process-alive signal.
  • Use /api/v1/health/ready for config-readiness checks without auth.
  • Use /api/v1/health for authenticated monitoring from your uptime system or operator tooling.

Application Performance Monitoring using Sentry

Section titled “Application Performance Monitoring using Sentry”

When you specify SENTRY_DSN in your environment variables, the application will be setup to use Sentry.