health-check is HTTP service health monitor. We'll notify you when your application health status changes.
npm install @arunwij/health-check
const { HealthCheck, intervals } = require('@arunwij/health-check');
// specify service details
// name - service name
// url - service url
// interval - monitoring interval
// recipients - alert email recipients
const serviceConfigs = [
{
name: "My Service 1",
url: "https://my-service-1-url.com/health",
interval: intervals["every-5-seconds"],
recipients: ["notify-user1@example.com", "notify-user2@example.com"]
},
{
name: "My Service 2",
url: "http://localhost:3000",
interval: intervals["every-5-seconds"],
recipients: ["notify-user1@example.com"]
}
]
// specify email server configs
const emailConfig = {
from: "from-email@myemail.com",
host: "smtp-host-url",
port: "smtp-port",
auth: {
user: "username",
pass: "password"
}
}
const healthCheck = new HealthCheck(serviceConfigs, emailConfig);
healthCheck.monitor();
This feature sends periodic emails for recipients to make sure the health check service is running without issue.
const periodicStatusAlertConfig = {
interval: intervals["once-a-day"],
recipients: ["notify-user1@example.com"],
environment: "My Server Production"
};
healthCheck.sendPeriodicServiceStatus(periodicStatusAlertConfig);
