[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"project-5021":3},{"id":4,"name":5,"fullName":6,"owner":7,"repo":5,"description":8,"homepage":9,"htmlUrl":10,"language":11,"languages":10,"totalLinesOfCode":10,"stars":12,"forks":13,"watchers":14,"openIssues":15,"contributorsCount":16,"subscribersCount":16,"size":16,"stars1d":17,"stars7d":18,"stars30d":19,"stars90d":16,"forks30d":16,"starsTrendScore":20,"compositeScore":21,"rankGlobal":10,"rankLanguage":10,"license":22,"archived":23,"fork":23,"defaultBranch":24,"hasWiki":23,"hasPages":23,"topics":25,"createdAt":10,"pushedAt":10,"updatedAt":46,"readmeContent":47,"aiSummary":48,"trendingCount":16,"starSnapshotCount":16,"syncStatus":49,"lastSyncTime":50,"discoverSource":51},5021,"gatus","TwiN\u002Fgatus","TwiN","Automated developer-oriented status page with alerting and incident support","https:\u002F\u002Fgatus.io",null,"Go",11208,749,42,237,0,6,70,307,54,110.63,"Apache License 2.0",false,"master",[26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45],"alerting","container","dashboard","devops","docker","go","golang","health","monitor","monitoring","monitoring-tool","notifications","self-hosted","selfhosted","slack","status","status-page","statuspage","uptime","uptime-monitoring","2026-06-12 04:00:24","[![Gatus](.github\u002Fassets\u002Flogo-with-dark-text.png)](https:\u002F\u002Fgatus.io)\n\n![test](https:\u002F\u002Fgithub.com\u002FTwiN\u002Fgatus\u002Factions\u002Fworkflows\u002Ftest.yml\u002Fbadge.svg)\n[![Go Report Card](https:\u002F\u002Fgoreportcard.com\u002Fbadge\u002Fgithub.com\u002FTwiN\u002Fgatus?)](https:\u002F\u002Fgoreportcard.com\u002Freport\u002Fgithub.com\u002FTwiN\u002Fgatus)\n[![codecov](https:\u002F\u002Fcodecov.io\u002Fgh\u002FTwiN\u002Fgatus\u002Fbranch\u002Fmaster\u002Fgraph\u002Fbadge.svg)](https:\u002F\u002Fcodecov.io\u002Fgh\u002FTwiN\u002Fgatus)\n[![Go version](https:\u002F\u002Fimg.shields.io\u002Fgithub\u002Fgo-mod\u002Fgo-version\u002FTwiN\u002Fgatus.svg)](https:\u002F\u002Fgithub.com\u002FTwiN\u002Fgatus)\n[![Docker pulls](https:\u002F\u002Fimg.shields.io\u002Fdocker\u002Fpulls\u002Ftwinproduction\u002Fgatus.svg)](https:\u002F\u002Fcloud.docker.com\u002Frepository\u002Fdocker\u002Ftwinproduction\u002Fgatus)\n[![Follow TwiN](https:\u002F\u002Fimg.shields.io\u002Fgithub\u002Ffollowers\u002FTwiN?label=Follow&style=social)](https:\u002F\u002Fgithub.com\u002FTwiN)\n\nGatus is a developer-oriented health dashboard that gives you the ability to monitor your services using HTTP, ICMP, TCP, and even DNS\nqueries as well as evaluate the result of said queries by using a list of conditions on values like the status code,\nthe response time, the certificate expiration, the body and many others. The icing on top is that each of these health\nchecks can be paired with alerting via Slack, Teams, PagerDuty, Discord, Twilio and many more.\n\nI personally deploy it in my Kubernetes cluster and let it monitor the status of my\ncore applications: https:\u002F\u002Fstatus.twin.sh\u002F\n\n_Looking for a managed solution? Check out [Gatus.io](https:\u002F\u002Fgatus.io)._\n\n\u003Cdetails>\n \u003Csummary>\u003Cb>Quick start\u003C\u002Fb>\u003C\u002Fsummary>\n\n```console\ndocker run -p 8080:8080 --name gatus ghcr.io\u002Ftwin\u002Fgatus:stable\n```\n\nYou can also use Docker Hub if you prefer:\n```console\ndocker run -p 8080:8080 --name gatus twinproduction\u002Fgatus:stable\n```\nFor more details, see [Usage](#usage)\n\u003C\u002Fdetails>\n\n> ❤ Like this project? Please consider [sponsoring me](https:\u002F\u002Fgithub.com\u002Fsponsors\u002FTwiN).\n\n![Gatus dashboard](.github\u002Fassets\u002Fdashboard-dark.jpg)\n\nHave any feedback or questions? [Create a discussion](https:\u002F\u002Fgithub.com\u002FTwiN\u002Fgatus\u002Fdiscussions\u002Fnew).\n\n\n## Table of Contents\n- [Table of Contents](#table-of-contents)\n- [Why Gatus?](#why-gatus)\n- [Features](#features)\n- [Usage](#usage)\n- [Configuration](#configuration)\n - [Endpoints](#endpoints)\n - [External Endpoints](#external-endpoints)\n - [Suites (ALPHA)](#suites-alpha)\n - [Conditions](#conditions)\n - [Placeholders](#placeholders)\n - [Functions](#functions)\n - [Web](#web)\n - [UI](#ui)\n - [Announcements](#announcements)\n - [Storage](#storage)\n - [Client configuration](#client-configuration)\n - [Tunneling](#tunneling)\n - [Alerting](#alerting)\n - [Configuring AWS SES alerts](#configuring-aws-ses-alerts)\n - [Configuring ClickUp alerts](#configuring-clickup-alerts)\n - [Configuring Datadog alerts](#configuring-datadog-alerts)\n - [Configuring Discord alerts](#configuring-discord-alerts)\n - [Configuring Email alerts](#configuring-email-alerts)\n - [Configuring Gitea alerts](#configuring-gitea-alerts)\n - [Configuring GitHub alerts](#configuring-github-alerts)\n - [Configuring GitLab alerts](#configuring-gitlab-alerts)\n - [Configuring Google Chat alerts](#configuring-google-chat-alerts)\n - [Configuring Gotify alerts](#configuring-gotify-alerts)\n - [Configuring HomeAssistant alerts](#configuring-homeassistant-alerts)\n - [Configuring IFTTT alerts](#configuring-ifttt-alerts)\n - [Configuring Ilert alerts](#configuring-ilert-alerts)\n - [Configuring Incident.io alerts](#configuring-incidentio-alerts)\n - [Configuring Line alerts](#configuring-line-alerts)\n - [Configuring Matrix alerts](#configuring-matrix-alerts)\n - [Configuring Mattermost alerts](#configuring-mattermost-alerts)\n - [Configuring Messagebird alerts](#configuring-messagebird-alerts)\n - [Configuring n8n alerts](#configuring-n8n-alerts)\n - [Configuring New Relic alerts](#configuring-new-relic-alerts)\n - [Configuring Ntfy alerts](#configuring-ntfy-alerts)\n - [Configuring Opsgenie alerts](#configuring-opsgenie-alerts)\n - [Configuring PagerDuty alerts](#configuring-pagerduty-alerts)\n - [Configuring Plivo alerts](#configuring-plivo-alerts)\n - [Configuring Pushover alerts](#configuring-pushover-alerts)\n - [Configuring Rocket.Chat alerts](#configuring-rocketchat-alerts)\n - [Configuring SendGrid alerts](#configuring-sendgrid-alerts)\n - [Configuring Signal alerts](#configuring-signal-alerts)\n - [Configuring SIGNL4 alerts](#configuring-signl4-alerts)\n - [Configuring Slack alerts](#configuring-slack-alerts)\n - [Configuring Splunk alerts](#configuring-splunk-alerts)\n - [Configuring Squadcast alerts](#configuring-squadcast-alerts)\n - [Configuring Teams alerts *(Deprecated)*](#configuring-teams-alerts-deprecated)\n - [Configuring Teams Workflow alerts](#configuring-teams-workflow-alerts)\n - [Configuring Telegram alerts](#configuring-telegram-alerts)\n - [Configuring Twilio alerts](#configuring-twilio-alerts)\n - [Configuring Vonage alerts](#configuring-vonage-alerts)\n - [Configuring Webex alerts](#configuring-webex-alerts)\n - [Configuring Zapier alerts](#configuring-zapier-alerts)\n - [Configuring Zulip alerts](#configuring-zulip-alerts)\n - [Configuring custom alerts](#configuring-custom-alerts)\n - [Setting a default alert](#setting-a-default-alert)\n - [Maintenance](#maintenance)\n - [Security](#security)\n - [Basic Authentication](#basic-authentication)\n - [OIDC](#oidc)\n - [TLS Encryption](#tls-encryption)\n - [Metrics](#metrics)\n - [Custom Labels](#custom-labels)\n - [Connectivity](#connectivity)\n - [Remote instances (EXPERIMENTAL)](#remote-instances-experimental)\n- [Deployment](#deployment)\n - [Docker](#docker)\n - [Helm Chart](#helm-chart)\n - [Terraform](#terraform)\n - [Kubernetes](#kubernetes)\n- [Running the tests](#running-the-tests)\n- [Using in Production](#using-in-production)\n- [FAQ](#faq)\n - [Sending a GraphQL request](#sending-a-graphql-request)\n - [Recommended interval](#recommended-interval)\n - [Default timeouts](#default-timeouts)\n - [Monitoring a TCP endpoint](#monitoring-a-tcp-endpoint)\n - [Monitoring a UDP endpoint](#monitoring-a-udp-endpoint)\n - [Monitoring a SCTP endpoint](#monitoring-a-sctp-endpoint)\n - [Monitoring a WebSocket endpoint](#monitoring-a-websocket-endpoint)\n - [Monitoring an endpoint using gRPC](#monitoring-an-endpoint-using-grpc)\n - [Monitoring an endpoint using ICMP](#monitoring-an-endpoint-using-icmp)\n - [Monitoring an endpoint using DNS queries](#monitoring-an-endpoint-using-dns-queries)\n - [Monitoring an endpoint using SSH](#monitoring-an-endpoint-using-ssh)\n - [Monitoring an endpoint using STARTTLS](#monitoring-an-endpoint-using-starttls)\n - [Monitoring an endpoint using TLS](#monitoring-an-endpoint-using-tls)\n - [Monitoring domain expiration](#monitoring-domain-expiration)\n - [Concurrency](#concurrency)\n - [Reloading configuration on the fly](#reloading-configuration-on-the-fly)\n - [Endpoint groups](#endpoint-groups)\n - [How do I sort by group by default?](#how-do-i-sort-by-group-by-default)\n - [Exposing Gatus on a custom path](#exposing-gatus-on-a-custom-path)\n - [Exposing Gatus on a custom port](#exposing-gatus-on-a-custom-port)\n - [Use environment variables in config files](#use-environment-variables-in-config-files)\n - [Configuring a startup delay](#configuring-a-startup-delay)\n - [Keeping your configuration small](#keeping-your-configuration-small)\n - [Proxy client configuration](#proxy-client-configuration)\n - [How to fix 431 Request Header Fields Too Large error](#how-to-fix-431-request-header-fields-too-large-error)\n - [Badges](#badges)\n - [Uptime](#uptime)\n - [Health](#health)\n - [Health (Shields.io)](#health-shieldsio)\n - [Response time](#response-time)\n - [Response time (chart)](#response-time-chart)\n - [How to change the color thresholds of the response time badge](#how-to-change-the-color-thresholds-of-the-response-time-badge)\n - [API](#api)\n - [Interacting with the API programmatically](#interacting-with-the-api-programmatically)\n - [Raw Data](#raw-data)\n - [Uptime](#uptime-1)\n - [Response Time](#response-time-1)\n - [Installing as binary](#installing-as-binary)\n - [High level design overview](#high-level-design-overview)\n\n\n## Why Gatus?\nBefore getting into the specifics, I want to address the most common question:\n> Why would I use Gatus when I can just use Prometheus’ Alertmanager, Cloudwatch or even Splunk?\n\nNeither of these can tell you that there’s a problem if there are no clients actively calling the endpoint.\nIn other words, it's because monitoring metrics mostly rely on existing traffic, which effectively means that unless\nyour clients are already experiencing a problem, you won't be notified.\n\nGatus, on the other hand, allows you to configure health checks for each of your features, which in turn allows it to\nmonitor these features and potentially alert you before any clients are impacted.\n\nA sign you may want to look into Gatus is by simply asking yourself whether you'd receive an alert if your load balancer\nwas to go down right now. Will any of your existing alerts be triggered? Your metrics won’t report an increase in errors\nif no traffic makes it to your applications. This puts you in a situation where your clients are the ones\nthat will notify you about the degradation of your services rather than you reassuring them that you're working on\nfixing the issue before they even know about it.\n\n\n## Features\nThe main features of Gatus are:\n\n- **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.\n- **Ability to use Gatus for user acceptance tests**: Thanks to the point above, you can leverage this application to create automated user acceptance tests.\n- **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.\n- **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.\n- **Metrics**\n- **Low resource consumption**: As with most Go applications, the resource footprint that this application requires is negligibly small.\n- **[Badges](#badges)**: ![Uptime 7d](https:\u002F\u002Fstatus.twin.sh\u002Fapi\u002Fv1\u002Fendpoints\u002Fcore_blog-external\u002Fuptimes\u002F7d\u002Fbadge.svg) ![Response time 24h](https:\u002F\u002Fstatus.twin.sh\u002Fapi\u002Fv1\u002Fendpoints\u002Fcore_blog-external\u002Fresponse-times\u002F24h\u002Fbadge.svg)\n- **Dark mode**\n\n![Gatus dashboard conditions](.github\u002Fassets\u002Fdashboard-conditions.jpg)\n\n\n## Usage\n\n```console\ndocker run -p 8080:8080 --name gatus ghcr.io\u002Ftwin\u002Fgatus:stable\n```\n\nYou can also use Docker Hub if you prefer:\n```console\ndocker run -p 8080:8080 --name gatus twinproduction\u002Fgatus:stable\n```\nIf you want to create your own configuration, see [Docker](#docker) for information on how to mount a configuration file.\n\nHere's a simple example:\n```yaml\nendpoints:\n - name: website # Name of your endpoint, can be anything\n url: \"https:\u002F\u002Ftwin.sh\u002Fhealth\"\n interval: 5m # Duration to wait between every status check (default: 60s)\n conditions:\n - \"[STATUS] == 200\" # Status must be 200\n - \"[BODY].status == UP\" # The json path \"$.status\" must be equal to UP\n - \"[RESPONSE_TIME] \u003C 300\" # Response time must be under 300ms\n\n - name: make-sure-header-is-rendered\n url: \"https:\u002F\u002Fexample.org\u002F\"\n interval: 60s\n conditions:\n - \"[STATUS] == 200\" # Status must be 200\n - \"[BODY] == pat(*\u003Ch1>Example Domain\u003C\u002Fh1>*)\" # Body must contain the specified header\n```\n\nThis example would look similar to this:\n\n![Simple example](.github\u002Fassets\u002Fexample.jpg)\n\nIf you want to test it locally, see [Docker](#docker).\n\n## Configuration\nBy default, the configuration file is expected to be at `config\u002Fconfig.yaml`.\n\nYou can specify a custom path by setting the `GATUS_CONFIG_PATH` environment variable.\n\nIf `GATUS_CONFIG_PATH` points to a directory, all `*.yaml` and `*.yml` files inside said directory and its\nsubdirectories are merged like so:\n- All maps\u002Fobjects are deep merged (i.e. you could define `alerting.slack` in one file and `alerting.pagerduty` in another file)\n- All slices\u002Farrays are appended (i.e. you can define `endpoints` in multiple files and each endpoint will be added to the final list of endpoints)\n- Parameters with a primitive value (e.g. `metrics`, `alerting.slack.webhook-url`, etc.) may only be defined once to forcefully avoid any ambiguity\n - 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.\n\n> 💡 You can also use environment variables in the configuration file (e.g. `$DOMAIN`, `${DOMAIN}`)\n>\n> ⚠️ When your configuration parameter contains a `$` symbol, you have to escape `$` with `$$`.\n>\n> See [Use environment variables in config files](#use-environment-variables-in-config-files) or [examples\u002Fdocker-compose-postgres-storage\u002Fconfig\u002Fconfig.yaml](.examples\u002Fdocker-compose-postgres-storage\u002Fconfig\u002Fconfig.yaml) for examples.\n\nIf you want to test it locally, see [Docker](#docker).\n\n\n## Configuration\n| Parameter | Description | Default |\n|:-----------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------|:--------------|\n| `metrics` | Whether to expose metrics at `\u002Fmetrics`. | `false` |\n| `storage` | [Storage configuration](#storage). | `{}` |\n| `alerting` | [Alerting configuration](#alerting). | `{}` |\n| `announcements` | [Announcements configuration](#announcements). | `[]` |\n| `endpoints` | [Endpoints configuration](#endpoints). | Required `[]` |\n| `external-endpoints` | [External Endpoints configuration](#external-endpoints). | `[]` |\n| `security` | [Security configuration](#security). | `{}` |\n| `concurrency` | Maximum number of endpoints\u002Fsuites to monitor concurrently. Set to `0` for unlimited. See [Concurrency](#concurrency). | `3` |\n| `disable-monitoring-lock` | Whether to [disable the monitoring lock](#disable-monitoring-lock). **Deprecated**: Use `concurrency: 0` instead. | `false` |\n| `skip-invalid-config-update` | Whether to ignore invalid configuration update. \u003Cbr \u002F>See [Reloading configuration on the fly](#reloading-configuration-on-the-fly). | `false` |\n| `web` | [Web configuration](#web). | `{}` |\n| `ui` | [UI configuration](#ui). | `{}` |\n| `maintenance` | [Maintenance configuration](#maintenance). | `{}` |\n\nIf you want more verbose logging, you may set the `GATUS_LOG_LEVEL` environment variable to `DEBUG`.\nConversely, if you want less verbose logging, you can set the aforementioned environment variable to `WARN`, `ERROR` or `FATAL`.\nThe default value for `GATUS_LOG_LEVEL` is `INFO`.\n\n### Endpoints\nEndpoints are URLs, applications, or services that you want to monitor. Each endpoint has a list of conditions that are\nevaluated on an interval that you define. If any condition fails, the endpoint is considered as unhealthy.\nYou can then configure alerts to be triggered when an endpoint is unhealthy once a certain threshold is reached.\n\n| Parameter | Description | Default |\n|:------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------|:---------------------------|\n| `endpoints` | List of endpoints to monitor. | Required `[]` |\n| `endpoints[].enabled` | Whether to monitor the endpoint. | `true` |\n| `endpoints[].name` | Name of the endpoint. Can be anything. | Required `\"\"` |\n| `endpoints[].group` | Group name. Used to group multiple endpoints together on the dashboard. \u003Cbr \u002F>See [Endpoint groups](#endpoint-groups). | `\"\"` |\n| `endpoints[].url` | URL to send the request to. | Required `\"\"` |\n| `endpoints[].method` | Request method. | `GET` |\n| `endpoints[].conditions` | Conditions used to determine the health of the endpoint. \u003Cbr \u002F>See [Conditions](#conditions). | `[]` |\n| `endpoints[].interval` | Duration to wait between every status check. | `60s` |\n| `endpoints[].graphql` | Whether to wrap the body in a query param (`{\"query\":\"$body\"}`). | `false` |\n| `endpoints[].body` | Request body. | `\"\"` |\n| `endpoints[].headers` | Request headers. | `{}` |\n| `endpoints[].dns` | Configuration for an endpoint of type DNS. \u003Cbr \u002F>See [Monitoring an endpoint using DNS queries](#monitoring-an-endpoint-using-dns-queries). | `\"\"` |\n| `endpoints[].dns.query-type` | Query type (e.g. MX). | `\"\"` |\n| `endpoints[].dns.query-name` | Query name (e.g. example.com). | `\"\"` |\n| `endpoints[].ssh` | Configuration for an endpoint of type SSH. \u003Cbr \u002F>See [Monitoring an endpoint using SSH](#monitoring-an-endpoint-using-ssh). | `\"\"` |\n| `endpoints[].ssh.username` | SSH username (e.g. example). | Required `\"\"` |\n| `endpoints[].ssh.password` | SSH password (e.g. password). | Required `\"\"` |\n| `endpoints[].alerts` | List of all alerts for a given endpoint. \u003Cbr \u002F>See [Alerting](#alerting). | `[]` |\n| `endpoints[].maintenance-windows` | List of all maintenance windows for a given endpoint. \u003Cbr \u002F>See [Maintenance](#maintenance). | `[]` |\n| `endpoints[].client` | [Client configuration](#client-configuration). | `{}` |\n| `endpoints[].ui` | UI configuration at the endpoint level. | `{}` |\n| `endpoints[].ui.hide-conditions` | Whether to hide conditions from the results. Note that this only hides conditions from results evaluated from the moment this was enabled. | `false` |\n| `endpoints[].ui.hide-hostname` | Whether to hide the hostname from the results. | `false` |\n| `endpoints[].ui.hide-port` | Whether to hide the port from the results. | `false` |\n| `endpoints[].ui.hide-url` | Whether to hide the URL from the results. Useful if the URL contains a token. | `false` |\n| `endpoints[].ui.hide-errors` | Whether to hide errors from the results. | `false` |\n| `endpoints[].ui.dont-resolve-failed-conditions` | Whether to resolve failed conditions for the UI. | `false` |\n| `endpoints[].ui.resolve-successful-conditions` | Whether to resolve successful conditions for the UI (helpful to expose body assertions even when checks pass). | `false` |\n| `endpoints[].ui.badge.response-time` | List of response time thresholds. Each time a threshold is reached, the badge has a different color. | `[50, 200, 300, 500, 750]` |\n| `endpoints[].extra-labels` | Extra labels to add to the metrics. Useful for grouping endpoints together. | `{}` |\n| `endpoints[].always-run` | (SUITES ONLY) Whether to execute this endpoint even if previous endpoints in the suite failed. | `false` |\n| `endpoints[].store` | (SUITES ONLY) Map of values to extract from the response and store in the suite context (stored even on failure). | `{}` |\n\nYou may use the following placeholders in the body (`endpoints[].body`):\n- `[ENDPOINT_NAME]` (resolved from `endpoints[].name`)\n- `[ENDPOINT_GROUP]` (resolved from `endpoints[].group`)\n- `[ENDPOINT_URL]` (resolved from `endpoints[].url`)\n- `[LOCAL_ADDRESS]` (resolves to the local IP and port like `192.0.2.1:25` or `[2001:db8::1]:80`)\n- `[RANDOM_STRING_N]` (resolves to a random string of numbers and letters of length N (max: 8192))\n\n### External Endpoints\nUnlike regular endpoints, external endpoints are not monitored by Gatus, but they are instead pushed programmatically.\nThis 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.\n\nFor instance:\n- 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\n- You can monitor services that are not supported by Gatus\n- You can implement your own monitoring system while using Gatus as the dashboard\n\n| Parameter | Description | Default |\n|:------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------|:---------------|\n| `external-endpoints` | List of endpoints to monitor. | `[]` |\n| `external-endpoints[].enabled` | Whether to monitor the endpoint. | `true` |\n| `external-endpoints[].name` | Name of the endpoint. Can be anything. | Required `\"\"` |\n| `external-endpoints[].group` | Group name. Used to group multiple endpoints together on the dashboard. \u003Cbr \u002F>See [Endpoint groups](#endpoint-groups). | `\"\"` |\n| `external-endpoints[].token` | Bearer token required to push status to. | Required `\"\"` |\n| `external-endpoints[].alerts` | List of all alerts for a given endpoint. \u003Cbr \u002F>See [Alerting](#alerting). | `[]` |\n| `external-endpoints[].heartbeat` | Heartbeat configuration for monitoring when the external endpoint stops sending updates. | `{}` |\n| `external-endpoints[].heartbeat.interval` | Expected interval between updates. If no update is received within this interval, alerts will be triggered. Must be at least 10s. | `0` (disabled) |\n\nExample:\n```yaml\nexternal-endpoints:\n - name: ext-ep-test\n group: core\n token: \"potato\"\n heartbeat:\n interval: 30m # Automatically create a failure if no update is received within 30 minutes\n alerts:\n - type: discord\n description: \"healthcheck failed\"\n send-on-resolved: true\n```\n\nTo push the status of an external endpoint, you can use [gatus-cli](https:\u002F\u002Fgithub.com\u002FTwiN\u002Fgatus-cli):\n```\ngatus-cli external-endpoint push --url https:\u002F\u002Fstatus.example.org --key \"core_ext-ep-test\" --token \"potato\" --success\n```\n\nor send an HTTP request:\n```\nPOST \u002Fapi\u002Fv1\u002Fendpoints\u002F{key}\u002Fexternal?success={success}&error={error}&duration={duration}\n```\nWhere:\n- `{key}` has the pattern `\u003CGROUP_NAME>_\u003CENDPOINT_NAME>` in which both variables have ` `, `\u002F`, `_`, `,`, `.`, `#`, `+` and `&` replaced by `-`.\n - Using the example configuration above, the key would be `core_ext-ep-test`.\n- `{success}` is a boolean (`true` or `false`) value indicating whether the health check was successful or not.\n- `{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.\n- `{duration}` (optional): the time that the request took as a duration string (e.g. 10s).\n\nYou must also pass the token as a `Bearer` token in the `Authorization` header.\n\n\n### Suites (ALPHA)\nSuites are collections of endpoints that are executed sequentially with a shared context.\nThis allows you to create complex monitoring scenarios where the result from one endpoint can be used in subsequent endpoints, enabling workflow-style monitoring.\n\nHere are a few cases in which suites could be useful:\n- Testing multi-step authentication flows (login -> access protected resource -> logout)\n- API workflows where you need to chain requests (create resource -> update -> verify -> delete)\n- Monitoring business processes that span multiple services\n- Validating data consistency across multiple endpoints\n\n| Parameter | Description | Default |\n|:----------------------------------|:----------------------------------------------------------------------------------------------------|:--------------|\n| `suites` | List of suites to monitor. | `[]` |\n| `suites[].enabled` | Whether to monitor the suite. | `true` |\n| `suites[].name` | Name of the suite. Must be unique. | Required `\"\"` |\n| `suites[].group` | Group name. Used to group multiple suites together on the dashboard. | `\"\"` |\n| `suites[].interval` | Duration to wait between suite executions. | `10m` |\n| `suites[].timeout` | Maximum duration for the entire suite execution. | `5m` |\n| `suites[].context` | Initial context values that can be referenced by endpoints. | `{}` |\n| `suites[].endpoints` | List of endpoints to execute sequentially. | Required `[]` |\n| `suites[].endpoints[].store` | Map of values to extract from the response and store in the suite context (stored even on failure). | `{}` |\n| `suites[].endpoints[].always-run` | Whether to execute this endpoint even if previous endpoints in the suite failed. | `false` |\n\n**Note**: Suite-level alerts are not supported yet. Configure alerts on individual endpoints within the suite instead.\n\n#### Using Context in Endpoints\nOnce values are stored in the context, they can be referenced in subsequent endpoints:\n- In the URL: `https:\u002F\u002Fapi.example.com\u002Fusers\u002F[CONTEXT].user_id`\n- In headers: `Authorization: Bearer [CONTEXT].auth_token`\n- In the body: `{\"user_id\": \"[CONTEXT].user_id\"}`\n- In conditions: `[BODY].server_ip == [CONTEXT].server_ip`\n\nNote that context\u002Fstore keys are limited to A-Z, a-z, 0-9, underscores (`_`), and hyphens (`-`).\n\n#### Example Suite Configuration\n```yaml\nsuites:\n - name: item-crud-workflow\n group: api-tests\n interval: 5m\n context:\n price: \"19.99\" # Initial static value in context\n endpoints:\n # Step 1: Create an item and store the item ID\n - name: create-item\n url: https:\u002F\u002Fapi.example.com\u002Fitems\n method: POST\n body: '{\"name\": \"Test Item\", \"price\": \"[CONTEXT].price\"}'\n conditions:\n - \"[STATUS] == 201\"\n - \"len([BODY].id) > 0\"\n - \"[BODY].price == [CONTEXT].price\"\n store:\n itemId: \"[BODY].id\"\n alerts:\n - type: slack\n description: \"Failed to create item\"\n\n # Step 2: Update the item using the stored item ID\n - name: update-item\n url: https:\u002F\u002Fapi.example.com\u002Fitems\u002F[CONTEXT].itemId\n method: PUT\n body: '{\"price\": \"24.99\"}'\n conditions:\n - \"[STATUS] == 200\"\n alerts:\n - type: slack\n description: \"Failed to update item\"\n\n # Step 3: Fetch the item and validate the price\n - name: get-item\n url: https:\u002F\u002Fapi.example.com\u002Fitems\u002F[CONTEXT].itemId\n method: GET\n conditions:\n - \"[STATUS] == 200\"\n - \"[BODY].price == 24.99\"\n alerts:\n - type: slack\n description: \"Item price did not update correctly\"\n\n # Step 4: Delete the item (always-run: true to ensure cleanup even if step 2 or 3 fails)\n - name: delete-item\n url: https:\u002F\u002Fapi.example.com\u002Fitems\u002F[CONTEXT].itemId\n method: DELETE\n always-run: true\n conditions:\n - \"[STATUS] == 204\"\n alerts:\n - type: slack\n description: \"Failed to delete item\"\n```\n\nThe suite will be considered successful only if all required endpoints pass their conditions.\n\n\n### Conditions\nHere are some examples of conditions you can use:\n\n| Condition | Description | Passing values | Failing values |\n|:---------------------------------|:----------------------------------------------------|:---------------------------|------------------|\n| `[STATUS] == 200` | Status must be equal to 200 | 200 | 201, 404, ... |\n| `[STATUS] \u003C 300` | Status must lower than 300 | 200, 201, 299 | 301, 302, ... |\n| `[STATUS] \u003C= 299` | Status must be less than or equal to 299 | 200, 201, 299 | 301, 302, ... |\n| `[STATUS] > 400` | Status must be greater than 400 | 401, 402, 403, 404 | 400, 200, ... |\n| `[STATUS] == any(200, 429)` | Status must be either 200 or 429 | 200, 429 | 201, 400, ... |\n| `[CONNECTED] == true` | Connection to host must've been successful | true | false |\n| `[RESPONSE_TIME] \u003C 500` | Response time must be below 500ms | 100ms, 200ms, 300ms | 500ms, 501ms |\n| `[IP] == 127.0.0.1` | Target IP must be 127.0.0.1 | 127.0.0.1 | 0.0.0.0 |\n| `[BODY] == 1` | The body must be equal to 1 | 1 | `{}`, `2`, ... |\n| `[BODY].user.name == john` | JSONPath value of `$.user.name` is equal to `john` | `{\"user\":{\"name\":\"john\"}}` | |\n| `[BODY].data[0].id == 1` | JSONPath value of `$.data[0].id` is equal to 1 | `{\"data\":[{\"id\":1}]}` | |\n| `[BODY].age == [BODY].id` | JSONPath value of `$.age` is equal JSONPath `$.id` | `{\"age\":1,\"id\":1}` | |\n| `len([BODY].data) \u003C 5` | Array at JSONPath `$.data` has less than 5 elements | `{\"data\":[{\"id\":1}]}` | |\n| `len([BODY].name) == 8` | String at JSONPath `$.name` has a length of 8 | `{\"name\":\"john.doe\"}` | `{\"name\":\"bob\"}` |\n| `has([BODY].errors) == false` | JSONPath `$.errors` does not exist | `{\"name\":\"john.doe\"}` | `{\"errors\":[]}` |\n| `has([BODY].users) == true` | JSONPath `$.users` exists | `{\"users\":[]}` | `{}` |\n| `[BODY].name == pat(john*)` | String at JSONPath `$.name` matches pattern `john*` | `{\"name\":\"john.doe\"}` | `{\"name\":\"bob\"}` |\n| `[BODY].id == any(1, 2)` | Value at JSONPath `$.id` is equal to `1` or `2` | 1, 2 | 3, 4, 5 |\n| `[CERTIFICATE_EXPIRATION] > 48h` | Certificate expiration is more than 48h away | 49h, 50h, 123h | 1h, 24h, ... |\n| `[DOMAIN_EXPIRATION] > 720h` | The domain must expire in more than 720h | 4000h | 1h, 24h, ... |\n\n\n#### Placeholders\n| Placeholder | Description | Example of resolved value |\n|:---------------------------|:------------------------------------------------------------------------------------------|:---------------------------------------------|\n| `[STATUS]` | Resolves into the HTTP status of the request | `404` |\n| `[RESPONSE_TIME]` | Resolves into the response time the request took, in ms | `10` |\n| `[IP]` | Resolves into the IP of the target host | `192.168.0.232` |\n| `[BODY]` | Resolves into the response body. Supports JSONPath. | `{\"name\":\"john.doe\"}` |\n| `[CONNECTED]` | Resolves into whether a connection could be established | `true` |\n| `[CERTIFICATE_EXPIRATION]` | Resolves into the duration before certificate expiration (valid units are \"s\", \"m\", \"h\".) | `24h`, `48h`, 0 (if not protocol with certs) |\n| `[DOMAIN_EXPIRATION]` | Resolves into the duration before the domain expires (valid units are \"s\", \"m\", \"h\".) | `24h`, `48h`, `1234h56m78s` |\n| `[DNS_RCODE]` | Resolves into the DNS status of the response | `NOERROR` |\n\n\n#### Functions\n| Function | Description | Example |\n|:---------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------------------|\n| `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` |\n| `has` | Returns `true` or `false` based on whether a given path is valid. Works only with the `[BODY]` placeholder. | `has([BODY].errors) == false` |\n| `pat` | Specifies that the string passed as parameter should be evaluated as a pattern. Works only with `==` and `!=`. | `[IP] == pat(192.168.*)` |\n| `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)` |\n\n> 💡 Use `pat` only when you need to. `[STATUS] == pat(2*)` is a lot more expensive than `[STATUS] \u003C 300`.\n\n### Web\nAllows you to configure how and where the dashboard is being served.\n\n| Parameter | Description | Default |\n|:---------------------------|:--------------------------------------------------------------------------------------------|:----------|\n| `web` | Web configuration | `{}` |\n| `web.address` | Address to listen on. | `0.0.0.0` |\n| `web.port` | Port to listen on. | `8080` |\n| `web.read-buffer-size` | Buffer size for reading requests from a connection. Also limit for the maximum header size. | `8192` |\n| `web.tls.certificate-file` | Optional public certificate file for TLS in PEM format. | `\"\"` |\n| `web.tls.private-key-file` | Optional private key file for TLS in PEM format. | `\"\"` |\n\n### UI\nAllows 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.\n\n| Parameter | Description | Default |\n|:--------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------|\n| `ui` | UI configuration | `{}` |\n| `ui.title` | [Title of the document](https:\u002F\u002Fdeveloper.mozilla.org\u002Fen-US\u002Fdocs\u002FWeb\u002FHTML\u002FElement\u002Ftitle). | `Health Dashboard ǀ Gatus` |\n| `ui.description` | Meta description for the page. | `Gatus is an advanced...`. |\n| `ui.dashboard-heading` | Dashboard title between header and endpoints | `Health Dashboard` |\n| `ui.dashboard-subheading` | Dashboard description between header and endpoints | `Monitor the health of your endpoints in real-time` |\n| `ui.header` | Header at the top of the dashboard. Also used as the title on the OIDC login page. | `Gatus` |\n| `ui.logo` | URL to the logo to display. When set, shown alongside the Gatus logo on the OIDC login page. | `\"\"` |\n| `ui.link` | Link to open when the logo is clicked. | `\"\"` |\n| `ui.favicon.default` | Favourite default icon to display in web browser tab or address bar. | `\u002Ffavicon.ico` |\n| `ui.favicon.size16x16` | Favourite icon to display in web browser for 16x16 size. | `\u002Ffavicon-16x16.png` |\n| `ui.favicon.size32x32` | Favourite icon to display in web browser for 32x32 size. | `\u002Ffavicon-32x32.png` |\n| `ui.buttons` | List of buttons to display below the header. | `[]` |\n| `ui.buttons[].name` | Text to display on the button. | Required `\"\"` |\n| `ui.buttons[].link` | Link to open when the button is clicked. | Required `\"\"` |\n| `ui.custom-css` | Custom CSS | `\"\"` |\n| `ui.dark-mode` | Whether to enable dark mode by default. Note that this is superseded by the user's operating system theme preferences. | `true` |\n| `ui.default-sort-by` | Default sorting option for endpoints in the dashboard. Can be `name`, `group`, or `health`. Note that user preferences override this. | `name` |\n| `ui.default-filter-by` | Default filter option for endpoints in the dashboard. Can be `none`, `failing`, or `unstable`. Note that user preferences override this. | `none` |\n| `ui.login-subtitle` | Subtitle displayed on the OIDC login page. | `System Monitoring Dashboard` |\n\n### Announcements\nSystem-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.\n\nThis is essentially what some status page calls \"incident communications\".\n\n| Parameter | Description | Default |\n|:----------------------------|:-------------------------------------------------------------------------------------------------------------------------|:---------|\n| `announcements` | List of announcements to display | `[]` |\n| `announcements[].timestamp` | UTC timestamp when the announcement was made (RFC3339 format) | Required |\n| `announcements[].type` | Type of announcement. Valid values: `outage`, `warning`, `information`, `operational`, `none` | `\"none\"` |\n| `announcements[].message` | The message to display to users | Required |\n| `announcements[].archived` | Whether to archive the announcement. Archived announcements show at the bottom of the status page instead of at the top. | `false` |\n\nTypes:\n- **outage**: Indicates service disruptions or critical issues (red theme)\n- **warning**: Indicates potential issues or important notices (yellow theme)\n- **information**: General information or updates (blue theme)\n- **operational**: Indicates resolved issues or normal operations (green theme)\n- **none**: Neutral announcements with no specific severity (gray theme, default if none are specified)\n\nExample Configuration:\n```yaml\nannouncements:\n - timestamp: 2025-11-07T14:00:00Z\n type: outage\n message: \"Scheduled maintenance on database servers from 14:00 to 16:00 UTC\"\n - timestamp: 2025-11-07T16:15:00Z\n type: operational\n message: \"Database maintenance completed successfully. All systems operational.\"\n - timestamp: 2025-11-07T12:00:00Z\n type: information\n message: \"New monitoring dashboard features will be deployed next week\"\n - timestamp: 2025-11-06T09:00:00Z\n type: warning\n message: \"Elevated API response times observed for US customers\"\n archived: true\n```\n\nIf at least one announcement is archived, a **Past Announcements** section will be rendered at the bottom of the status page:\n![Gatus past announcements section](.github\u002Fassets\u002Fpast-announcements.jpg)\n\n\n### Storage\n| Parameter | Description | Default |\n|:------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------|:-----------|\n| `storage` | Storage configuration | `{}` |\n| `storage.path` | Path to persist the data in. Only supported for types `sqlite` and `postgres`. | `\"\"` |\n| `storage.type` | Type of storage. Valid types: `memory`, `sqlite`, `postgres`. | `\"memory\"` |\n| `storage.caching` | Whether to use write-through caching. Improves loading time for large dashboards. \u003Cbr \u002F>Only supported if `storage.type` is `sqlite` or `postgres` | `false` |\n| `storage.maximum-number-of-results` | The maximum number of results that an endpoint can have | `100` |\n| `storage.maximum-number-of-events` | The maximum number of events that an endpoint can have | `50` |\n\nThe results for each endpoint health check as well as the data for uptime and the past events must be persisted\nso that they can be displayed on the dashboard. These parameters allow you to configure the storage in question.\n\n- If `storage.type` is `memory` (default):\n```yaml\n# Note that this is the default value, and you can omit the storage configuration altogether to achieve the same result.\n# Because the data is stored in memory, the data will not survive a restart.\nstorage:\n type: memory\n maximum-number-of-results: 200\n maximum-number-of-events: 5\n```\n- If `storage.type` is `sqlite`, `storage.path` must not be blank:\n```yaml\nstorage:\n type: sqlite\n path: data.db\n```\nSee [examples\u002Fdocker-compose-sqlite-storage](.examples\u002Fdocker-compose-sqlite-storage) for an example.\n\n- If `storage.type` is `postgres`, `storage.path` must be the connection URL:\n```yaml\nstorage:\n type: postgres\n path: \"postgres:\u002F\u002Fuser:password@127.0.0.1:5432\u002Fgatus?sslmode=disable\"\n```\nSee [examples\u002Fdocker-compose-postgres-storage](.examples\u002Fdocker-compose-postgres-storage) for an example.\n\n\n### Client configuration\nIn order to support a wide range of environments, each monitored endpoint has a unique configuration for\nthe client used to send the request.\n\n| Parameter | Description | Default |\n|:---------------------------------------|:------------------------------------------------------------------------------|:----------------|\n| `client.insecure` | Whether to skip verifying the server's certificate chain and host name. | `false` |\n| `client.ignore-redirect` | Whether to ignore redirects (true) or follow them (false, default). | `false` |\n| `client.timeout` | Duration before timing out. | `10s` |\n| `client.dns-resolver` | Override the DNS resolver using the format `{proto}:\u002F\u002F{host}:{port}`. | `\"\"` |\n| `client.oauth2` | OAuth2 client configuration. | `{}` |\n| `client.oauth2.token-url` | The token endpoint URL | required `\"\"` |\n| `client.oauth2.client-id` | The client id which should be used for the `Client credentials flow` | required `\"\"` |\n| `client.oauth2.client-secret` | The client secret which should be used for the `Client credentials flow` | required `\"\"` |\n| `client.oauth2.scopes[]` | A list of `scopes` which should be used for the `Client credentials flow`. | required `[\"\"]` |\n| `client.proxy-url` | The URL of the proxy to use for the client | `\"\"` |\n| `client.identity-aware-proxy` | Google Identity-Aware-Proxy client configuration. | `{}` |\n| `client.identity-aware-proxy.audience` | The Identity-Aware-Proxy audience. (client-id of the IAP oauth2 credential) | required `\"\"` |\n| `client.tls.certificate-file` | Path to a client certificate (in PEM format) for mTLS configurations. | `\"\"` |\n| `client.tls.private-key-file` | Path to a client private key (in PEM format) for mTLS configurations. | `\"\"` |\n| `client.tls.renegotiation` | Type of renegotiation support to provide. (`never`, `freely`, `once`). | `\"never\"` |\n| `client.network` | The network to use for ICMP endpoint client (`ip`, `ip4` or `ip6`). | `\"ip\"` |\n| `client.tunnel` | Name of the SSH tunnel to use for this endpoint. See [Tunneling](#tunneling). | `\"\"` |\n\n\n> 📝 Some of these parameters are ignored based on the type of endpoint. For instance, there's no certificate involved\n> in ICMP requests (ping), therefore, setting `client.insecure` to `true` for an endpoint of that type will not do anything.\n\nThis default configuration is as follows:\n\n```yaml\nclient:\n insecure: false\n ignore-redirect: false\n timeout: 10s\n```\n\nNote that this configuration is only available under `endpoints[]`, `alerting.mattermost` and `alerting.custom`.\n\nHere's an example with the client configuration under `endpoints[]`:\n\n```yaml\nendpoints:\n - name: website\n url: \"https:\u002F\u002Ftwin.sh\u002Fhealth\"\n client:\n insecure: false\n ignore-redirect: false\n timeout: 10s\n conditions:\n - \"[STATUS] == 200\"\n```\n\nThis example shows how you can specify a custom DNS resolver:\n\n```yaml\nendpoints:\n - name: with-custom-dns-resolver\n url: \"https:\u002F\u002Fyour.health.api\u002Fhealth\"\n client:\n dns-resolver: \"tcp:\u002F\u002F8.8.8.8:53\"\n conditions:\n - \"[STATUS] == 200\"\n```\n\nThis example shows how you can use the `client.oauth2` configuration to query a backend API with `Bearer token`:\n\n```yaml\nendpoints:\n - name: with-custom-oauth2\n url: \"https:\u002F\u002Fyour.health.api\u002Fhealth\"\n client:\n oauth2:\n token-url: https:\u002F\u002Fyour-token-server\u002Ftoken\n client-id: 00000000-0000-0000-0000-000000000000\n client-secret: your-client-secret\n scopes: ['https:\u002F\u002Fyour.health.api\u002F.default']\n conditions:\n - \"[STATUS] == 200\"\n```\n\nThis example shows how you can use the `client.identity-aware-proxy` configuration to query a backend API with `Bearer token` using Google Identity-Aware-Proxy:\n\n```yaml\nendpoints:\n - name: with-custom-iap\n url: \"https:\u002F\u002Fmy.iap.protected.app\u002Fhealth\"\n client:\n identity-aware-proxy:\n audience: \"XXXXXXXX-XXXXXXXXXXXX.apps.googleusercontent.com\"\n conditions:\n - \"[STATUS] == 200\"\n```\n\n> 📝 Note that Gatus will use the [gcloud default credentials](https:\u002F\u002Fcloud.google.com\u002Fdocs\u002Fauthentication\u002Fapplication-default-credentials) within its environment to generate the token.\n\nThis example shows you how you can use the `client.tls` configuration to perform an mTLS query to a backend API:\n\n```yaml\nendpoints:\n - name: website\n url: \"https:\u002F\u002Fyour.mtls.protected.app\u002Fhealth\"\n client:\n tls:\n certificate-file: \u002Fpath\u002Fto\u002Fuser_cert.pem\n private-key-file: \u002Fpath\u002Fto\u002Fuser_key.pem\n renegotiation: once\n conditions:\n - \"[STATUS] == 200\"\n```\n\n> 📝 Note that if running in a container, you must volume mount the certificate and key into the container.\n\n### Tunneling\nGatus supports SSH tunneling to monitor internal services through jump hosts or bastion servers.\nThis is particularly useful for monitoring services that are not directly accessible from where Gatus is deployed.\n\nSSH tunnels are defined globally in the `tunneling` section and then referenced by name in endpoint client configurations.\n\n| Parameter | Description | Default |\n|:--------------------------------------|:------------------------------------------------------------|:--------------|\n| `tunneling` | SSH tunnel configurations | `{}` |\n| `tunneling.\u003Ctunnel-name>` | Configuration for a named SSH tunnel | `{}` |\n| `tunneling.\u003Ctunnel-name>.type` | Type of tunnel (currently only `SSH` is supported) | Required `\"\"` |\n| `tunneling.\u003Ctunnel-name>.host` | SSH server hostname or IP address | Required `\"\"` |\n| `tunneling.\u003Ctunnel-name>.port` | SSH server port | `22` |\n| `tunneling.\u003Ctunnel-name>.username` | SSH username | Required `\"\"` |\n| `tunneling.\u003Ctunnel-name>.password` | SSH password (use either this or private-key) | `\"\"` |\n| `tunneling.\u003Ctunnel-name>.private-key` | SSH private key in PEM format (use either this or password) | `\"\"` |\n| `client.tunnel` | Name of the tunnel to use for this endpoint | `\"\"` |\n\n```yaml\ntunneling:\n production:\n type: SSH\n host: \"jumphost.example.com\"\n username: \"monitoring\"\n private-key: |\n -----BEGIN RSA PRIVATE KEY-----\n MIIEpAIBAAKCAQEA...\n -----END RSA PRIVATE KEY-----\n\nendpoints:\n - name: \"internal-api\"\n url: \"http:\u002F\u002Finternal-api.example.com:8080\u002Fhealth\"\n client:\n tunnel: \"production\"\n conditions:\n - \"[STATUS] == 200\"\n```\n\n> ⚠️ **WARNING**:: Tunneling may introduce additional latency, especially if the connection to the tunnel is retried frequently.\n> This may lead to inaccurate response time measurements.\n\n\n### Alerting\nGatus supports multiple alerting providers, such as Slack and PagerDuty, and supports different alerts for each\nindividual endpoints with configurable descriptions and thresholds.\n\nAlerts are configured at the endpoint level like so:\n\n| Parameter | Description | Default |\n|:-------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|\n| `alerts` | List of all alerts for a given endpoint. | `[]` |\n| `alerts[].type` | Type of alert. \u003Cbr \u002F>See table below for all valid types. | Required `\"\"` |\n| `alerts[].enabled` | Whether to enable the alert. | `true` |\n| `alerts[].failure-threshold` | Number of failures in a row needed before triggering the alert. | `3` |\n| `alerts[].success-threshold` | Number of successes in a row before an ongoing incident is marked as resolved. | `2` |\n| `alerts[].minimum-reminder-interval` | Minimum time interval between alert reminders. E.g. `\"30m\"`, `\"1h45m30s\"` or `\"24h\"`. If empty or `0`, reminders are disabled. Cannot be lower than `5m`. | `0` |\n| `alerts[].send-on-resolved` | Whether to send a notification once a triggered alert is marked as resolved. | `false` |\n| `alerts[].description` | Description of the alert. Will be included in the alert sent. | `\"\"` |\n| `alerts[].provider-override` | Alerting provider configuration override for the given alert type | `{}` |\n\nHere's an example of what an alert configuration might look like at the endpoint level:\n```yaml\nendpoints:\n - name: example\n url: \"https:\u002F\u002Fexample.org\"\n conditions:\n - \"[STATUS] == 200\"\n alerts:\n - type: slack\n description: \"healthcheck failed\"\n send-on-resolved: true\n```\n\nYou can also override global provider configuration by using `alerts[].provider-override`, like so:\n```yaml\nendpoints:\n - name: example\n url: \"https:\u002F\u002Fexample.org\"\n conditions:\n - \"[STATUS] == 200\"\n alerts:\n - type: slack\n provider-override:\n webhook-url: \"https:\u002F\u002Fhooks.slack.com\u002Fservices\u002F**********\u002F**********\u002F**********\"\n```\n\n> 📝 If an alerting provider is not properly configured, all alerts configured with the provider's type will be\n> ignored.\n\n| Parameter | Description | Default |\n|:---------------------------|:----------------------------------------------------------------------------------------------------------------------------------------|:--------|\n| `alerting.awsses` | Configuration for alerts of type `awsses`. \u003Cbr \u002F>See [Configuring AWS SES alerts](#configuring-aws-ses-alerts). | `{}` |\n| `alerting.clickup` | Configuration for alerts of type `clickup`. \u003Cbr \u002F>See [Configuring ClickUp alerts](#configuring-clickup-alerts). | `{}` |\n| `alerting.custom` | Configuration for custom actions on failure or alerts. \u003Cbr \u002F>See [Configuring Custom alerts](#configuring-custom-alerts). | `{}` |\n| `alerting.datadog` | Configuration for alerts of type `datadog`. \u003Cbr \u002F>See [Configuring Datadog alerts](#configuring-datadog-alerts). | `{}` |\n| `alerting.discord` | Configuration for alerts of type `discord`. \u003Cbr \u002F>See [Configuring Discord alerts](#configuring-discord-alerts). | `{}` |\n| `alerting.email` | Configuration for alerts of type `email`. \u003Cbr \u002F>See [Configuring Email alerts](#configuring-email-alerts). | `{}` |\n| `alerting.gitea` | Configuration for alerts of type `gitea`. \u003Cbr \u002F>See [Configuring Gitea alerts](#configuring-gitea-alerts). | `{}` |\n| `alerting.github` | Configuration for alerts of type `github`. \u003Cbr \u002F>See [Configuring GitHub alerts](#configuring-github-alerts). | `{}` |\n| `alerting.gitlab` | Configuration for alerts of type `gitlab`. \u003Cbr \u002F>See [Configuring GitLab alerts](#configuring-gitlab-alerts). | `{}` |\n| `alerting.googlechat` | Configuration for alerts of type `googlechat`. \u003Cbr \u002F>See [Configuring Google Chat alerts](#configuring-google-chat-alerts). | `{}` |\n| `alerting.gotify` | Configuration for alerts of type `gotify`. \u003Cbr \u002F>See [Configuring Gotify alerts](#configuring-gotify-alerts). | `{}` |\n| `alert","Gatus 是一个面向开发者的健康状态仪表盘，支持通过 HTTP、ICMP、TCP 以及 DNS 查询来监控服务，并能够根据诸如状态码、响应时间、证书有效期等条件评估查询结果。其核心功能包括灵活的监控配置、丰富的告警集成（如 Slack、Teams、PagerDuty 等）以及用户友好的界面展示。该工具采用 Go 语言编写，具备高性能和低资源消耗的特点，适合部署于容器环境或 Kubernetes 集群中，用于持续监测关键应用的状态及可用性。无论是个人项目还是企业级应用，Gatus 都能提供可靠的监控与通知解决方案。",2,"2026-06-11 03:02:08","top_language"]