mirror of
https://github.com/TwiN/gatus.git
synced 2024-12-25 16:18:51 +01:00
⛑ Automated developer-oriented status page
alertingdashboarddevopsdockergogolanghealthmonitormonitoringmonitoring-servermonitoring-toolnotificationsselfhostedself-hostedslackstatusstatuspagestatus-pageuptimeuptime-monitoring
.github/workflows | ||
config | ||
core | ||
example | ||
metric | ||
static | ||
vendor | ||
watchdog | ||
.dockerignore | ||
.gitignore | ||
config.yaml | ||
Dockerfile | ||
go.mod | ||
go.sum | ||
LICENSE.md | ||
main.go | ||
README.md |
gatus
A service health dashboard in Go that is meant to be used as a docker image with a custom configuration file.
Live example: https://status.twinnation.org/
Usage
metrics: true # Whether to expose metrics at /metrics
services:
- name: twinnation # Name of your service, can be anything
url: https://twinnation.org/actuator/health
interval: 15s # Duration to wait between every status check (opt. default: 10s)
conditions:
- "$STATUS == 200"
- name: github
url: https://api.github.com/healthz
conditions:
- "$STATUS == 200"
Docker
Building the Docker image is done as following:
docker build . -t gatus
You can then run the container with the following command:
docker run -p 8080:8080 --name gatus gatus
Running the tests
go test ./... -mod vendor
Using in Production
See the example folder.