TwiN/gatus

▲ 100 stars today★ 12,661⑂ 895

Automated developer-oriented status page with alerting and incident support

About TwiN/gatus

TwiN/gatus is an open-source project on GitHub, mainly written in Go. Automated developer-oriented status page with alerting and incident support It currently holds 12,661 stars and 895 forks with 438 open issues, and was last pushed on 2026-11-09 (repository created 2019-09-04).

Project Overview

Git Homed tracks it on the Today's Trending board, currently at rank #45 with 100 new stars today.

GitHub Repository Details

Repository TwiN/gatus · default branch master · size 35928 KB · watchers 43 · source: GitHub REST API and repository README

README

Gatus

test Go Report Card Go version Docker pulls Follow TwiN

Gatus is a developer-oriented health dashboard that gives you the ability to monitor your services using HTTP, ICMP, TCP, and even DNS queries as well as evaluate the result of said queries by using a list of conditions on values like the status code, the response time, the certificate expiration, the body and many others. The icing on top is that each of these health checks can be paired with alerting via Slack, Teams, PagerDuty, Discord, Twilio and many more.

I personally deploy it in my Kubernetes cluster and let it monitor the status of my core applications: https://status.twin.sh/

_Looking for a managed solution? Check out Gatus.io._

Quick start
docker run -p 8080:8080 --name gatus ghcr.io/twin/gatus:stable

You can also use Docker Hub if you prefer:

docker run -p 8080:8080 --name gatus twinproduction/gatus:stable
For more details, see Usage

❤ Like this project? Please consider sponsoring me.
Gatus dashboard

Have any feedback or questions? Create a discussion.

Table of Contents

Why Gatus?

Before getting into the specifics, I want to address the most common question:
Why would I use Gatus when I can just use Prometheus’ Alertmanager, Cloudwatch or even Splunk?

Neither of these can tell you that there’s a problem if there are no clients actively calling the endpoint. In other words, it's because monitoring metrics mostly rely on existing traffic, which effectively means that unless your clients are already experiencing a problem, you won't be notified.

Gatus, on the other hand, allows you to configure health checks for each of your features, which in turn allows it to monitor these features and potentially alert you before any clients are impacted.

A sign you may want to look into Gatus is by simply asking yourself whether you'd receive an alert if your load balancer was to go down right now. Will any of your existing alerts be triggered? Your metrics won’t report an increase in errors if no traffic makes it to your applications. This puts you in a situation where your clients are the ones that will notify you about the degradation of your services rather than you reassuring them that you're working on fixing the issue before they even know about it.

Features

The main features of Gatus are: Gatus dashboard conditions

Usage

docker run -p 8080:8080 --name gatus ghcr.io/twin/gatus:stable

You can also use Docker Hub if you prefer:

docker run -p 8080:8080 --name gatus twinproduction/gatus:stable
If you want to create your own configuration, see Docker for information on how to mount a configuration file.

Here's a simple example:

endpoints:
  • name: website # Name of your endpoint, can be anything
url: "https://twin.sh/health" interval: 5m # Duration to wait between every status check (default: 60s) conditions:
  • "[STATUS] == 200" # Status must be 200
  • "[BODY].status == UP" # The json path "$.status" must be equal to UP
  • "[RESPONSE_TIME] < 300" # Response time must be under 300ms
  • name: make-sure-header-is-rendered
url: "https://example.org/" interval: 60s conditions:
  • "[STATUS] == 200" # Status must be 200
  • "[BODY] == pat(

    Example Domain

    )" # Body must contain the specified header

This example would look similar to this:

Simple example

If you want to test it locally, see Docker.

Configuration

By default, the configuration file is expected to be at config/config.yaml.

You can specify a custom path by setting the GATUS_CONFIG_PATH environment variable.

If GATUS_CONFIG_PATH points to a directory, all .yaml and .yml files inside said directory and its subdirectories are merged like so:

💡 You can also use environment variables in the configuration file (e.g. $DOMAIN, ${DOMAIN})
> ⚠️ When your configuration parameter contains a $ symbol, you have to escape $ with $$.
> See Use environment variables in config files or examples/docker-compose-postgres-storage/config/config.yaml for examples.

If you want to test it locally, see Docker.

Configuration

| Parameter | Description | Default | |:-----------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------|:--------------| | metrics | Whether to expose metrics at /metrics. | false | | storage | Storage configuration. | {} | | alerting | Alerting configuration. | {} | | announcements | Announcements configuration. | [] | | endpoints | Endpoints configuration. | Required [] | | external-endpoints | External Endpoints configuration. | [] | | security | Security configuration. | {} | | concurrency | Maximum number of endpoints/suites to monitor concurrently. Set to 0 for unlimited. See Concurrency. | 3 | | disable-monitoring-lock | Whether to disable the monitoring lock. Deprecated: Use concurrency: 0 instead. | false | | skip-invalid-config-update | Whether to ignore invalid configuration update.
See Reloading configuration on the fly. | false | | web | Web configuration. | {} | | ui | UI configuration. | {} | | maintenance | Maintenance configuration. | {} |

If you want more verbose logging, you may set the GATUS_LOG_LEVEL environment variable to DEBUG. Conversely, if you want less verbose logging, you can set the aforementioned environment variable to WARN, ERROR or FATAL. The default value for GATUS_LOG_LEVEL is INFO.

Endpoints

Endpoints are URLs, applications, or services that you want to monitor. Each endpoint has a list of conditions that are evaluated on an interval that you define. If any condition fails, the endpoint is considered as unhealthy. You can then configure alerts to be triggered when an endpoint is unhealthy once a certain threshold is reached.

| Parameter | Description | Default | |:------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------|:---------------------------| | endpoints | List of endpoints to monitor. | Required [] | | endpoints[].enabled | Whether to monitor the endpoint. | true | | endpoints[].name | Name of the endpoint. Can be anything. | Required "" | | endpoints[].group | Group name. Used to group multiple endpoints together on the dashboard.
See Endpoint groups. | "" | | endpoints[].url | URL to send the request to. | Required "" | | endpoints[].method | Request method. | GET | | endpoints[].conditions | Conditions used to determine the health of the endpoint.
See Conditions. | [] | | endpoints[].interval | Duration to wait between every status check. | 60s | | endpoints[].graphql | Whether to wrap the body in a query param ({"query":"$body"}). | false | | endpoints[].body | Request body. | "" | | endpoints[].headers | Request headers. | {} | | endpoints[].dns | Configuration for an endpoint of type DNS.
See Monitoring an endpoint using DNS queries. | "" | | endpoints[].dns.query-type | Query type (e.g. MX). | "" | | endpoints[].dns.query-name | Query name (e.g. example.com). | "" | | endpoints[].ssh | Configuration for an endpoint of type SSH.
See Monitoring an endpoint using SSH. | "" | | endpoints[].ssh.username | SSH username (e.g. example). | Required "" | | endpoints[].ssh.password | SSH password (e.g. password). | Required "" | | endpoints[].alerts | List of all alerts for a given endpoint.
See Alerting. | [] | | endpoints[].maintenance-windows | List of all maintenance windows for a given endpoint.
See Maintenance. | [] | | endpoints[].client | Client configuration. | {} | | endpoints[].ui | UI configuration at the endpoint level. | {} | | endpoints[].ui.hide-conditions | Whether to hide conditions from the results. Note that this only hides conditions from results evaluated from the moment this was enabled. | false | | endpoints[].ui.hide-hostname | Whether to hide the hostname from the results. | false | | endpoints[].ui.hide-port | Whether to hide the port from the results. | false | | endpoints[].ui.hide-url | Whether to hide the URL from the results. Useful if the URL contains a token. | false | | endpoints[].ui.hide-errors | Whether to hide errors from the results. | false | | endpoints[].ui.dont-resolve-failed-conditions | Whether to resolve failed conditions for the UI. | false | | endpoints[].ui.resolve-successful-conditions | Whether to resolve successful conditions for the UI (helpful to expose body assertions even when checks pass). | false | | endpoints[].ui.badge.response-time | List of response time thresholds. Each time a threshold is reached, the badge has a different color.

GitHub Stars & Activity

12,661Stars
895Forks
438Open issues
GoLanguage

GitHub Popularity

GitHub stars12,661
Forks895
Open issues438
Primary languageGo
LicenseApache-2.0
Stars gained today100
Created2019-09-04
Last pushed2026-11-09

Trending History

Daily boardrank #45 · ▲ 100 stars

Related GitHub Projects

1

prometheus / prometheus

Go★ 67,579⑂ 11,014▲ 213 stars
→
2

MHSanaei / 3x-ui

Go★ 49,588⑂ 12,697▲ 72 stars
→
3

XTLS / Xray-core

Go★ 42,748⑂ 6,126▲ 41 stars
→
4

vxcontrol / pentagi

Go★ 33,757⑂ 5,290▲ 97 stars
→
5

henrygd / beszel

Go★ 27,024⑂ 1,154▲ 104 stars
→
6

dsx-ai-factory / nvke

Go★ 995⑂ 116▲ 345 stars
→
7

obra / superpowers

Shell★ 314,802⑂ 28,005▲ 518 stars
→
8

anthropics / skills

Python★ 190,078⑂ 22,387▲ 792 stars
→

More Trending Repositories