Gatus

Automated service health dashboard.

Gatus: A Comprehensive Overview

Gatus is an open-source, self-hosted service health dashboard that enables you to monitor and track the status of your applications, services, and endpoints. This powerful tool allows you to set up highly flexible health checks, configure alerts for when issues arise, and even integrate with various notification providers. With Gatus, you can create automated user acceptance tests, leverage its low resource consumption, and enjoy a seamless experience.

Main Features

Usage

Gatus is designed to be easy to use, with a simple configuration process that allows you to add new services or endpoints with minimal effort. Here's a quick start guide:

docker run -p 8080:8080 --name gatus twinproduction/gatus
You can also use GitHub Container Registry if you prefer.

Configuration

Gatus offers a range of features to help you customize its behavior and integrate it with your existing tools. Some key configuration options include:

Endpoints: Define the services or endpoints you want to monitor.
External Endpoints: Connect Gatus to external services or APIs.
Conditions: Set conditions for health checks, such as response time, body, or IP address.
Placeholders: Use placeholders to customize your health check messages.
Functions: Write custom functions to extend the capabilities of Gatus.

Storage

Gatus provides various storage options to suit your needs:

Client configuration: Store client-specific settings and alert configurations.
Alerting: Configure alerts for when issues arise, with support for multiple providers (Slack, Mattermost, Messagebird, PagerDuty, Twilio, Google chat, Teams).
Custom alerts: Create custom alert providers for unique needs.

Maintenance

Gatus prioritizes security and maintenance:

Security: Utilize Basic Authentication, OIDC, or TLS encryption to ensure secure access.
Metrics: Monitor Gatus's performance using built-in metrics (connectivity, remote instances).