2022-01-03 00:43:28 +00:00
2021-09-17 02:35:22 +00:00
2022-11-16 02:51:40 +00:00
2021-10-08 01:28:04 +00:00
[](https://goreportcard.com/report/github.com/TwiN/gatus)
[](https://codecov.io/gh/TwiN/gatus)
[](https://github.com/TwiN/gatus)
2021-09-17 02:35:22 +00:00
[](https://cloud.docker.com/repository/docker/twinproduction/gatus)
2021-10-08 01:28:04 +00:00
[](https://github.com/TwiN)
2021-09-17 02:35:22 +00:00
2022-04-28 21:56:02 +00:00
Gatus is a developer-oriented health dashboard that gives you the ability to monitor your services using HTTP, ICMP, TCP, and even DNS
2021-09-17 02:35:22 +00:00
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
2023-01-29 22:32:16 +00:00
checks can be paired with alerting via Slack, PagerDuty, Pushover, Discord, Twilio and more.
2021-09-17 02:35:22 +00:00
I personally deploy it in my Kubernetes cluster and let it monitor the status of my
2021-09-18 16:42:11 +00:00
core applications: https://status.twin.sh/
2021-09-17 02:35:22 +00:00
< details >
< summary > < b > Quick start< / b > < / summary >
2021-10-24 19:20:39 +00:00
```console
2021-09-17 02:35:22 +00:00
docker run -p 8080:8080 --name gatus twinproduction/gatus
```
2023-01-07 01:04:21 +00:00
You can also use GitHub Container Registry if you prefer:
```console
docker run -p 8080:8080 --name gatus ghcr.io/twin/gatus
```
2021-09-17 02:35:22 +00:00
For more details, see [Usage ](#usage )
< / details >
2023-01-07 01:04:21 +00:00
> ❤ Like this project? Please consider [sponsoring me](https://github.com/sponsors/TwiN).
2022-10-19 22:00:53 +00:00
2021-11-18 02:47:33 +00:00
2022-07-14 22:13:46 +00:00
Have any feedback or questions? [Create a discussion ](https://github.com/TwiN/gatus/discussions/new ).
2021-09-17 02:35:22 +00:00
2022-10-11 02:05:48 +00:00
2021-09-17 02:35:22 +00:00
## Table of Contents
- [Why Gatus? ](#why-gatus )
- [Features ](#features )
- [Usage ](#usage )
- [Configuration ](#configuration )
- [Conditions ](#conditions )
- [Placeholders ](#placeholders )
- [Functions ](#functions )
- [Storage ](#storage )
- [Client configuration ](#client-configuration )
- [Alerting ](#alerting )
- [Configuring Discord alerts ](#configuring-discord-alerts )
2021-12-03 02:05:17 +00:00
- [Configuring Email alerts ](#configuring-email-alerts )
2022-12-16 04:32:04 +00:00
- [Configuring GitHub alerts ](#configuring-github-alerts )
2022-01-16 05:06:03 +00:00
- [Configuring Google Chat alerts ](#configuring-google-chat-alerts )
2022-07-19 17:05:27 +00:00
- [Configuring Matrix alerts ](#configuring-matrix-alerts )
2021-09-17 02:35:22 +00:00
- [Configuring Mattermost alerts ](#configuring-mattermost-alerts )
- [Configuring Messagebird alerts ](#configuring-messagebird-alerts )
2022-10-09 20:30:55 +00:00
- [Configuring Ntfy alerts ](#configuring-ntfy-alerts )
2022-01-12 01:10:06 +00:00
- [Configuring Opsgenie alerts ](#configuring-opsgenie-alerts )
2021-09-17 02:35:22 +00:00
- [Configuring PagerDuty alerts ](#configuring-pagerduty-alerts )
2023-01-29 22:32:16 +00:00
- [Configuring Pushover alerts ](#configuring-pushover-alerts )
2021-09-17 02:35:22 +00:00
- [Configuring Slack alerts ](#configuring-slack-alerts )
- [Configuring Teams alerts ](#configuring-teams-alerts )
- [Configuring Telegram alerts ](#configuring-telegram-alerts )
- [Configuring Twilio alerts ](#configuring-twilio-alerts )
- [Configuring custom alerts ](#configuring-custom-alerts )
- [Setting a default alert ](#setting-a-default-alert )
2021-09-22 04:04:51 +00:00
- [Maintenance ](#maintenance )
2022-01-02 03:56:32 +00:00
- [Security ](#security )
- [Basic ](#basic )
2022-09-10 02:59:13 +00:00
- [OIDC ](#oidc )
2022-05-17 02:18:38 +00:00
- [Metrics ](#metrics )
2022-08-22 22:26:36 +00:00
- [Remote instances (EXPERIMENTAL) ](#remote-instances-experimental )
2021-09-17 02:35:22 +00:00
- [Deployment ](#deployment )
- [Docker ](#docker )
- [Helm Chart ](#helm-chart )
- [Terraform ](#terraform )
- [Running the tests ](#running-the-tests )
- [Using in Production ](#using-in-production )
- [FAQ ](#faq )
- [Sending a GraphQL request ](#sending-a-graphql-request )
- [Recommended interval ](#recommended-interval )
- [Default timeouts ](#default-timeouts )
2021-10-23 20:47:12 +00:00
- [Monitoring a TCP endpoint ](#monitoring-a-tcp-endpoint )
2022-11-10 00:22:13 +00:00
- [Monitoring a UDP endpoint ](#monitoring-a-udp-endpoint )
- [Monitoring a SCTP endpoint ](#monitoring-a-sctp-endpoint )
2021-10-23 20:47:12 +00:00
- [Monitoring an endpoint using ICMP ](#monitoring-an-endpoint-using-icmp )
- [Monitoring an endpoint using DNS queries ](#monitoring-an-endpoint-using-dns-queries )
- [Monitoring an endpoint using STARTTLS ](#monitoring-an-endpoint-using-starttls )
- [Monitoring an endpoint using TLS ](#monitoring-an-endpoint-using-tls )
2022-09-07 01:22:02 +00:00
- [Monitoring domain expiration ](#monitoring-domain-expiration )
2021-09-17 02:35:22 +00:00
- [disable-monitoring-lock ](#disable-monitoring-lock )
- [Reloading configuration on the fly ](#reloading-configuration-on-the-fly )
2021-10-23 20:47:12 +00:00
- [Endpoint groups ](#endpoint-groups )
2021-09-17 02:35:22 +00:00
- [Exposing Gatus on a custom port ](#exposing-gatus-on-a-custom-port )
2022-10-19 20:51:04 +00:00
- [Keeping your configuration small ](#keeping-your-configuration-small )
2021-09-17 02:35:22 +00:00
- [Badges ](#badges )
- [Uptime ](#uptime )
2022-06-20 17:59:45 +00:00
- [Health ](#health )
2021-09-17 02:35:22 +00:00
- [Response time ](#response-time )
- [API ](#api )
- [High level design overview ](#high-level-design-overview )
- [Sponsors ](#sponsors )
2022-10-11 02:05:48 +00:00
2021-09-17 02:35:22 +00:00
## 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’
Neither of these can tell you that there’
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
2021-12-09 06:13:12 +00:00
was to go down right now. Will any of your existing alerts be triggered? Your metrics won’
2022-01-24 01:06:55 +00:00
if no traffic makes it to your applications. This puts you in a situation where your clients are the ones
2021-09-17 02:35:22 +00:00
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.
2022-01-15 02:00:00 +00:00
- **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.
2021-09-17 02:35:22 +00:00
- **Metrics**
- **Low resource consumption**: As with most Go applications, the resource footprint that this application requires is negligibly small.
2021-11-08 07:22:43 +00:00
- **[Badges](#badges)**:  
2021-11-18 02:47:33 +00:00
- **Dark mode**
2021-09-17 02:35:22 +00:00
2022-10-19 22:00:53 +00:00
2021-09-17 02:35:22 +00:00
2022-10-11 02:05:48 +00:00
2021-09-17 02:35:22 +00:00
## Usage
2023-01-07 01:04:21 +00:00
< details >
< summary > < b > Quick start< / b > < / summary >
```console
docker run -p 8080:8080 --name gatus twinproduction/gatus
```
You can also use GitHub Container Registry if you prefer:
```console
docker run -p 8080:8080 --name gatus ghcr.io/twin/gatus
```
If you want to create your own configuration, see [Docker ](#docker ) for information on how to mount a configuration file.
< / details >
2021-09-17 02:35:22 +00:00
Here's a simple example:
```yaml
2021-10-23 20:47:12 +00:00
endpoints:
- name: website # Name of your endpoint, can be anything
2021-09-18 16:42:11 +00:00
url: "https://twin.sh/health"
2021-11-18 02:47:33 +00:00
interval: 5m # Duration to wait between every status check (default: 60s)
2021-09-17 02:35:22 +00:00
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
2022-12-22 22:38:17 +00:00
- name: make-sure-header-is-rendered
2021-09-17 02:35:22 +00:00
url: "https://example.org/"
2021-11-18 02:47:33 +00:00
interval: 60s
2021-09-17 02:35:22 +00:00
conditions:
2022-12-22 22:38:17 +00:00
- "[STATUS] == 200" # Status must be 200
- "[BODY] == pat(*< h1 > Example Domain</ h1 > *)" # Body must contain the specified header
2021-09-17 02:35:22 +00:00
```
2021-11-18 02:47:33 +00:00
This example would look similar to this:
2021-09-17 02:35:22 +00:00
2023-01-08 22:53:37 +00:00
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. `debug` , `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}`)
2021-09-17 02:35:22 +00:00
If you want to test it locally, see [Docker ](#docker ).
## Configuration
2022-12-07 03:36:33 +00:00
| Parameter | Description | Default |
|:------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------|:---------------------------|
| `debug` | Whether to enable debug logs. | `false` |
| `metrics` | Whether to expose metrics at /metrics. | `false` |
| `storage` | [Storage configuration ](#storage ) | `{}` |
| `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. < br /> See [Endpoint groups ](#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. < br /> See [Conditions ](#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. < br /> See [Monitoring an endpoint using DNS queries ](#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[].alerts[].type` | Type of alert. < br /> See [Alerting ](#alerting ) for all valid types. | Required `""` |
| `endpoints[].alerts[].enabled` | Whether to enable the alert. | `true` |
| `endpoints[].alerts[].failure-threshold` | Number of failures in a row needed before triggering the alert. | `3` |
| `endpoints[].alerts[].success-threshold` | Number of successes in a row before an ongoing incident is marked as resolved. | `2` |
| `endpoints[].alerts[].send-on-resolved` | Whether to send a notification once a triggered alert is marked as resolved. | `false` |
| `endpoints[].alerts[].description` | Description of the alert. Will be included in the alert sent. | `""` |
| `endpoints[].client` | [Client configuration ](#client-configuration ). | `{}` |
| `endpoints[].ui` | UI configuration at the endpoint level. | `{}` |
| `endpoints[].ui.hide-hostname` | Whether to hide the hostname in the result. | `false` |
| `endpoints[].ui.hide-url` | Whether to ensure the URL is not displayed in the results. Useful if the URL contains a token. | `false` |
| `endpoints[].ui.dont-resolve-failed-conditions` | Whether to resolve failed conditions for the UI. | `false` |
| `endpoints[].ui.badge.reponse-time` | List of response time thresholds. Each time a threshold is reached, the badge has a different color. | `[50, 200, 300, 500, 750]` |
| `alerting` | [Alerting configuration ](#alerting ). | `{}` |
| `security` | [Security configuration ](#security ). | `{}` |
| `disable-monitoring-lock` | Whether to [disable the monitoring lock ](#disable-monitoring-lock ). | `false` |
| `skip-invalid-config-update` | Whether to ignore invalid configuration update. < br /> See [Reloading configuration on the fly ](#reloading-configuration-on-the-fly ). | `false` |
| `web` | Web configuration. | `{}` |
| `web.address` | Address to listen on. | `0.0.0.0` |
| `web.port` | Port to listen on. | `8080` |
| `ui` | UI configuration. | `{}` |
| `ui.title` | [Title of the document ](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/title ). | `Health Dashboard ǀ |
| `ui.description` | Meta description for the page. | `Gatus is an advanced...` . |
| `ui.header` | Header at the top of the dashboard. | `Health Status` |
| `ui.logo` | URL to the logo to display. | `""` |
| `ui.link` | Link to open when the logo is clicked. | `""` |
| `ui.buttons` | List of buttons to display below the header. | `[]` |
| `ui.buttons[].name` | Text to display on the button. | Required `""` |
| `ui.buttons[].link` | Link to open when the button is clicked. | Required `""` |
| `maintenance` | [Maintenance configuration ](#maintenance ). | `{}` |
2021-09-17 02:35:22 +00:00
2023-01-07 01:04:21 +00:00
2021-09-17 02:35:22 +00:00
### Conditions
Here are some examples of conditions you can use:
2022-01-02 03:56:32 +00:00
| Condition | Description | Passing values | Failing values |
|:---------------------------------|:----------------------------------------------------|:---------------------------|------------------|
| `[STATUS] == 200` | Status must be equal to 200 | 200 | 201, 404, ... |
| `[STATUS] < 300` | Status must lower than 300 | 200, 201, 299 | 301, 302, ... |
| `[STATUS] <= 299` | Status must be less than or equal to 299 | 200, 201, 299 | 301, 302, ... |
| `[STATUS] > 400` | Status must be greater than 400 | 401, 402, 403, 404 | 400, 200, ... |
| `[STATUS] == any(200, 429)` | Status must be either 200 or 429 | 200, 429 | 201, 400, ... |
| `[CONNECTED] == true` | Connection to host must've been successful | true | false |
| `[RESPONSE_TIME] < 500` | Response time must be below 500ms | 100ms, 200ms, 300ms | 500ms, 501ms |
| `[IP] == 127.0.0.1` | Target IP must be 127.0.0.1 | 127.0.0.1 | 0.0.0.0 |
| `[BODY] == 1` | The body must be equal to 1 | 1 | `{}` , `2` , ... |
| `[BODY].user.name == john` | JSONPath value of `$.user.name` is equal to `john` | `{"user":{"name":"john"}}` | |
| `[BODY].data[0].id == 1` | JSONPath value of `$.data[0].id` is equal to 1 | `{"data":[{"id":1}]}` | |
| `[BODY].age == [BODY].id` | JSONPath value of `$.age` is equal JSONPath `$.id` | `{"age":1,"id":1}` | |
| `len([BODY].data) < 5` | Array at JSONPath `$.data` has less than 5 elements | `{"data":[{"id":1}]}` | |
| `len([BODY].name) == 8` | String at JSONPath `$.name` has a length of 8 | `{"name":"john.doe"}` | `{"name":"bob"}` |
| `has([BODY].errors) == false` | JSONPath `$.errors` does not exist | `{"name":"john.doe"}` | `{"errors":[]}` |
| `has([BODY].users) == true` | JSONPath `$.users` exists | `{"users":[]}` | `{}` |
| `[BODY].name == pat(john*)` | String at JSONPath `$.name` matches pattern `john*` | `{"name":"john.doe"}` | `{"name":"bob"}` |
| `[BODY].id == any(1, 2)` | Value at JSONPath `$.id` is equal to `1` or `2` | 1, 2 | 3, 4, 5 |
| `[CERTIFICATE_EXPIRATION] > 48h` | Certificate expiration is more than 48h away | 49h, 50h, 123h | 1h, 24h, ... |
2022-09-07 01:22:02 +00:00
| `[DOMAIN_EXPIRATION] > 720h` | The domain must expire in more than 720h | 4000h | 1h, 24h, ... |
2021-09-17 02:35:22 +00:00
#### Placeholders
2022-05-29 19:14:25 +00:00
| Placeholder | Description | Example of resolved value |
|:---------------------------|:------------------------------------------------------------------------------------------|:---------------------------------------------|
2022-09-07 01:22:02 +00:00
| `[STATUS]` | Resolves into the HTTP status of the request | `404` |
| `[RESPONSE_TIME]` | Resolves into the response time the request took, in ms | `10` |
| `[IP]` | Resolves into the IP of the target host | `192.168.0.232` |
2022-05-29 19:14:25 +00:00
| `[BODY]` | Resolves into the response body. Supports JSONPath. | `{"name":"john.doe"}` |
| `[CONNECTED]` | Resolves into whether a connection could be established | `true` |
| `[CERTIFICATE_EXPIRATION]` | Resolves into the duration before certificate expiration (valid units are "s", "m", "h".) | `24h` , `48h` , 0 (if not protocol with certs) |
2022-09-07 01:22:02 +00:00
| `[DOMAIN_EXPIRATION]` | Resolves into the duration before the domain expires (valid units are "s", "m", "h".) | `24h` , `48h` , `1234h56m78s` |
| `[DNS_RCODE]` | Resolves into the DNS status of the response | `NOERROR` |
2021-09-17 02:35:22 +00:00
#### Functions
2022-11-23 03:21:35 +00:00
| Function | Description | Example |
|:---------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------------------|
| `len` | If the given path leads to an array, returns its length. Otherwise, the JSON at the given path is minified and converted to a string, and the resulting number of characters is returned. Works only with the `[BODY]` placeholder. | `len([BODY].username) > 8` |
| `has` | Returns `true` or `false` based on whether a given path is valid. Works only with the `[BODY]` placeholder. | `has([BODY].errors) == false` |
| `pat` | Specifies that the string passed as parameter should be evaluated as a pattern. Works only with `==` and `!=` . | `[IP] == pat(192.168.*)` |
| `any` | Specifies that any one of the values passed as parameters is a valid value. Works only with `==` and `!=` . | `[BODY].ip == any(127.0.0.1, ::1)` |
2021-09-17 02:35:22 +00:00
2023-01-07 01:04:21 +00:00
> 💡 Use `pat` only when you need to. `[STATUS] == pat(2*)` is a lot more expensive than `[STATUS] < 300`.
2021-09-17 02:35:22 +00:00
### Storage
2022-08-18 23:18:16 +00:00
| Parameter | Description | Default |
|:------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------|:-----------|
| `storage` | Storage configuration | `{}` |
| `storage.path` | Path to persist the data in. Only supported for types `sqlite` and `postgres` . | `""` |
| `storage.type` | Type of storage. Valid types: `memory` , `sqlite` , `postgres` . | `"memory"` |
| `storage.caching` | Whether to use write-through caching. Improves loading time for large dashboards. < br /> Only supported if `storage.type` is `sqlite` or `postgres` | `false` |
2021-09-17 02:35:22 +00:00
2023-01-29 21:47:25 +00:00
The results for each endpoint health check as well as the data for uptime and the past events must be persisted
so that they can be displayed on the dashboard. These parameters allow you to configure the storage in question.
2021-11-05 01:40:05 +00:00
- If `storage.type` is `memory` (default):
```yaml
# Note that this is the default value, and you can omit the storage configuration altogether to achieve the same result.
# Because the data is stored in memory, the data will not survive a restart.
storage:
type: memory
```
- If `storage.type` is `sqlite` , `storage.path` must not be blank:
2021-09-17 02:35:22 +00:00
```yaml
storage:
type: sqlite
2021-11-05 01:33:13 +00:00
path: data.db
2021-09-17 02:35:22 +00:00
```
2021-10-24 19:20:39 +00:00
See [examples/docker-compose-sqlite-storage ](.examples/docker-compose-sqlite-storage ) for an example.
2021-09-17 02:35:22 +00:00
2021-11-05 01:40:05 +00:00
- If `storage.type` is `postgres` , `storage.path` must be the connection URL:
2021-09-17 02:35:22 +00:00
```yaml
storage:
type: postgres
2021-11-05 01:33:13 +00:00
path: "postgres://user:password@127.0.0.1:5432/gatus?sslmode=disable"
2021-09-17 02:35:22 +00:00
```
2021-10-24 19:20:39 +00:00
See [examples/docker-compose-postgres-storage ](.examples/docker-compose-postgres-storage ) for an example.
2021-09-17 02:35:22 +00:00
### Client configuration
2022-07-16 04:44:07 +00:00
In order to support a wide range of environments, each monitored endpoint has a unique configuration for
2021-09-17 02:35:22 +00:00
the client used to send the request.
2022-03-10 01:53:51 +00:00
| Parameter | Description | Default |
|:------------------------------|:---------------------------------------------------------------------------|:----------------|
| `client.insecure` | Whether to skip verifying the server's certificate chain and host name. | `false` |
| `client.ignore-redirect` | Whether to ignore redirects (true) or follow them (false, default). | `false` |
| `client.timeout` | Duration before timing out. | `10s` |
2022-06-12 22:45:08 +00:00
| `client.dns-resolver` | Override the DNS resolver using the format `{proto}://{host}:{port}` . | `""` |
2022-03-10 01:53:51 +00:00
| `client.oauth2` | OAuth2 client configuration. | `{}` |
| `client.oauth2.token-url` | The token endpoint URL | required `""` |
| `client.oauth2.client-id` | The client id which should be used for the `Client credentials flow` | required `""` |
| `client.oauth2.client-secret` | The client secret which should be used for the `Client credentials flow` | required `""` |
| `client.oauth2.scopes[]` | A list of `scopes` which should be used for the `Client credentials flow` . | required `[""]` |
2021-09-17 02:35:22 +00:00
2023-01-07 01:04:21 +00:00
> 📝 Some of these parameters are ignored based on the type of endpoint. For instance, there's no certificate involved
2021-10-23 20:47:12 +00:00
in ICMP requests (ping), therefore, setting `client.insecure` to `true` for an endpoint of that type will not do anything.
2021-09-17 02:35:22 +00:00
This default configuration is as follows:
```yaml
client:
insecure: false
ignore-redirect: false
timeout: 10s
```
2021-10-23 20:47:12 +00:00
Note that this configuration is only available under `endpoints[]` , `alerting.mattermost` and `alerting.custom` .
2021-09-17 02:35:22 +00:00
2021-10-23 20:47:12 +00:00
Here's an example with the client configuration under `endpoints[]` :
2021-09-17 02:35:22 +00:00
```yaml
2021-10-23 20:47:12 +00:00
endpoints:
2021-09-18 16:42:11 +00:00
- name: website
url: "https://twin.sh/health"
2021-09-17 02:35:22 +00:00
client:
insecure: false
ignore-redirect: false
timeout: 10s
conditions:
- "[STATUS] == 200"
```
2022-06-12 23:13:50 +00:00
This example shows how you can specify a custom DNS resolver:
2022-06-12 22:45:08 +00:00
```yaml
endpoints:
2022-06-12 23:13:50 +00:00
- name: with-custom-dns-resolver
url: "https://your.health.api/health"
2022-06-12 22:45:08 +00:00
client:
2022-11-16 02:48:14 +00:00
dns-resolver: "tcp://8.8.8.8:53"
2022-06-12 22:45:08 +00:00
conditions:
- "[STATUS] == 200"
```
2022-03-10 01:53:51 +00:00
This example shows how you can use the `client.oauth2` configuration to query a backend API with `Bearer token` :
```yaml
endpoints:
2022-06-12 23:13:50 +00:00
- name: with-custom-oauth2
url: "https://your.health.api/health"
2022-03-10 01:53:51 +00:00
client:
oauth2:
token-url: https://your-token-server/token
client-id: 00000000-0000-0000-0000-000000000000
client-secret: your-client-secret
scopes: ['https://your.health.api/.default']
conditions:
- "[STATUS] == 200"
```
2021-09-17 02:35:22 +00:00
2022-10-09 20:30:55 +00:00
2021-09-17 02:35:22 +00:00
### Alerting
Gatus supports multiple alerting providers, such as Slack and PagerDuty, and supports different alerts for each
2021-10-23 20:47:12 +00:00
individual endpoints with configurable descriptions and thresholds.
2021-09-17 02:35:22 +00:00
2023-01-07 01:04:21 +00:00
> 📝 If an alerting provider is not properly configured, all alerts configured with the provider's type will be
2021-09-17 02:35:22 +00:00
ignored.
2022-01-02 03:56:32 +00:00
| Parameter | Description | Default |
|:-----------------------|:-----------------------------------------------------------------------------------------------------------------------------|:--------|
2022-12-07 03:36:33 +00:00
| `alerting.custom` | Configuration for custom actions on failure or alerts. < br /> See [Configuring Custom alerts ](#configuring-custom-alerts ). | `{}` |
2022-01-02 03:56:32 +00:00
| `alerting.discord` | Configuration for alerts of type `discord` . < br /> See [Configuring Discord alerts ](#configuring-discord-alerts ). | `{}` |
| `alerting.email` | Configuration for alerts of type `email` . < br /> See [Configuring Email alerts ](#configuring-email-alerts ). | `{}` |
2022-12-16 04:32:04 +00:00
| `alerting.github` | Configuration for alerts of type `github` . < br /> See [Configuring GitHub alerts ](#configuring-github-alerts ). | `{}` |
2022-01-16 05:06:03 +00:00
| `alerting.googlechat` | Configuration for alerts of type `googlechat` . < br /> See [Configuring Google Chat alerts ](#configuring-google-chat-alerts ). | `{}` |
2022-10-09 20:30:55 +00:00
| `alerting.matrix` | Configuration for alerts of type `matrix` . < br /> See [Configuring Matrix alerts ](#configuring-matrix-alerts ). | `{}` |
2022-01-02 03:56:32 +00:00
| `alerting.mattermost` | Configuration for alerts of type `mattermost` . < br /> See [Configuring Mattermost alerts ](#configuring-mattermost-alerts ). | `{}` |
| `alerting.messagebird` | Configuration for alerts of type `messagebird` . < br /> See [Configuring Messagebird alerts ](#configuring-messagebird-alerts ). | `{}` |
2022-10-09 20:30:55 +00:00
| `alerting.ntfy` | Configuration for alerts of type `ntfy` . < br /> See [Configuring Ntfy alerts ](#configuring-ntfy-alerts ). | `{}` |
2022-01-02 03:56:32 +00:00
| `alerting.opsgenie` | Configuration for alerts of type `opsgenie` . < br /> See [Configuring Opsgenie alerts ](#configuring-opsgenie-alerts ). | `{}` |
| `alerting.pagerduty` | Configuration for alerts of type `pagerduty` . < br /> See [Configuring PagerDuty alerts ](#configuring-pagerduty-alerts ). | `{}` |
2023-01-29 22:32:16 +00:00
| `alerting.pushover` | Configuration for alerts of type `pushover` . < br /> See [Configuring Pushover alerts ](#configuring-pushover-alerts ). | `{}` |
2022-01-02 03:56:32 +00:00
| `alerting.slack` | Configuration for alerts of type `slack` . < br /> See [Configuring Slack alerts ](#configuring-slack-alerts ). | `{}` |
| `alerting.teams` | Configuration for alerts of type `teams` . < br /> See [Configuring Teams alerts ](#configuring-teams-alerts ). | `{}` |
| `alerting.telegram` | Configuration for alerts of type `telegram` . < br /> See [Configuring Telegram alerts ](#configuring-telegram-alerts ). | `{}` |
| `alerting.twilio` | Settings for alerts of type `twilio` . < br /> See [Configuring Twilio alerts ](#configuring-twilio-alerts ). | `{}` |
2021-09-17 02:35:22 +00:00
2022-10-09 20:30:55 +00:00
2021-09-17 02:35:22 +00:00
#### Configuring Discord alerts
2022-04-12 00:30:21 +00:00
| Parameter | Description | Default |
2022-04-25 23:55:17 +00:00
|:-------------------------------------------|:-------------------------------------------------------------------------------------------|:--------------|
2022-04-12 00:30:21 +00:00
| `alerting.discord` | Configuration for alerts of type `discord` | `{}` |
| `alerting.discord.webhook-url` | Discord Webhook URL | Required `""` |
| `alerting.discord.default-alert` | Default alert configuration. < br /> See [Setting a default alert ](#setting-a-default-alert ) | N/A |
| `alerting.discord.overrides` | List of overrides that may be prioritized over the default configuration | `[]` |
| `alerting.discord.overrides[].group` | Endpoint group for which the configuration will be overridden by this configuration | `""` |
| `alerting.discord.overrides[].webhook-url` | Discord Webhook URL | `""` |
2021-09-17 02:35:22 +00:00
```yaml
alerting:
2022-07-16 04:44:07 +00:00
discord:
2021-09-17 02:35:22 +00:00
webhook-url: "https://discord.com/api/webhooks/**********/**********"
2021-10-23 20:47:12 +00:00
endpoints:
2021-09-18 16:42:11 +00:00
- name: website
url: "https://twin.sh/health"
2022-06-12 20:31:43 +00:00
interval: 5m
2021-09-17 02:35:22 +00:00
conditions:
- "[STATUS] == 200"
- "[BODY].status == UP"
- "[RESPONSE_TIME] < 300 "
alerts:
- type: discord
description: "healthcheck failed"
send-on-resolved: true
```
2022-10-09 20:30:55 +00:00
2021-12-03 02:05:17 +00:00
#### Configuring Email alerts
2022-03-21 01:54:20 +00:00
| Parameter | Description | Default |
2022-04-25 23:55:17 +00:00
|:-----------------------------------|:-------------------------------------------------------------------------------------------|:--------------|
2022-03-21 01:54:20 +00:00
| `alerting.email` | Configuration for alerts of type `email` | `{}` |
| `alerting.email.from` | Email used to send the alert | Required `""` |
| `alerting.email.username` | Username of the SMTP server used to send the alert. If empty, uses `alerting.email.from` . | `""` |
| `alerting.email.password` | Password of the SMTP server used to send the alert | Required `""` |
| `alerting.email.host` | Host of the mail server (e.g. `smtp.gmail.com` ) | Required `""` |
| `alerting.email.port` | Port the mail server is listening to (e.g. `587` ) | Required `0` |
| `alerting.email.to` | Email(s) to send the alerts to | Required `""` |
| `alerting.email.default-alert` | Default alert configuration. < br /> See [Setting a default alert ](#setting-a-default-alert ) | N/A |
| `alerting.email.overrides` | List of overrides that may be prioritized over the default configuration | `[]` |
| `alerting.email.overrides[].group` | Endpoint group for which the configuration will be overridden by this configuration | `""` |
| `alerting.email.overrides[].to` | Email(s) to send the alerts to | `""` |
2021-12-03 02:05:17 +00:00
```yaml
alerting:
email:
from: "from@example.com"
2022-01-12 01:07:25 +00:00
username: "from@example.com"
2021-12-03 02:05:17 +00:00
password: "hunter2"
host: "mail.example.com"
port: 587
to: "recipient1@example.com,recipient2@example.com"
2022-07-16 04:44:07 +00:00
# You can also add group-specific to keys, which will
2022-03-21 01:54:20 +00:00
# override the to key above for the specified groups
overrides:
- group: "core"
to: "recipient3@example.com,recipient4@example.com"
2021-12-03 02:05:17 +00:00
endpoints:
- name: website
url: "https://twin.sh/health"
interval: 5m
conditions:
- "[STATUS] == 200"
- "[BODY].status == UP"
- "[RESPONSE_TIME] < 300 "
alerts:
- type: email
description: "healthcheck failed"
send-on-resolved: true
2022-03-21 01:54:20 +00:00
- name: back-end
group: core
url: "https://example.org/"
interval: 5m
conditions:
- "[STATUS] == 200"
- "[CERTIFICATE_EXPIRATION] > 48h"
alerts:
- type: email
description: "healthcheck failed"
send-on-resolved: true
2021-12-03 02:05:17 +00:00
```
2023-01-07 01:04:21 +00:00
> ⚠ Some mail servers are painfully slow.
2021-12-03 02:05:17 +00:00
2022-10-09 20:30:55 +00:00
2022-12-16 04:32:04 +00:00
#### Configuring GitHub alerts
| Parameter | Description | Default |
|:---------------------------------|:-----------------------------------------------------------------------------------------------------------|:--------------|
| `alerting.github` | Configuration for alerts of type `github` | `{}` |
| `alerting.github.repository-url` | GitHub repository URL (e.g. `https://github.com/TwiN/example` ) | Required `""` |
| `alerting.github.token` | Personal access token to use for authentication. < br /> Must have at least RW on issues and RO on metadata. | Required `""` |
| `alerting.github.default-alert` | Default alert configuration. < br /> See [Setting a default alert ](#setting-a-default-alert ). | N/A |
2022-05-07 18:34:21 +00:00
2022-12-16 04:32:04 +00:00
The GitHub alerting provider creates an issue prefixed with `alert(gatus):` and suffixed with the endpoint's display
name for each alert. If `send-on-resolved` is set to `true` on the endpoint alert, the issue will be automatically
closed when the alert is resolved.
```yaml
alerting:
github:
repository-url: "https://github.com/TwiN/test"
token: "github_pat_12345..."
endpoints:
- name: example
url: "https://twin.sh/health"
interval: 5m
conditions:
- "[STATUS] == 200"
- "[BODY].status == UP"
- "[RESPONSE_TIME] < 75 "
alerts:
- type: github
failure-threshold: 2
success-threshold: 3
send-on-resolved: true
description: "Everything's burning AAAAAHHHHHHHHHHHHHHH"
```
#### Configuring Google Chat alerts
2022-05-07 18:34:21 +00:00
| Parameter | Description | Default |
2022-06-12 02:17:34 +00:00
|:----------------------------------------------|:--------------------------------------------------------------------------------------------|:--------------|
2022-05-07 18:34:21 +00:00
| `alerting.googlechat` | Configuration for alerts of type `googlechat` | `{}` |
| `alerting.googlechat.webhook-url` | Google Chat Webhook URL | Required `""` |
| `alerting.googlechat.client` | Client configuration. < br /> See [Client configuration ](#client-configuration ). | `{}` |
| `alerting.googlechat.default-alert` | Default alert configuration. < br /> See [Setting a default alert ](#setting-a-default-alert ). | N/A |
| `alerting.googlechat.overrides` | List of overrides that may be prioritized over the default configuration | `[]` |
| `alerting.googlechat.overrides[].group` | Endpoint group for which the configuration will be overridden by this configuration | `""` |
2022-12-16 04:32:04 +00:00
| `alerting.googlechat.overrides[].webhook-url` | Google Chat Webhook URL | `""` |
2022-01-15 02:00:00 +00:00
```yaml
alerting:
2022-07-16 04:44:07 +00:00
googlechat:
2022-01-15 02:00:00 +00:00
webhook-url: "https://chat.googleapis.com/v1/spaces/*******/messages?key=**********& token=********"
endpoints:
- name: website
url: "https://twin.sh/health"
2022-10-09 20:30:55 +00:00
interval: 5m
2022-01-15 02:00:00 +00:00
conditions:
- "[STATUS] == 200"
- "[BODY].status == UP"
- "[RESPONSE_TIME] < 300 "
alerts:
- type: googlechat
description: "healthcheck failed"
send-on-resolved: true
```
2022-10-09 20:30:55 +00:00
2022-07-19 17:05:27 +00:00
#### Configuring Matrix alerts
2022-09-20 02:08:39 +00:00
| Parameter | Description | Default |
|:-----------------------------------------|:-------------------------------------------------------------------------------------------|:-----------------------------------|
2022-10-09 20:30:55 +00:00
| `alerting.matrix` | Configuration for alerts of type `matrix` | `{}` |
2022-09-20 02:08:39 +00:00
| `alerting.matrix.server-url` | Homeserver URL | `https://matrix-client.matrix.org` |
| `alerting.matrix.access-token` | Bot user access token (see https://webapps.stackexchange.com/q/131056) | Required `""` |
| `alerting.matrix.internal-room-id` | Internal room ID of room to send alerts to (can be found in Room Settings > Advanced) | Required `""` |
| `alerting.matrix.default-alert` | Default alert configuration. < br /> See [Setting a default alert ](#setting-a-default-alert ) | N/A |
2022-07-19 17:05:27 +00:00
```yaml
alerting:
matrix:
2022-09-20 02:08:39 +00:00
server-url: "https://matrix-client.matrix.org"
access-token: "123456"
internal-room-id: "!example:matrix.org"
2022-07-19 17:05:27 +00:00
endpoints:
- name: website
2022-10-09 20:30:55 +00:00
interval: 5m
2022-07-19 17:05:27 +00:00
url: "https://twin.sh/health"
conditions:
- "[STATUS] == 200"
- "[BODY].status == UP"
- "[RESPONSE_TIME] < 300 "
alerts:
- type: matrix
send-on-resolved: true
description: "healthcheck failed"
```
2022-10-09 20:30:55 +00:00
2021-09-17 02:35:22 +00:00
#### Configuring Mattermost alerts
2022-06-16 03:25:37 +00:00
| Parameter | Description | Default |
|:----------------------------------------------|:--------------------------------------------------------------------------------------------|:--------------|
| `alerting.mattermost` | Configuration for alerts of type `mattermost` | `{}` |
| `alerting.mattermost.webhook-url` | Mattermost Webhook URL | Required `""` |
| `alerting.mattermost.client` | Client configuration. < br /> See [Client configuration ](#client-configuration ). | `{}` |
| `alerting.mattermost.default-alert` | Default alert configuration. < br /> See [Setting a default alert ](#setting-a-default-alert ). | N/A |
| `alerting.mattermost.overrides` | List of overrides that may be prioritized over the default configuration | `[]` |
| `alerting.mattermost.overrides[].group` | Endpoint group for which the configuration will be overridden by this configuration | `""` |
| `alerting.mattermist.overrides[].webhook-url` | Mattermost Webhook URL | `""` |
2021-09-17 02:35:22 +00:00
```yaml
alerting:
2022-07-16 04:44:07 +00:00
mattermost:
2021-09-17 02:35:22 +00:00
webhook-url: "http://**********/hooks/**********"
client:
insecure: true
2021-10-23 20:47:12 +00:00
endpoints:
2021-09-18 16:42:11 +00:00
- name: website
url: "https://twin.sh/health"
2022-10-09 20:30:55 +00:00
interval: 5m
2021-09-17 02:35:22 +00:00
conditions:
- "[STATUS] == 200"
- "[BODY].status == UP"
- "[RESPONSE_TIME] < 300 "
alerts:
- type: mattermost
description: "healthcheck failed"
send-on-resolved: true
```
Here's an example of what the notifications look like:
2022-10-09 20:30:55 +00:00
2021-09-17 02:35:22 +00:00
#### Configuring Messagebird alerts
2022-01-02 03:56:32 +00:00
| Parameter | Description | Default |
|:-------------------------------------|:-------------------------------------------------------------------------------------------|:--------------|
2022-10-09 20:30:55 +00:00
| `alerting.messagebird` | Configuration for alerts of type `messagebird` | `{}` |
2022-01-02 03:56:32 +00:00
| `alerting.messagebird.access-key` | Messagebird access key | Required `""` |
| `alerting.messagebird.originator` | The sender of the message | Required `""` |
| `alerting.messagebird.recipients` | The recipients of the message | Required `""` |
| `alerting.messagebird.default-alert` | Default alert configuration. < br /> See [Setting a default alert ](#setting-a-default-alert ) | N/A |
2021-09-17 02:35:22 +00:00
Example of sending **SMS** text message alert using Messagebird:
```yaml
alerting:
messagebird:
access-key: "..."
originator: "31619191918"
recipients: "31619191919,31619191920"
2021-10-23 20:47:12 +00:00
endpoints:
2021-09-18 16:42:11 +00:00
- name: website
2022-10-09 20:30:55 +00:00
interval: 5m
2021-09-18 16:42:11 +00:00
url: "https://twin.sh/health"
2021-09-17 02:35:22 +00:00
conditions:
- "[STATUS] == 200"
- "[BODY].status == UP"
- "[RESPONSE_TIME] < 300 "
alerts:
- type: messagebird
failure-threshold: 3
send-on-resolved: true
description: "healthcheck failed"
```
2022-01-12 01:10:06 +00:00
2022-10-09 20:30:55 +00:00
#### Configuring Ntfy alerts
| Parameter | Description | Default |
|:------------------------------|:-------------------------------------------------------------------------------------------|:------------------|
| `alerting.ntfy` | Configuration for alerts of type `ntfy` | `{}` |
| `alerting.ntfy.topic` | Topic at which the alert will be sent | Required `""` |
| `alerting.ntfy.url` | The URL of the target server | `https://ntfy.sh` |
| `alerting.ntfy.priority` | The priority of the alert | `3` |
| `alerting.ntfy.default-alert` | Default alert configuration. < br /> See [Setting a default alert ](#setting-a-default-alert ) | N/A |
[ntfy ](https://github.com/binwiederhier/ntfy ) is an amazing project that allows you to subscribe to desktop
and mobile notifications, making it an awesome addition to Gatus.
Example:
```yaml
alerting:
ntfy:
topic: "gatus-test-topic"
priority: 2
default-alert:
failure-threshold: 3
send-on-resolved: true
endpoints:
- name: website
interval: 5m
url: "https://twin.sh/health"
conditions:
- "[STATUS] == 200"
- "[BODY].status == UP"
- "[RESPONSE_TIME] < 300 "
alerts:
- type: ntfy
```
2021-12-10 01:32:38 +00:00
#### Configuring Opsgenie alerts
2022-01-12 01:22:44 +00:00
| Parameter | Description | Default |
|:----------------------------------|:-------------------------------------------------------------------------------------------|:---------------------|
| `alerting.opsgenie` | Configuration for alerts of type `opsgenie` | `{}` |
| `alerting.opsgenie.api-key` | Opsgenie API Key | Required `""` |
| `alerting.opsgenie.priority` | Priority level of the alert. | `P1` |
| `alerting.opsgenie.source` | Source field of the alert. | `gatus` |
| `alerting.opsgenie.entity-prefix` | Entity field prefix. | `gatus-` |
| `alerting.opsgenie.alias-prefix` | Alias field prefix. | `gatus-healthcheck-` |
| `alerting.opsgenie.tags` | Tags of alert. | `[]` |
| `alerting.opsgenie.default-alert` | Default alert configuration. < br /> See [Setting a default alert ](#setting-a-default-alert ) | N/A |
2021-12-10 01:32:38 +00:00
Opsgenie provider will automatically open and close alerts.
```yaml
alerting:
opsgenie:
api-key: "00000000-0000-0000-0000-000000000000"
```
2021-09-17 02:35:22 +00:00
2022-01-12 01:10:06 +00:00
2021-09-17 02:35:22 +00:00
#### Configuring PagerDuty alerts
2022-01-02 03:56:32 +00:00
| Parameter | Description | Default |
|:-------------------------------------------------|:-------------------------------------------------------------------------------------------|:--------|
| `alerting.pagerduty` | Configuration for alerts of type `pagerduty` | `{}` |
| `alerting.pagerduty.integration-key` | PagerDuty Events API v2 integration key | `""` |
| `alerting.pagerduty.overrides` | List of overrides that may be prioritized over the default configuration | `[]` |
| `alerting.pagerduty.overrides[].group` | Endpoint group for which the configuration will be overridden by this configuration | `""` |
| `alerting.pagerduty.overrides[].integration-key` | PagerDuty Events API v2 integration key | `""` |
2022-01-12 01:22:44 +00:00
| `alerting.pagerduty.default-alert` | Default alert configuration. < br /> See [Setting a default alert ](#setting-a-default-alert ) | N/A |
2021-09-17 02:35:22 +00:00
2021-10-23 20:47:12 +00:00
It is highly recommended to set `endpoints[].alerts[].send-on-resolved` to `true` for alerts
2021-09-17 02:35:22 +00:00
of type `pagerduty` , because unlike other alerts, the operation resulting from setting said
2022-01-24 01:06:55 +00:00
parameter to `true` will not create another incident but mark the incident as resolved on
2021-09-17 02:35:22 +00:00
PagerDuty instead.
2021-10-06 00:01:36 +00:00
Behavior:
2021-10-06 00:40:44 +00:00
- By default, `alerting.pagerduty.integration-key` is used as the integration key
2021-10-23 20:47:12 +00:00
- If the endpoint being evaluated belongs to a group (`endpoints[].group`) matching the value of `alerting.pagerduty.overrides[].group` , the provider will use that override's integration key instead of `alerting.pagerduty.integration-key` 's
2021-10-06 00:01:36 +00:00
2021-09-17 02:35:22 +00:00
```yaml
alerting:
2022-07-16 04:44:07 +00:00
pagerduty:
2021-09-17 02:35:22 +00:00
integration-key: "********************************"
2022-07-16 04:44:07 +00:00
# You can also add group-specific integration keys, which will
2021-10-06 00:40:44 +00:00
# override the integration key above for the specified groups
overrides:
2022-03-21 01:54:20 +00:00
- group: "core"
integration-key: "********************************"
2021-09-17 02:35:22 +00:00
2021-10-23 20:47:12 +00:00
endpoints:
2021-09-18 16:42:11 +00:00
- name: website
url: "https://twin.sh/health"
2021-09-17 02:35:22 +00:00
interval: 30s
conditions:
- "[STATUS] == 200"
- "[BODY].status == UP"
- "[RESPONSE_TIME] < 300 "
alerts:
- type: pagerduty
failure-threshold: 3
success-threshold: 5
send-on-resolved: true
description: "healthcheck failed"
2021-10-06 00:40:44 +00:00
2021-10-06 00:01:36 +00:00
- name: back-end
group: core
url: "https://example.org/"
interval: 5m
conditions:
- "[STATUS] == 200"
- "[CERTIFICATE_EXPIRATION] > 48h"
alerts:
- type: pagerduty
failure-threshold: 3
success-threshold: 5
send-on-resolved: true
description: "healthcheck failed"
2021-09-17 02:35:22 +00:00
```
2023-01-29 22:32:16 +00:00
#### Configuring Pushover alerts
| Parameter | Description | Default |
|:---------------------------------------|:-------------------------------------------------------------------------------------------|:-----------------------------|
| `alerting.pushover` | Configuration for alerts of type `pushover` | `{}` |
| `alerting.pushover.application-token` | Pushover Application token | `""` |
| `alerting.pushover.user-key` | User or group key | `""` |
| `alerting.pushover.title` | A fixed title for all messages sent via Pushover | Name of your App in Pushover |
| `alerting.pushover.priority` | Priority of all messages, ranging from -2 (very low) to 2 (Emergency) | `0` |
| `alerting.pushover.default-alert` | Default alert configuration. < br /> See [Setting a default alert ](#setting-a-default-alert ) | N/A |
```yaml
alerting:
pushover:
application-token: "******************************"
user-key: "******************************"
endpoints:
- name: website
url: "https://twin.sh/health"
interval: 30s
conditions:
- "[STATUS] == 200"
- "[BODY].status == UP"
- "[RESPONSE_TIME] < 300 "
alerts:
- type: pushover
failure-threshold: 3
success-threshold: 5
send-on-resolved: true
description: "healthcheck failed"
```
2021-09-17 02:35:22 +00:00
#### Configuring Slack alerts
2022-05-31 02:03:09 +00:00
| Parameter | Description | Default |
|:------------------------------------------|:-------------------------------------------------------------------------------------------|:--------------|
| `alerting.slack` | Configuration for alerts of type `slack` | `{}` |
| `alerting.slack.webhook-url` | Slack Webhook URL | Required `""` |
| `alerting.slack.default-alert` | Default alert configuration. < br /> See [Setting a default alert ](#setting-a-default-alert ) | N/A |
| `alerting.slack.overrides` | List of overrides that may be prioritized over the default configuration | `[]` |
| `alerting.slack.overrides[].group` | Endpoint group for which the configuration will be overridden by this configuration | `""` |
| `alerting.slack.overrides[].webhook-url` | Slack Webhook URL | `""` |
2023-01-07 01:04:21 +00:00
2021-09-17 02:35:22 +00:00
```yaml
alerting:
2022-07-16 04:44:07 +00:00
slack:
2021-09-17 02:35:22 +00:00
webhook-url: "https://hooks.slack.com/services/**********/**********/**********"
2021-10-23 20:47:12 +00:00
endpoints:
2021-09-18 16:42:11 +00:00
- name: website
url: "https://twin.sh/health"
2021-09-17 02:35:22 +00:00
interval: 30s
conditions:
- "[STATUS] == 200"
- "[BODY].status == UP"
- "[RESPONSE_TIME] < 300 "
alerts:
- type: slack
description: "healthcheck failed 3 times in a row"
send-on-resolved: true
- type: slack
failure-threshold: 5
description: "healthcheck failed 5 times in a row"
send-on-resolved: true
```
Here's an example of what the notifications look like:
#### Configuring Teams alerts
2022-03-24 00:31:10 +00:00
| Parameter | Description | Default |
2022-04-25 23:55:17 +00:00
|:-----------------------------------------|:-------------------------------------------------------------------------------------------|:--------------|
2022-03-24 00:31:10 +00:00
| `alerting.teams` | Configuration for alerts of type `teams` | `{}` |
| `alerting.teams.webhook-url` | Teams Webhook URL | Required `""` |
| `alerting.teams.default-alert` | Default alert configuration. < br /> See [Setting a default alert ](#setting-a-default-alert ) | N/A |
| `alerting.teams.overrides` | List of overrides that may be prioritized over the default configuration | `[]` |
| `alerting.teams.overrides[].group` | Endpoint group for which the configuration will be overridden by this configuration | `""` |
| `alerting.teams.overrides[].webhook-url` | Teams Webhook URL | `""` |
2021-09-17 02:35:22 +00:00
```yaml
alerting:
teams:
webhook-url: "https://********.webhook.office.com/webhookb2/************"
2022-07-16 04:44:07 +00:00
# You can also add group-specific to keys, which will
2022-03-24 00:31:10 +00:00
# override the to key above for the specified groups
overrides:
- group: "core"
webhook-url: "https://********.webhook.office.com/webhookb3/************"
2021-09-17 02:35:22 +00:00
2021-10-23 20:47:12 +00:00
endpoints:
2021-09-18 16:42:11 +00:00
- name: website
url: "https://twin.sh/health"
2021-09-17 02:35:22 +00:00
interval: 30s
conditions:
- "[STATUS] == 200"
- "[BODY].status == UP"
- "[RESPONSE_TIME] < 300 "
alerts:
- type: teams
description: "healthcheck failed"
send-on-resolved: true
2022-03-24 00:31:10 +00:00
- name: back-end
group: core
url: "https://example.org/"
interval: 5m
conditions:
- "[STATUS] == 200"
- "[CERTIFICATE_EXPIRATION] > 48h"
alerts:
- type: teams
description: "healthcheck failed"
send-on-resolved: true
2021-09-17 02:35:22 +00:00
```
Here's an example of what the notifications look like:
2022-10-11 02:05:48 +00:00
2021-09-17 02:35:22 +00:00
#### Configuring Telegram alerts
2022-03-05 20:44:11 +00:00
| Parameter | Description | Default |
|:----------------------------------|:-------------------------------------------------------------------------------------------|:---------------------------|
| `alerting.telegram` | Configuration for alerts of type `telegram` | `{}` |
| `alerting.telegram.token` | Telegram Bot Token | Required `""` |
| `alerting.telegram.id` | Telegram User ID | Required `""` |
| `alerting.telegram.api-url` | Telegram API URL | `https://api.telegram.org` |
2022-09-07 22:50:59 +00:00
| `alerting.telegram.client` | Client configuration. < br /> See [Client configuration ](#client-configuration ). | `{}` |
2022-03-05 20:44:11 +00:00
| `alerting.telegram.default-alert` | Default alert configuration. < br /> See [Setting a default alert ](#setting-a-default-alert ) | N/A |
2021-09-17 02:35:22 +00:00
```yaml
alerting:
2022-07-16 04:44:07 +00:00
telegram:
2021-09-17 02:35:22 +00:00
token: "123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11"
id: "0123456789"
2021-10-23 20:47:12 +00:00
endpoints:
2021-09-18 16:42:11 +00:00
- name: website
url: "https://twin.sh/health"
2021-09-17 02:35:22 +00:00
interval: 30s
conditions:
- "[STATUS] == 200"
- "[BODY].status == UP"
alerts:
- type: telegram
send-on-resolved: true
```
Here's an example of what the notifications look like:
#### Configuring Twilio alerts
2022-01-02 03:56:32 +00:00
| Parameter | Description | Default |
|:--------------------------------|:-------------------------------------------------------------------------------------------|:--------------|
| `alerting.twilio` | Settings for alerts of type `twilio` | `{}` |
| `alerting.twilio.sid` | Twilio account SID | Required `""` |
| `alerting.twilio.token` | Twilio auth token | Required `""` |
| `alerting.twilio.from` | Number to send Twilio alerts from | Required `""` |
| `alerting.twilio.to` | Number to send twilio alerts to | Required `""` |
| `alerting.twilio.default-alert` | Default alert configuration. < br /> See [Setting a default alert ](#setting-a-default-alert ) | N/A |
2021-09-17 02:35:22 +00:00
```yaml
alerting:
twilio:
sid: "..."
token: "..."
from: "+1-234-567-8901"
to: "+1-234-567-8901"
2021-10-23 20:47:12 +00:00
endpoints:
2021-09-18 16:42:11 +00:00
- name: website
2021-09-17 02:35:22 +00:00
interval: 30s
2021-09-18 16:42:11 +00:00
url: "https://twin.sh/health"
2021-09-17 02:35:22 +00:00
conditions:
- "[STATUS] == 200"
- "[BODY].status == UP"
- "[RESPONSE_TIME] < 300 "
alerts:
- type: twilio
failure-threshold: 5
send-on-resolved: true
description: "healthcheck failed"
```
2022-10-11 02:05:48 +00:00
2021-09-17 02:35:22 +00:00
#### Configuring custom alerts
2022-01-02 03:56:32 +00:00
| Parameter | Description | Default |
|:--------------------------------|:-------------------------------------------------------------------------------------------|:--------------|
| `alerting.custom` | Configuration for custom actions on failure or alerts | `{}` |
| `alerting.custom.url` | Custom alerting request url | Required `""` |
| `alerting.custom.method` | Request method | `GET` |
| `alerting.custom.body` | Custom alerting request body. | `""` |
| `alerting.custom.headers` | Custom alerting request headers | `{}` |
| `alerting.custom.client` | Client configuration. < br /> See [Client configuration ](#client-configuration ). | `{}` |
| `alerting.custom.default-alert` | Default alert configuration. < br /> See [Setting a default alert ](#setting-a-default-alert ) | N/A |
2021-09-17 02:35:22 +00:00
2022-07-16 04:44:07 +00:00
While they're called alerts, you can use this feature to call anything.
2021-09-17 02:35:22 +00:00
2022-07-16 04:44:07 +00:00
For instance, you could automate rollbacks by having an application that keeps tracks of new deployments, and by
2021-10-23 20:47:12 +00:00
leveraging Gatus, you could have Gatus call that application endpoint when an endpoint starts failing. Your application
would then check if the endpoint that started failing was part of the recently deployed application, and if it was,
then automatically roll it back.
2021-09-17 02:35:22 +00:00
2022-06-07 23:37:42 +00:00
Furthermore, you may use the following placeholders in the body (`alerting.custom.body`) and in the url (`alerting.custom.url`):
- `[ALERT_DESCRIPTION]` (resolved from `endpoints[].alerts[].description` )
- `[ENDPOINT_NAME]` (resolved from `endpoints[].name` )
- `[ENDPOINT_GROUP]` (resolved from `endpoints[].group` )
- `[ENDPOINT_URL]` (resolved from `endpoints[].url` )
2021-09-17 02:35:22 +00:00
If you have an alert using the `custom` provider with `send-on-resolved` set to `true` , you can use the
2022-07-16 04:44:07 +00:00
`[ALERT_TRIGGERED_OR_RESOLVED]` placeholder to differentiate the notifications.
2021-09-17 02:35:22 +00:00
The aforementioned placeholder will be replaced by `TRIGGERED` or `RESOLVED` accordingly, though it can be modified
(details at the end of this section).
2021-12-09 06:07:04 +00:00
For all intents and purposes, we'll configure the custom alert with a Slack webhook, but you can call anything you want.
2021-09-17 02:35:22 +00:00
```yaml
alerting:
custom:
url: "https://hooks.slack.com/services/**********/**********/**********"
method: "POST"
body: |
{
2022-06-07 23:37:42 +00:00
"text": "[ALERT_TRIGGERED_OR_RESOLVED]: [ENDPOINT_GROUP] - [ENDPOINT_NAME] - [ALERT_DESCRIPTION]"
2021-09-17 02:35:22 +00:00
}
2021-10-23 20:47:12 +00:00
endpoints:
2021-09-18 16:42:11 +00:00
- name: website
url: "https://twin.sh/health"
2021-09-17 02:35:22 +00:00
interval: 30s
conditions:
- "[STATUS] == 200"
- "[BODY].status == UP"
- "[RESPONSE_TIME] < 300 "
alerts:
- type: custom
failure-threshold: 10
success-threshold: 3
send-on-resolved: true
2021-10-23 20:47:12 +00:00
description: "health check failed"
2021-09-17 02:35:22 +00:00
```
Note that you can customize the resolved values for the `[ALERT_TRIGGERED_OR_RESOLVED]` placeholder like so:
```yaml
alerting:
custom:
placeholders:
ALERT_TRIGGERED_OR_RESOLVED:
TRIGGERED: "partial_outage"
RESOLVED: "operational"
```
2022-07-16 04:44:07 +00:00
As a result, the `[ALERT_TRIGGERED_OR_RESOLVED]` in the body of first example of this section would be replaced by
2021-09-17 02:35:22 +00:00
`partial_outage` when an alert is triggered and `operational` when an alert is resolved.
#### Setting a default alert
| Parameter | Description | Default |
|:----------------------------------------------|:------------------------------------------------------------------------------|:--------|
| `alerting.*.default-alert.enabled` | Whether to enable the alert | N/A |
| `alerting.*.default-alert.failure-threshold` | Number of failures in a row needed before triggering the alert | N/A |
| `alerting.*.default-alert.success-threshold` | Number of successes in a row before an ongoing incident is marked as resolved | N/A |
| `alerting.*.default-alert.send-on-resolved` | Whether to send a notification once a triggered alert is marked as resolved | N/A |
| `alerting.*.default-alert.description` | Description of the alert. Will be included in the alert sent | N/A |
2022-12-06 03:40:19 +00:00
> ⚠ You must still specify the `type` of the alert in the endpoint configuration even if you set the default alert of a provider.
2021-10-23 20:47:12 +00:00
While you can specify the alert configuration directly in the endpoint definition, it's tedious and may lead to a very
2021-09-17 02:35:22 +00:00
long configuration file.
To avoid such problem, you can use the `default-alert` parameter present in each provider configuration:
```yaml
alerting:
2022-07-16 04:44:07 +00:00
slack:
2021-09-17 02:35:22 +00:00
webhook-url: "https://hooks.slack.com/services/**********/**********/**********"
default-alert:
2021-10-23 20:47:12 +00:00
description: "health check failed"
2021-09-17 02:35:22 +00:00
send-on-resolved: true
failure-threshold: 5
success-threshold: 5
```
2021-10-23 20:47:12 +00:00
As a result, your Gatus configuration looks a lot tidier:
2021-09-17 02:35:22 +00:00
```yaml
2021-10-23 20:47:12 +00:00
endpoints:
2021-09-17 02:35:22 +00:00
- name: example
url: "https://example.org"
conditions:
- "[STATUS] == 200"
alerts:
- type: slack
- name: other-example
url: "https://example.com"
conditions:
- "[STATUS] == 200"
alerts:
- type: slack
```
It also allows you to do things like this:
```yaml
2021-10-23 20:47:12 +00:00
endpoints:
2021-09-17 02:35:22 +00:00
- name: example
url: "https://example.org"
conditions:
- "[STATUS] == 200"
alerts:
- type: slack
failure-threshold: 5
- type: slack
failure-threshold: 10
- type: slack
failure-threshold: 15
```
Of course, you can also mix alert types:
```yaml
alerting:
slack:
webhook-url: "https://hooks.slack.com/services/**********/**********/**********"
default-alert:
failure-threshold: 3
pagerduty:
integration-key: "********************************"
default-alert:
failure-threshold: 5
2021-10-23 20:47:12 +00:00
endpoints:
- name: endpoint-1
2021-09-17 02:35:22 +00:00
url: "https://example.org"
conditions:
- "[STATUS] == 200"
alerts:
- type: slack
- type: pagerduty
2021-10-23 20:47:12 +00:00
- name: endpoint-2
2021-09-17 02:35:22 +00:00
url: "https://example.org"
conditions:
- "[STATUS] == 200"
alerts:
- type: slack
- type: pagerduty
```
2022-10-11 02:05:48 +00:00
2021-09-22 04:04:51 +00:00
### Maintenance
2022-07-16 04:44:07 +00:00
If you have maintenance windows, you may not want to be annoyed by alerts.
2021-09-22 04:04:51 +00:00
To do that, you'll have to use the maintenance configuration:
2022-01-02 03:56:32 +00:00
| Parameter | Description | Default |
|:-----------------------|:---------------------------------------------------------------------------------------------------------------------------------------|:--------------|
| `maintenance.enabled` | Whether the maintenance period is enabled | `true` |
| `maintenance.start` | Time at which the maintenance window starts in `hh:mm` format (e.g. `23:00` ) | Required `""` |
| `maintenance.duration` | Duration of the maintenance window (e.g. `1h` , `30m` ) | Required `""` |
| `maintenance.every` | Days on which the maintenance period applies (e.g. `[Monday, Thursday]` ).< br /> If left empty, the maintenance window applies every day | `[]` |
2021-09-22 04:11:22 +00:00
2023-01-07 01:04:21 +00:00
> 📝 The maintenance configuration uses UTC
2021-09-22 04:04:51 +00:00
Here's an example:
```yaml
maintenance:
start: 23:00
duration: 1h
every: [Monday, Thursday]
```
Note that you can also specify each day on separate lines:
```yaml
maintenance:
start: 23:00
duration: 1h
every:
- Monday
- Thursday
```
2022-01-02 03:56:32 +00:00
### Security
| Parameter | Description | Default |
|:---------------------------------|:-----------------------------|:--------------|
| `security` | Security configuration | `{}` |
| `security.basic` | HTTP Basic configuration | `{}` |
| `security.oidc` | OpenID Connect configuration | `{}` |
2022-10-11 02:05:48 +00:00
2022-01-02 03:56:32 +00:00
#### Basic
2022-01-09 00:26:37 +00:00
| Parameter | Description | Default |
|:----------------------------------------|:-----------------------------------------------------------------------------------|:--------------|
| `security.basic` | HTTP Basic configuration | `{}` |
| `security.basic.username` | Username for Basic authentication. | Required `""` |
| `security.basic.password-bcrypt-base64` | Password hashed with Bcrypt and then encoded with base64 for Basic authentication. | Required `""` |
2022-01-02 03:56:32 +00:00
The example below will require that you authenticate with the username `john.doe` and the password `hunter2` :
```yaml
security:
basic:
username: "john.doe"
2022-01-09 00:26:37 +00:00
password-bcrypt-base64: "JDJhJDEwJHRiMnRFakxWazZLdXBzRERQazB1TE8vckRLY05Yb1hSdnoxWU0yQ1FaYXZRSW1McmladDYu"
2022-01-02 03:56:32 +00:00
```
2023-01-07 01:04:21 +00:00
> ⚠ Make sure to carefully select to cost of the bcrypt hash. The higher the cost, the longer it takes to compute the hash,
and basic auth verifies the password against the hash on every request. As of 2023-01-06, I suggest a cost of 9.
2022-01-09 00:41:50 +00:00
2022-10-11 02:05:48 +00:00
2022-09-10 02:59:13 +00:00
#### OIDC
2022-01-02 03:56:32 +00:00
| Parameter | Description | Default |
|:---------------------------------|:---------------------------------------------------------------|:--------------|
| `security.oidc` | OpenID Connect configuration | `{}` |
| `security.oidc.issuer-url` | Issuer URL | Required `""` |
| `security.oidc.redirect-url` | Redirect URL. Must end with `/authorization-code/callback` | Required `""` |
| `security.oidc.client-id` | Client id | Required `""` |
| `security.oidc.client-secret` | Client secret | Required `""` |
| `security.oidc.scopes` | Scopes to request. The only scope you need is `openid` . | Required `[]` |
| `security.oidc.allowed-subjects` | List of subjects to allow. If empty, all subjects are allowed. | `[]` |
```yaml
security:
oidc:
issuer-url: "https://example.okta.com"
redirect-url: "https://status.example.com/authorization-code/callback"
client-id: "123456789"
client-secret: "abcdefghijk"
scopes: ["openid"]
# You may optionally specify a list of allowed subjects. If this is not specified, all subjects will be allowed.
#allowed -subjects: ["johndoe@example.com"]
```
2022-09-10 02:59:13 +00:00
Confused? Read [Securing Gatus with OIDC using Auth0 ](https://twin.sh/articles/56/securing-gatus-with-oidc-using-auth0 ).
2022-01-02 03:56:32 +00:00
2021-09-17 02:35:22 +00:00
2022-05-17 02:18:38 +00:00
### Metrics
To enable metrics, you must set `metrics` to `true` . Doing so will expose Prometheus-friendly metrics at the `/metrics`
endpoint on the same port your application is configured to run on (`web.port`).
| Metric name | Type | Description | Labels | Relevant endpoint types |
|:---------------------------------------------|:--------|:---------------------------------------------------------------------------|:--------------------------------|:------------------------|
| gatus_results_total | counter | Number of results per endpoint | key, group, name, type, success | All |
| gatus_results_code_total | counter | Total number of results by code | key, group, name, type, code | DNS, HTTP |
| gatus_results_connected_total | counter | Total number of results in which a connection was successfully established | key, group, name, type | All |
| gatus_results_duration_seconds | gauge | Duration of the request in seconds | key, group, name, type | All |
| gatus_results_certificate_expiration_seconds | gauge | Number of seconds until the certificate expires | key, group, name, type | HTTP, STARTTLS |
2022-06-18 16:42:41 +00:00
See [examples/docker-compose-grafana-prometheus ](.examples/docker-compose-grafana-prometheus ) for further documentation as well as an example.
2022-05-17 02:18:38 +00:00
2022-08-22 22:26:36 +00:00
### Remote instances (EXPERIMENTAL)
This feature allows you to retrieve endpoint statuses from a remote Gatus instance.
There are two main use cases for this:
- You have multiple Gatus instances running on different machines, and you wish to visually expose the statuses through a single dashboard
- You have one or more Gatus instances that are not publicly accessible (e.g. behind a firewall), and you wish to retrieve
This is an experimental feature. It may be removed or updated in a breaking manner at any time. Furthermore,
there are known issues with this feature. If you'd like to provide some feedback, please write a comment in [#64 ](https://github.com/TwiN/gatus/issues/64 ).
Use at your own risk.
| Parameter | Description | Default |
|:-----------------------------------|:---------------------------------------------|:---------------|
| `remote` | Remote configuration | `{}` |
| `remote.instances` | List of remote instances | Required `[]` |
| `remote.instances.endpoint-prefix` | String to prefix all endpoint names with | `""` |
| `remote.instances.url` | URL from which to retrieve endpoint statuses | Required `""` |
```yaml
remote:
instances:
- endpoint-prefix: "status.example.org-"
url: "https://status.example.org/api/v1/endpoints/statuses"
```
2021-09-17 02:35:22 +00:00
## Deployment
2021-10-24 19:20:39 +00:00
Many examples can be found in the [.examples ](.examples ) folder, but this section will focus on the most popular ways of deploying Gatus.
2021-09-17 02:35:22 +00:00
### Docker
To run Gatus locally with Docker:
2021-10-24 19:20:39 +00:00
```console
2021-09-17 02:35:22 +00:00
docker run -p 8080:8080 --name gatus twinproduction/gatus
```
2022-07-16 04:44:07 +00:00
Other than using one of the examples provided in the [.examples ](.examples ) folder, you can also try it out locally by
creating a configuration file, we'll call it `config.yaml` for this example, and running the following
2021-09-17 02:35:22 +00:00
command:
2021-10-24 19:20:39 +00:00
```console
2021-09-17 02:35:22 +00:00
docker run -p 8080:8080 --mount type=bind,source="$(pwd)"/config.yaml,target=/config/config.yaml --name gatus twinproduction/gatus
```
If you're on Windows, replace `"$(pwd)"` by the absolute path to your current directory, e.g.:
2021-10-24 19:20:39 +00:00
```console
2021-09-17 02:35:22 +00:00
docker run -p 8080:8080 --mount type=bind,source=C:/Users/Chris/Desktop/config.yaml,target=/config/config.yaml --name gatus twinproduction/gatus
```
To build the image locally:
2021-10-24 19:20:39 +00:00
```console
2021-09-17 02:35:22 +00:00
docker build . -t twinproduction/gatus
```
### Helm Chart
[Helm ](https://helm.sh ) must be installed to use the chart.
Please refer to Helm's [documentation ](https://helm.sh/docs/ ) to get started.
Once Helm is set up properly, add the repository as follows:
```console
helm repo add gatus https://avakarev.github.io/gatus-chart
```
To get more details, please check chart's [configuration ](https://github.com/avakarev/gatus-chart#configuration )
and [helmfile example ](https://github.com/avakarev/gatus-chart#helmfileyaml-example )
### Terraform
2021-10-08 01:28:04 +00:00
Gatus can be deployed on Terraform by using the following module: [terraform-kubernetes-gatus ](https://github.com/TwiN/terraform-kubernetes-gatus ).
2021-09-17 02:35:22 +00:00
## Running the tests
2021-10-24 19:20:39 +00:00
```console
2021-09-17 02:35:22 +00:00
go test ./... -mod vendor
```
## Using in Production
See the [Deployment ](#deployment ) section.
## FAQ
### Sending a GraphQL request
2021-10-23 20:47:12 +00:00
By setting `endpoints[].graphql` to true, the body will automatically be wrapped by the standard GraphQL `query` parameter.
2021-09-17 02:35:22 +00:00
For instance, the following configuration:
```yaml
2021-10-23 20:47:12 +00:00
endpoints:
2021-09-17 02:35:22 +00:00
- name: filter-users-by-gender
url: http://localhost:8080/playground
method: POST
graphql: true
body: |
{
users(gender: "female") {
id
name
gender
avatar
}
}
conditions:
- "[STATUS] == 200"
- "[BODY].data.users[0].gender == female"
```
will send a `POST` request to `http://localhost:8080/playground` with the following body:
```json
{"query":" {\n users(gender: \"female\") {\n id\n name\n gender\n avatar\n }\n }"}
```
### Recommended interval
2023-01-07 01:04:21 +00:00
> 📝 This does not apply if `disable-monitoring-lock` is set to `true`, as the monitoring lock is what
2021-10-23 20:47:12 +00:00
> tells Gatus to only evaluate one endpoint at a time.
2021-09-17 02:35:22 +00:00
2021-10-23 20:47:12 +00:00
To ensure that Gatus provides reliable and accurate results (i.e. response time), Gatus only evaluates one endpoint at a time
2022-01-24 01:06:55 +00:00
In other words, even if you have multiple endpoints with the same interval, they will not execute at the same time.
2021-09-17 02:35:22 +00:00
2022-07-16 04:44:07 +00:00
You can test this yourself by running Gatus with several endpoints configured with a very short, unrealistic interval,
2021-10-23 20:47:12 +00:00
such as 1ms. You'll notice that the response time does not fluctuate - that is because while endpoints are evaluated on
different goroutines, there's a global lock that prevents multiple endpoints from running at the same time.
2021-09-17 02:35:22 +00:00
2022-07-16 04:44:07 +00:00
Unfortunately, there is a drawback. If you have a lot of endpoints, including some that are very slow or prone to timing out
2021-10-23 20:47:12 +00:00
(the default timeout is 10s), then it means that for the entire duration of the request, no other endpoint can be evaluated.
2021-09-17 02:35:22 +00:00
2022-07-16 04:44:07 +00:00
The interval does not include the duration of the request itself, which means that if an endpoint has an interval of 30s
and the request takes 2s to complete, the timestamp between two evaluations will be 32s, not 30s.
2021-09-17 02:35:22 +00:00
2022-07-16 04:44:07 +00:00
While this does not prevent Gatus' from performing health checks on all other endpoints, it may cause Gatus to be unable
2021-09-17 02:35:22 +00:00
to respect the configured interval, for instance:
2022-07-16 04:44:07 +00:00
- Endpoint A has an interval of 5s, and times out after 10s to complete
2021-10-23 20:47:12 +00:00
- Endpoint B has an interval of 5s, and takes 1ms to complete
- Endpoint B will be unable to run every 5s, because endpoint A's health evaluation takes longer than its interval
2021-09-17 02:35:22 +00:00
2022-07-16 04:44:07 +00:00
To sum it up, while Gatus can handle any interval you throw at it, you're better off having slow requests with
2021-09-17 02:35:22 +00:00
higher interval.
2022-07-16 04:44:07 +00:00
As a rule of thumb, I personally set the interval for more complex health checks to `5m` (5 minutes) and
2021-09-17 02:35:22 +00:00
simple health checks used for alerting (PagerDuty/Twilio) to `30s` .
### Default timeouts
2022-04-25 23:55:17 +00:00
| Endpoint type | Timeout |
|:---------------|:--------|
| HTTP | 10s |
| TCP | 10s |
| ICMP | 10s |
2021-09-17 02:35:22 +00:00
To modify the timeout, see [Client configuration ](#client-configuration ).
2021-10-23 20:47:12 +00:00
### Monitoring a TCP endpoint
By prefixing `endpoints[].url` with `tcp:\\` , you can monitor TCP endpoints at a very basic level:
2021-09-17 02:35:22 +00:00
```yaml
2021-10-23 20:47:12 +00:00
endpoints:
2021-09-17 02:35:22 +00:00
- name: redis
url: "tcp://127.0.0.1:6379"
interval: 30s
conditions:
- "[CONNECTED] == true"
```
2022-07-16 04:44:07 +00:00
Placeholders `[STATUS]` and `[BODY]` as well as the fields `endpoints[].body` , `endpoints[].headers` ,
2021-11-03 23:48:58 +00:00
`endpoints[].method` and `endpoints[].graphql` are not supported for TCP endpoints.
2021-09-17 02:35:22 +00:00
2022-06-12 20:32:08 +00:00
This works for applications such as databases (Postgres, MySQL, etc.) and caches (Redis, Memcached, etc.).
2023-01-07 01:04:21 +00:00
> 📝 `[CONNECTED] == true` does not guarantee that the endpoint itself is healthy - it only guarantees that there's
2022-07-16 04:44:07 +00:00
something at the given address listening to the given port, and that a connection to that address was successfully
2021-09-17 02:35:22 +00:00
established.
2022-11-10 00:22:13 +00:00
### Monitoring a UDP endpoint
By prefixing `endpoints[].url` with `udp:\\` , you can monitor UDP endpoints at a very basic level:
```yaml
endpoints:
2022-12-04 02:26:46 +00:00
- name: example
url: "udp://example.org:80"
2022-11-10 00:22:13 +00:00
conditions:
- "[CONNECTED] == true"
```
Placeholders `[STATUS]` and `[BODY]` as well as the fields `endpoints[].body` , `endpoints[].headers` ,
`endpoints[].method` and `endpoints[].graphql` are not supported for UDP endpoints.
This works for UDP based application.
### Monitoring a SCTP endpoint
2022-12-04 02:26:46 +00:00
By prefixing `endpoints[].url` with `sctp:\\` , you can monitor Stream Control Transmission Protocol (SCTP) endpoints at a very basic level:
2022-11-10 00:22:13 +00:00
```yaml
endpoints:
2022-12-04 02:26:46 +00:00
- name: example
2022-11-10 00:22:13 +00:00
url: "sctp://127.0.0.1:38412"
conditions:
- "[CONNECTED] == true"
```
Placeholders `[STATUS]` and `[BODY]` as well as the fields `endpoints[].body` , `endpoints[].headers` ,
`endpoints[].method` and `endpoints[].graphql` are not supported for SCTP endpoints.
This works for SCTP based application.
2021-09-17 02:35:22 +00:00
2021-10-23 20:47:12 +00:00
### Monitoring an endpoint using ICMP
2022-07-16 04:44:07 +00:00
By prefixing `endpoints[].url` with `icmp:\\` , you can monitor endpoints at a very basic level using ICMP, or more
2021-09-17 02:35:22 +00:00
commonly known as "ping" or "echo":
```yaml
2021-10-23 20:47:12 +00:00
endpoints:
2021-09-17 02:35:22 +00:00
- name: ping-example
url: "icmp://example.com"
conditions:
- "[CONNECTED] == true"
```
2021-10-23 20:47:12 +00:00
Only the placeholders `[CONNECTED]` , `[IP]` and `[RESPONSE_TIME]` are supported for endpoints of type ICMP.
2021-09-17 02:35:22 +00:00
You can specify a domain prefixed by `icmp://` , or an IP address prefixed by `icmp://` .
2021-10-23 20:47:12 +00:00
### Monitoring an endpoint using DNS queries
Defining a `dns` configuration in an endpoint will automatically mark said endpoint as an endpoint of type DNS:
2021-09-17 02:35:22 +00:00
```yaml
2021-10-23 20:47:12 +00:00
endpoints:
2021-09-17 02:35:22 +00:00
- name: example-dns-query
url: "8.8.8.8" # Address of the DNS server to use
dns:
query-name: "example.com"
query-type: "A"
conditions:
- "[BODY] == 93.184.216.34"
- "[DNS_RCODE] == NOERROR"
```
2021-10-23 20:47:12 +00:00
There are two placeholders that can be used in the conditions for endpoints of type DNS:
2021-09-17 02:35:22 +00:00
- The placeholder `[BODY]` resolves to the output of the query. For instance, a query of type `A` would return an IPv4.
2022-07-16 04:44:07 +00:00
- The placeholder `[DNS_RCODE]` resolves to the name associated to the response code returned by the query, such as
2021-09-17 02:35:22 +00:00
`NOERROR` , `FORMERR` , `SERVFAIL` , `NXDOMAIN` , etc.
2021-10-23 20:47:12 +00:00
### Monitoring an endpoint using STARTTLS
2022-07-16 04:44:07 +00:00
If you have an email server that you want to ensure there are no problems with, monitoring it through STARTTLS
2021-09-17 02:35:22 +00:00
will serve as a good initial indicator:
```yaml
2021-10-23 20:47:12 +00:00
endpoints:
2021-09-17 02:35:22 +00:00
- name: starttls-smtp-example
url: "starttls://smtp.gmail.com:587"
interval: 30m
2021-09-30 20:15:17 +00:00
client:
2021-11-03 23:48:58 +00:00
timeout: 5s
2021-09-30 20:15:17 +00:00
conditions:
- "[CONNECTED] == true"
- "[CERTIFICATE_EXPIRATION] > 48h"
```
2021-10-23 20:47:12 +00:00
### Monitoring an endpoint using TLS
Monitoring endpoints using SSL/TLS encryption, such as LDAP over TLS, can help detect certificate expiration:
2021-09-30 20:15:17 +00:00
```yaml
2021-10-23 20:47:12 +00:00
endpoints:
2021-09-30 20:15:17 +00:00
- name: tls-ldaps-example
url: "tls://ldap.example.com:636"
interval: 30m
client:
2021-11-03 23:48:58 +00:00
timeout: 5s
2021-09-17 02:35:22 +00:00
conditions:
- "[CONNECTED] == true"
- "[CERTIFICATE_EXPIRATION] > 48h"
```
2022-09-07 01:22:02 +00:00
### Monitoring domain expiration
You can monitor the expiration of a domain with all endpoint types except for DNS by using the `[DOMAIN_EXPIRATION]`
placeholder:
```yaml
endpoints:
- name: check-domain-and-certificate-expiration
url: "https://example.org"
interval: 1h
conditions:
- "[DOMAIN_EXPIRATION] > 720h"
- "[CERTIFICATE_EXPIRATION] > 240h"
```
2023-01-07 01:04:21 +00:00
> ⚠ The usage of the `[DOMAIN_EXPIRATION]` placeholder requires Gatus to send a request to the official IANA WHOIS service [through a library](https://github.com/TwiN/whois)
2022-09-07 01:22:02 +00:00
and in some cases, a secondary request to a TLD-specific WHOIS server (e.g. `whois.nic.sh` ).
2022-09-16 01:23:14 +00:00
To prevent the WHOIS service from throttling your IP address if you send too many requests, Gatus will prevent you from
using the `[DOMAIN_EXPIRATION]` placeholder on an endpoint with an interval of less than `5m` .
2022-09-07 01:22:02 +00:00
2021-09-17 02:35:22 +00:00
### disable-monitoring-lock
2021-10-23 20:47:12 +00:00
Setting `disable-monitoring-lock` to `true` means that multiple endpoints could be monitored at the same time.
2021-09-17 02:35:22 +00:00
2022-07-16 04:44:07 +00:00
While this behavior wouldn't generally be harmful, conditions using the `[RESPONSE_TIME]` placeholder could be impacted
2021-10-23 20:47:12 +00:00
by the evaluation of multiple endpoints at the same time, therefore, the default value for this parameter is `false` .
2021-09-17 02:35:22 +00:00
There are three main reasons why you might want to disable the monitoring lock:
2022-07-16 04:44:07 +00:00
- You're using Gatus for load testing (each endpoint are periodically evaluated on a different goroutine, so
2021-10-23 20:47:12 +00:00
technically, if you create 100 endpoints with a 1 seconds interval, Gatus will send 100 requests per second)
- You have a _lot_ of endpoints to monitor
2022-01-24 01:06:55 +00:00
- You want to test multiple endpoints at very short intervals (< 5s )
2021-09-17 02:35:22 +00:00
### Reloading configuration on the fly
2021-12-09 06:16:06 +00:00
For the sake of convenience, Gatus automatically reloads the configuration on the fly if the loaded configuration file
2021-09-17 02:35:22 +00:00
is updated while Gatus is running.
By default, the application will exit if the updating configuration is invalid, but you can configure
Gatus to continue running if the configuration file is updated with an invalid configuration by
setting `skip-invalid-config-update` to `true` .
Keep in mind that it is in your best interest to ensure the validity of the configuration file after each update you
apply to the configuration file while Gatus is running by looking at the log and making sure that you do not see the
following message:
```
The configuration file was updated, but it is not valid. The old configuration will continue being used.
```
Failure to do so may result in Gatus being unable to start if the application is restarted for whatever reason.
I recommend not setting `skip-invalid-config-update` to `true` to avoid a situation like this, but the choice is yours
to make.
**If you are not using a file storage**, updating the configuration while Gatus is running is effectively
the same as restarting the application.
2023-01-07 01:04:21 +00:00
> 📝 Updates may not be detected if the config file is bound instead of the config folder. See [#151](https://github.com/TwiN/gatus/issues/151).
2021-09-17 02:35:22 +00:00
2021-10-23 20:47:12 +00:00
### Endpoint groups
Endpoint groups are used for grouping multiple endpoints together on the dashboard.
2021-09-17 02:35:22 +00:00
```yaml
2021-10-23 20:47:12 +00:00
endpoints:
2021-09-17 02:35:22 +00:00
- name: frontend
group: core
url: "https://example.org/"
interval: 5m
conditions:
- "[STATUS] == 200"
- name: backend
group: core
url: "https://example.org/"
interval: 5m
conditions:
- "[STATUS] == 200"
- name: monitoring
group: internal
url: "https://example.org/"
interval: 5m
conditions:
- "[STATUS] == 200"
- name: nas
group: internal
url: "https://example.org/"
interval: 5m
conditions:
- "[STATUS] == 200"
2022-09-07 01:22:02 +00:00
- name: random endpoint that is not part of a group
2021-09-17 02:35:22 +00:00
url: "https://example.org/"
interval: 5m
conditions:
- "[STATUS] == 200"
```
The configuration above will result in a dashboard that looks like this:
2021-10-23 20:47:12 +00:00
2021-09-17 02:35:22 +00:00
### Exposing Gatus on a custom port
By default, Gatus is exposed on port `8080` , but you may specify a different port by setting the `web.port` parameter:
```yaml
web:
port: 8081
```
If you're using a PaaS like Heroku that doesn't let you set a custom port and exposes it through an environment
variable instead, you can use that environment variable directly in the configuration file:
```yaml
web:
port: ${PORT}
```
2022-09-07 01:22:02 +00:00
2022-10-19 20:51:04 +00:00
### Keeping your configuration small
While not specific to Gatus, you can leverage YAML anchors to create a default configuration.
If you have a large configuration file, this should help you keep things clean.
< details >
< summary > Example< / summary >
```yaml
default-endpoint: & defaults
group: core
interval: 5m
client:
insecure: true
timeout: 30s
conditions:
- "[STATUS] == 200"
endpoints:
- name: anchor-example-1
< < : * defaults # This will merge the configuration under & defaults with this endpoint
url: "https://example.org"
- name: anchor-example-2
< < : * defaults
group: example # This will override the group defined in & defaults
url: "https://example.com"
- name: anchor-example-3
< < : * defaults
url: "https://twin.sh/health"
conditions: # This will override the conditions defined in & defaults
- "[STATUS] == 200"
- "[BODY].status == UP"
```
< / details >
2021-09-17 02:35:22 +00:00
### Badges
2022-04-26 00:20:32 +00:00
#### Uptime
2021-11-08 07:22:43 +00:00
2021-09-17 02:35:22 +00:00
2022-01-24 01:06:55 +00:00
Gatus can automatically generate an SVG badge for one of your monitored endpoints.
2022-07-16 04:44:07 +00:00
This allows you to put badges in your individual applications' README or even create your own status page if you
2021-09-17 02:35:22 +00:00
desire.
2021-10-23 20:47:12 +00:00
The path to generate a badge is the following:
2021-09-17 02:35:22 +00:00
```
2021-10-23 20:47:12 +00:00
/api/v1/endpoints/{key}/uptimes/{duration}/badge.svg
2021-09-17 02:35:22 +00:00
```
Where:
- `{duration}` is `7d` , `24h` or `1h`
2021-10-23 20:47:12 +00:00
- `{key}` has the pattern `<GROUP_NAME>_<ENDPOINT_NAME>` in which both variables have ` ` , `/` , `_` , `,` and `.` replaced by `-` .
2021-09-17 02:35:22 +00:00
2022-07-16 04:44:07 +00:00
For instance, if you want the uptime during the last 24 hours from the endpoint `frontend` in the group `core` ,
2021-09-17 02:35:22 +00:00
the URL would look like this:
```
2021-10-23 20:47:12 +00:00
https://example.com/api/v1/endpoints/core_frontend/uptimes/7d/badge.svg
2021-09-17 02:35:22 +00:00
```
2021-10-23 20:47:12 +00:00
If you want to display an endpoint that is not part of a group, you must leave the group value empty:
2021-09-17 02:35:22 +00:00
```
2021-10-23 20:47:12 +00:00
https://example.com/api/v1/endpoints/_frontend/uptimes/7d/badge.svg
2021-09-17 02:35:22 +00:00
```
Example:
```
2021-11-08 07:22:43 +00:00
2021-09-17 02:35:22 +00:00
```
2022-01-24 01:06:55 +00:00
If you'd like to see a visual example of each badge available, you can simply navigate to the endpoint's detail page.
2021-09-17 02:35:22 +00:00
2022-06-20 17:59:45 +00:00
#### Health
The path to generate a badge is the following:
```
/api/v1/endpoints/{key}/health/badge.svg
```
Where:
- `{key}` has the pattern `<GROUP_NAME>_<ENDPOINT_NAME>` in which both variables have ` ` , `/` , `_` , `,` and `.` replaced by `-` .
2022-07-16 04:44:07 +00:00
For instance, if you want the current status of the endpoint `frontend` in the group `core` ,
2022-06-20 17:59:45 +00:00
the URL would look like this:
```
https://example.com/api/v1/endpoints/core_frontend/health/badge.svg
```
2022-04-26 00:20:32 +00:00
#### Response time
2021-11-08 07:22:43 +00:00
2021-09-17 02:35:22 +00:00
The endpoint to generate a badge is the following:
```
2021-10-23 20:47:12 +00:00
/api/v1/endpoints/{key}/response-times/{duration}/badge.svg
2021-09-17 02:35:22 +00:00
```
Where:
- `{duration}` is `7d` , `24h` or `1h`
2021-10-23 20:47:12 +00:00
- `{key}` has the pattern `<GROUP_NAME>_<ENDPOINT_NAME>` in which both variables have ` ` , `/` , `_` , `,` and `.` replaced by `-` .
2021-09-17 02:35:22 +00:00
2022-10-11 02:05:48 +00:00
2022-08-11 01:05:34 +00:00
##### How to change the color thresholds of the response time badge
2022-09-07 01:22:02 +00:00
To change the response time badges' threshold, a corresponding configuration can be added to an endpoint.
2022-08-11 01:05:34 +00:00
The values in the array correspond to the levels [Awesome, Great, Good, Passable, Bad]
All five values must be given in milliseconds (ms).
```
endpoints:
- name: nas
group: internal
url: "https://example.org/"
interval: 5m
conditions:
- "[STATUS] == 200"
ui:
badge:
response-time:
thresholds: [550, 850, 1350, 1650, 1750]
```
2021-09-17 02:35:22 +00:00
2022-09-07 01:22:02 +00:00
2021-09-17 02:35:22 +00:00
### API
2022-01-24 01:06:55 +00:00
Gatus provides a simple read-only API that can be queried in order to programmatically determine endpoint status and history.
2021-09-17 02:35:22 +00:00
2021-10-23 20:47:12 +00:00
All endpoints are available via a GET request to the following endpoint:
2021-09-17 02:35:22 +00:00
```
2021-10-23 20:47:12 +00:00
/api/v1/endpoints/statuses
2021-09-17 02:35:22 +00:00
````
2021-10-23 20:47:12 +00:00
Example: https://status.twin.sh/api/v1/endpoints/statuses
2021-09-17 02:35:22 +00:00
2021-10-23 20:47:12 +00:00
Specific endpoints can also be queried by using the following pattern:
2021-09-17 02:35:22 +00:00
```
2021-10-23 20:47:12 +00:00
/api/v1/endpoints/{group}_{endpoint}/statuses
2021-09-17 02:35:22 +00:00
```
2021-11-08 07:22:43 +00:00
Example: https://status.twin.sh/api/v1/endpoints/core_blog-home/statuses
2021-09-17 02:35:22 +00:00
Gzip compression will be used if the `Accept-Encoding` HTTP header contains `gzip` .
2022-07-16 04:44:07 +00:00
The API will return a JSON payload with the `Content-Type` response header set to `application/json` .
2021-09-17 02:35:22 +00:00
No such header is required to query the API.
### High level design overview
2022-12-07 04:03:27 +00:00
2021-09-17 02:35:22 +00:00
## Sponsors
2021-10-08 01:28:04 +00:00
You can find the full list of sponsors [here ](https://github.com/sponsors/TwiN ).
2021-09-17 02:35:22 +00:00
[<img src="https://github.com/math280h.png" width="50" /> ](https://github.com/math280h )
