gatus

Gatus

Go Report Card

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.

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

docker run -p 8080:8080 --name gatus twinproduction/gatus:stable

❤ Like this project? Please consider sponsoring me.

Gatus dashboard

Have any feedback or questions? Create a discussion.

Table of Contents

• Table of Contents
• Why Gatus?
• Features
• Usage
• Configuration
• Endpoints
• External Endpoints
• Suites (ALPHA)
• Conditions
  • Placeholders
  • Functions
• Web
• UI
• Announcements
• Storage
• Client configuration
• Tunneling
• Alerting
  • Configuring AWS SES alerts
  • Configuring ClickUp alerts
  • Configuring Datadog alerts
  • Configuring Discord alerts
  • Configuring Email alerts
  • Configuring Gitea alerts
  • Configuring GitHub alerts
  • Configuring GitLab alerts
  • Configuring Google Chat alerts
  • Configuring Gotify alerts
  • Configuring HomeAssistant alerts
  • Configuring IFTTT alerts
  • Configuring Ilert alerts
  • Configuring Incident.io alerts
  • Configuring Line alerts
  • Configuring Matrix alerts
  • Configuring Mattermost alerts
  • Configuring Messagebird alerts
  • Configuring n8n alerts
  • Configuring New Relic alerts
  • Configuring Ntfy alerts
  • Configuring Opsgenie alerts
  • Configuring PagerDuty alerts
  • Configuring Plivo alerts
  • Configuring Pushover alerts
  • Configuring Rocket.Chat alerts
  • Configuring SendGrid alerts
  • Configuring Signal alerts
  • Configuring SIGNL4 alerts
  • Configuring Slack alerts
  • Configuring Splunk alerts
  • Configuring Squadcast alerts
  • Configuring Teams alerts (Deprecated)
  • Configuring Teams Workflow alerts
  • Configuring Telegram alerts
  • Configuring Twilio alerts
  • Configuring Vonage alerts
  • Configuring Webex alerts
  • Configuring Zapier alerts
  • Configuring Zulip alerts
  • Configuring custom alerts
  • Setting a default alert
• Maintenance
• Security
  • Basic Authentication
  • OIDC
• TLS Encryption
• Metrics
  • Custom Labels
• Connectivity
• Remote instances (EXPERIMENTAL)
• Deployment
• Docker
• Helm Chart
• Terraform
  • Kubernetes
• Running the tests
• Using in Production
• FAQ
• Sending a GraphQL request
• Recommended interval
• Default timeouts
• Monitoring a TCP endpoint
• Monitoring a UDP endpoint
• Monitoring a SCTP endpoint
• Monitoring a WebSocket endpoint
• Monitoring an endpoint using gRPC
• Monitoring an endpoint using ICMP
• Monitoring an endpoint using DNS queries
• Monitoring an endpoint using SSH
• Monitoring an endpoint using STARTTLS
• Monitoring an endpoint using TLS
• Monitoring domain expiration
• Concurrency
• Reloading configuration on the fly
• Endpoint groups
• How do I sort by group by default?
• Exposing Gatus on a custom path
• Exposing Gatus on a custom port
• Use environment variables in config files
• Configuring a startup delay
• Keeping your configuration small
• Proxy client configuration
• How to fix 431 Request Header Fields Too Large error
• Badges
  • Uptime
  • Health
  • Health (Shields.io)
  • Response time
  • Response time (chart)
  • How to change the color thresholds of the response time badge
• API
  • Interacting with the API programmatically
  • Raw Data
  • Uptime
  • Response Time
• Installing as binary
• High level design overview

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:

• Highly flexible health check conditions: While checking the response status may be enough for some use cases, Gatus goes much further and allows you to add conditions on the response time, the response body and even the IP address.
• Ability to use Gatus for user acceptance tests: Thanks to the point above, you can leverage this application to create automated user acceptance tests.
• Very easy to configure: Not only is the configuration designed to be as readable as possible, it's also extremely easy to add a new service or a new endpoint to monitor.
• Alerting: While having a pretty visual dashboard is useful to keep track of the state of your application(s), you probably don't want to stare at it all day. Thus, notifications via Slack, Mattermost, Messagebird, PagerDuty, Twilio, Google chat and Teams are supported out of the box with the ability to configure a custom alerting provider for any needs you might have, whether it be a different provider or a custom application that manages automated rollbacks.
• Metrics
• Low resource consumption: As with most Go applications, the resource footprint that this application requires is negligibly small.
• Badges: Uptime 7d Response time 24h
• Dark mode

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(*<h1>Example Domain</h1>*)" # 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: - All maps/objects are deep merged (i.e. you could define alerting.slack in one file and alerting.pagerduty in another file) - All slices/arrays are appended (i.e. you can define endpoints in multiple files and each endpoint will be added to the final list of endpoints) - Parameters with a primitive value (e.g. metrics, alerting.slack.webhook-url, etc.) may only be defined once to forcefully avoid any ambiguity - To clarify, this also means that you could not define alerting.slack.webhook-url in two files with different values. All files are merged into one before they are processed. This is by design.

💡 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

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.

You may use the following placeholders in the body (endpoints[].body): - [ENDPOINT_NAME] (resolved from endpoints[].name) - [ENDPOINT_GROUP] (resolved from endpoints[].group) - [ENDPOINT_URL] (resolved from endpoints[].url) - [LOCAL_ADDRESS] (resolves to the local IP and port like 192.0.2.1:25 or [2001:db8::1]:80) - [RANDOM_STRING_N] (resolves to a random string of numbers and letters of length N (max: 8192))

External Endpoints

Unlike regular endpoints, external endpoints are not monitored by Gatus, but they are instead pushed programmatically. This allows you to monitor anything you want, even when what you want to check lives in an environment that would not normally be accessible by Gatus.

For instance: - You can create your own agent that lives in a private network and pushes the status of your services to a publicly-exposed Gatus instance - You can monitor services that are not supported by Gatus - You can implement your own monitoring system while using Gatus as the dashboard

Example:

external-endpoints:
  - name: ext-ep-test
    group: core
    token: "potato"
    heartbeat:
      interval: 30m  # Automatically create a failure if no update is received within 30 minutes
    alerts:
      - type: discord
        description: "healthcheck failed"
        send-on-resolved: true

To push the status of an external endpoint, you can use gatus-cli:

gatus-cli external-endpoint push --url https://status.example.org --key "core_ext-ep-test" --token "potato" --success

or send an HTTP request:

POST /api/v1/endpoints/{key}/external?success={success}&error={error}&duration={duration}

Where: - {key} has the pattern <GROUP_NAME>_<ENDPOINT_NAME> in which both variables have , /, _, ,, ., #, + and & replaced by -. - Using the example configuration above, the key would be core_ext-ep-test. - {success} is a boolean (true or false) value indicating whether the health check was successful or not. - {error} (optional): a string describing the reason for a failed health check. If {success} is false, this should contain the error message; if the check is successful, this will be ignored. - {duration} (optional): the time that the request took as a duration string (e.g. 10s).

You must also pass the token as a Bearer token in the Authorization header.

Suites (ALPHA)

Suites are collections of endpoints that are executed sequentially with a shared context. This allows you to create complex monitoring scenarios where the result from one endpoint can be used in subsequent endpoints, enabling workflow-style monitoring.

Here are a few cases in which suites could be useful: - Testing multi-step authentication flows (login -> access protected resource -> logout) - API workflows where you need to chain requests (create resource -> update -> verify -> delete) - Monitoring business processes that span multiple services - Validating data consistency across multiple endpoints

Note: Suite-level alerts are not supported yet. Configure alerts on individual endpoints within the suite instead.

Using Context in Endpoints

Once values are stored in the context, they can be referenced in subsequent endpoints: - In the URL: https://api.example.com/users/[CONTEXT].user_id - In headers: Authorization: Bearer [CONTEXT].auth_token - In the body: {"user_id": "[CONTEXT].user_id"} - In conditions: [BODY].server_ip == [CONTEXT].server_ip

Note that context/store keys are limited to A-Z, a-z, 0-9, underscores (_), and hyphens (-).

Example Suite Configuration

suites:
  - name: item-crud-workflow
    group: api-tests
    interval: 5m
    context:
      price: "19.99"  # Initial static value in context
    endpoints:
      # Step 1: Create an item and store the item ID
      - name: create-item
        url: https://api.example.com/items
        method: POST
        body: '{"name": "Test Item", "price": "[CONTEXT].price"}'
        conditions:
          - "[STATUS] == 201"
          - "len([BODY].id) > 0"
          - "[BODY].price == [CONTEXT].price"
        store:
          itemId: "[BODY].id"
        alerts:
          - type: slack
            description: "Failed to create item"

      # Step 2: Update the item using the stored item ID
      - name: update-item
        url: https://api.example.com/items/[CONTEXT].itemId
        method: PUT
        body: '{"price": "24.99"}'
        conditions:
          - "[STATUS] == 200"
        alerts:
          - type: slack
            description: "Failed to update item"

      # Step 3: Fetch the item and validate the price
      - name: get-item
        url: https://api.example.com/items/[CONTEXT].itemId
        method: GET
        conditions:
          - "[STATUS] == 200"
          - "[BODY].price == 24.99"
        alerts:
          - type: slack
            description: "Item price did not update correctly"

      # Step 4: Delete the item (always-run: true to ensure cleanup even if step 2 or 3 fails)
      - name: delete-item
        url: https://api.example.com/items/[CONTEXT].itemId
        method: DELETE
        always-run: true
        conditions:
          - "[STATUS] == 204"
        alerts:
          - type: slack
            description: "Failed to delete item"

The suite will be considered successful only if all required endpoints pass their conditions.

Conditions

Here are some examples of conditions you can use:

Placeholders

Functions

💡 Use pat only when you need to. [STATUS] == pat(2*) is a lot more expensive than [STATUS] < 300.

Web

Allows you to configure how and where the dashboard is being served.

UI

Allows you to configure the application wide defaults for the dashboard's UI. Some of these parameters can be overridden locally by users using the local storage of their browser.

Announcements

System-wide announcements allow you to display important messages at the top of the status page. These can be used to inform users about planned maintenance, ongoing issues, or general information. You can use markdown to format your announcements.

This is essentially what some status page calls "incident communications".

Types: - outage: Indicates service disruptions or critical issues (red theme) - warning: Indicates potential issues or important notices (yellow theme) - information: General information or updates (blue theme) - operational: Indicates resolved issues or normal operations (green theme) - none: Neutral announcements with no specific severity (gray theme, default if none are specified)

Example Configuration:

announcements:
  - timestamp: 2025-11-07T14:00:00Z
    type: outage
    message: "Scheduled maintenance on database servers from 14:00 to 16:00 UTC"
  - timestamp: 2025-11-07T16:15:00Z
    type: operational
    message: "Database maintenance completed successfully. All systems operational."
  - timestamp: 2025-11-07T12:00:00Z
    type: information
    message: "New monitoring dashboard features will be deployed next week"
  - timestamp: 2025-11-06T09:00:00Z
    type: warning
    message: "Elevated API response times observed for US customers"
    archived: true

If at least one announcement is archived, a Past Announcements section will be rendered at the bottom of the status page: Gatus past announcements section

Storage

The results for each endpoint health check as well as t

README 内容较长，此处已截断，完整内容请查看 GitHub 仓库。