aaronfagan/healthchecks repository overview

⁠Healthchecks

This image is an always-on solution to automatically check any number of endpoints for connectivity. Endpoints must return a 200 series status code to be considered active.

⁠Environment Variables

Variables without default are required.

AWS_ACCESS_KEY_ID

• Your IAM user key.

AWS_SECRET_ACCESS_KEY

• Your IAM user secret.

AWS_DEFAULT_REGION

• The AWS region your Amazon Route 53 hosted zone is in.

ENDPOINTS

• The target endpoints to check.
• Comma separated list.

FAIL_THRESHOLD

• Default: 3
• The nunmber of failed checks before an endpoint is considered unhealthy.

FREQUENCY

• Default: 10
• How often to run the healthcheck, in seconds.
• Should be greater than TIMEOUT value.

NOTIFY

• The type of notification to send.
  • SMS

NOTIFY_FROM

• The identifier where the notification originates.
• In the case of SMS, this would be the originating number reserved in AWS Pinpoint.

NOTIFY_TO

• Where to send notifications to.
• In the case of SMS, this would be the recipients phone number.

TIMEOUT

• Default: 5
• How long before endpoint is considered unreachable, in seconds.
• Should be less than FREQUENCY value.

TZ

• Your preferred timezone.

⁠Contributors

• Aaron Fagan - Github⁠, Website⁠