Configuring Deadcheck
Deadcheck can be easily configured via a config.yaml file. Below is an example configuration:
Interval and Alerts
You can configure checks to trigger alerts after a set interval:
checks:
- id: "2pm-checkin"
name: "Reports Finalized"
schedule:
weekdays:
timezone: "America/New_York"
times: ["14:00"]
# Only allow check-ins between 13:55 and 14:05
tolerance: "5m"
Basic Configuration
The alert section of the configuration allows you to integrate Deadcheck with various notification services. You can configure one or more alert integrations (HealthChecks.io, PagerDuty, or Slack) under the top-level alert key. Only one integration is typically active at a time, depending on your needs.
HealthChecks.io
To send failure alerts to HealthChecks.io, provide your API key. Deadcheck will ping the service when a check misses its scheduled check-in window.
alert:
healthchecksio:
apiKey: "string"
PagerDuty
For PagerDuty integration, specify your API key (integration key), the escalation policy ID, and optionally a custom "from" email address. This will trigger incidents in PagerDuty when alerts fire.
Note: The PagerDuty integration is currently experimental due to stability issues.
alert:
pagerduty:
apiKey: "string"
escalationPolicy: "string"
[ from: "string" ]
Slack
Slack integration requires a bot token (starting with xoxb-) and the target channel ID. Deadcheck will post alert messages directly to the specified Slack channel when a check fails.
Note: The Slack integration is currently experimental due to stability issues.
alert:
slack:
apiToken: "string"
channelID: "string"