Application for performing recurring health checks of specific web services. Integrated with Slack via a web hook, to send status messages.
The application can be configured using environment variables set.
Key | Value purpose | Value example |
---|---|---|
interval | Period to fire status check, in seconds | 300 |
services | The path of the services configuration JSON file | services.json |
slack-webhook-url | Webhook URL to use for posting Slack messages | https://hooks.slack.com/services |
Services to be checked should be defined in a JSON file as an array of objects. The service has to have a name to be displayed and a statusCheck definition, which is an object that requires the url and httpMethod fields to be defined.
Example configuration:
[
{
"name": "integration SIT",
"statusCheck": {
"url": "https://127.0.0.1:8081/integration/health",
"httpMethod": "GET"
}
},
{
"name": "integration PreProd",
"statusCheck": {
"url": "https://127.0.0.1:9080/integration/testpost",
"httpMethod": "POST"
}
}
]