sentinel

ultra lightweight & reliable service monitoring tool

Warning

under development, expect breaking changes

Installation

docker pull ghcr.io/jabedzaman/sentinel:latest
docker run -d ghcr.io/jabedzaman/sentinel:latest --env-file .env --name sentinel --restart always

Configuration

Create a .env file in the root directory of your project and add the following configuration.

### Sentinel Configuration ###
CONFIG_PATH="/etc/sentinel/config.json" # path to the configuration file

### SMTP Configuration ###
SMTP_HOST="0.0.0.0"
SMTP_PORT="1025"
SMTP_USER="sentinel"
SMTP_PASS="sentinel"
SMTP_FROM="sentinel <sentinel@localhost>"

{
  "apps": [
    {
      "name": "portfolio",
      "endpoint": "jabed.dev",
      "port": 443,
      "protocol": "https"
    }
  ],
  "timeout": 5000,
  "interval": 5000,
  "retries": 3,
  "alerts": {
    "enabled": true,
    "email": "[email protected]"
  }
}

Configuration Options

Option	Description	Default	Type
apps	List of applications to monitor	[]	Array<App>
timeout	Request timeout in milliseconds	5000	Number
interval	Polling interval in milliseconds	5000	Number
retries	Number of retries before alert	3	Number
alerts	Alerting configuration	{}	Object

App Option	Description	Default	Type
name	Name of the application	""	String
endpoint	URL of the application	""	String
port	Port of the application	80	Number
protocol	Protocol of the application	http	String

License

Apache 2.0