cachethq/cachet
Cachet
Cachet is a self-hosted, open-source status page system designed to communicate service uptime, incident history, and infrastructure performance to end users. It provides a centralized dashboard for managing the operational lifecycle of system components, tracking service disruptions, and scheduling maintenance windows.
The platform distinguishes itself through a comprehensive RESTful API that enables programmatic status page management and automated incident reporting. It supports deep integration with external monitoring tools, allowing for the synchronization of performance metrics and the automated triggering of status updates. Administrators can standardize communication using reusable incident templates and maintain system integrity through event-driven webhook notifications that include payload signing for authenticity.
Beyond core reporting, the system offers extensive customization options for the public-facing interface, including branding, layout adjustments, and custom asset injection. It manages administrative access through team-based permissions and protects service availability using request throttling and token-based authentication. The platform also includes built-in telemetry for usage reporting and tools for visualizing quantitative performance data over time.
The software is built using a model-view-controller pattern and relies on a relational database for state persistence. It is distributed as a web-based application that can be installed and configured to match specific organizational branding requirements.
Features
- Status Page Systems - Provides a self-hosted platform for tracking and communicating service uptime and incident history.
- Public Status Pages - Provides a public-facing dashboard to inform users about real-time system health and maintenance.
- Status Dashboards - Acts as a centralized open-source interface for managing service components and status reporting.
- Incident Management Systems - Enables publishing service incident reports with visibility controls and automated notifications.
- RESTful APIs - Exposes system resources through standardized RESTful endpoints for programmatic management.
- API Throttling - Protects system capacity by enforcing request frequency limits on the API to prevent abuse.
- API Request Authentication - Validates incoming API requests using unique keys to ensure authorized access.
- Token-Based Authentication - Secures administrative operations using token-based authentication to restrict unauthorized access.
- Webhook Event Notifications - Triggers automated HTTP callbacks to external services upon status changes or new incidents.
- Maintenance Pages - Allows publishing planned maintenance events to inform users about upcoming service disruptions.
- Health Monitoring - Reports the current operational state and health summary of monitored services.
- Incident Management - Provides comprehensive incident details including associated components and status updates.
- Infrastructure Dashboards - Features a web-based dashboard for visualizing the operational status of system components.
- Status APIs - Provides a RESTful API for programmatic status page management and automated incident reporting.
- Observability and Monitoring - System for creating and managing public status pages.
- Self-Hosted Status Pages - Laravel-based system for managing service status pages.
- Web Applications - Open-source status page system.
- Application Examples - Status page system for monitoring websites and APIs.
- Business Applications - System for creating beautiful and powerful status pages.
- Relational Database Persistence - Uses relational databases to persist infrastructure status, incident history, and configuration settings.
- Webhook Notifications - Sends automated HTTP requests to external endpoints upon system status changes.
- API Access Restrictions - Protects administrative operations with token requirements while maintaining public transparency.
- Automated Incident Response Workflows - Standardizes incident communication using reusable templates and automated updates.
- Metric and Performance Monitors - Collects and displays quantitative performance data to visualize system uptime and health trends.
- Status Pages - Enables configuration of site identity, including names and descriptive text, to clearly identify monitored services.
- Access Control - Manages team-based permissions for collaborative incident and component management.
- External Service Monitoring - Synchronizes website status and incident history from external monitoring services to maintain a unified view.
- Incident Detail Modifiers - Allows modifying the status, visibility, and message of an existing service incident.
- Incident Progress Reporters - Enables appending progress reports to an ongoing incident to communicate evolving information.
- Data Recording - Supports logging specific numerical values to track system performance and uptime statistics.
- Infrastructure Monitoring - Integrates with external monitoring tools to synchronize performance metrics and service availability.
- Service Metrics Monitoring - Supports defining custom performance indicators to report system health trends.
- Branding Customizations - Allows organizations to apply custom branding, including banner images and accent colors, to their status page.
- Threshold Monitoring - Triggers major outage alerts based on the percentage of offline components.
- Component Metadata Retrievers - Allows fetching paginated lists of system components with filtering capabilities.
- Incident Component Linkers - Allows associating specific service components with an incident to provide context on affected systems.
- Incident Progress Modifiers - Enables modifying the status and descriptive message of an existing incident report.
- Incident Communication Pages - Provides configurable display settings for incident history and active service disruptions on the public status page.
- Incident Templates - Allows fetching incident templates to standardize reporting and communication structures.
- Metrics Retrieval - Enables programmatic retrieval of performance metrics for external analysis and reporting.
- Performance Visualization - Visualizes quantitative performance data over time to track infrastructure health trends.
- Server-Side Template Engines - Uses server-side template engines to dynamically generate incident reports and status page layouts.
- Page Content Injections - Allows embedding custom scripts and styles to modify the status page layout.
