Incidents

​

Incidents

In Cachet, an incident represents any ongoing issue or event that affects the service. Incidents can be managed via the dashboard. Incidents consist of:

• Name: A brief description of the incident.
• Status: The current status of the incident.
• Message: A detailed description of the incident.
• Occurred At: The time the incident occurred. This can be left empty if the incident happened at the time of reporting.
• Visibility: Whether the incident should be visible to users, guests or always be hidden.

The Cachet dashboard provides a simple interface to manage incidents. You can quickly record a new incident by clicking the “New Incident” link in the top navigation bar. You can also view and manage existing incidents by clicking the “Incidents” link in the sidebar.

​

Incident Statuses

Incidents and updates in Cachet can have one of the following statuses:

• Reported: The incident has been reported.

• Investigating: The incident is actively being investigated.

• Identified: The cause of the incident has been identified.

• Watching: The incident or the resolution is being watched.

• Fixed: The incident is fully resolved.

​

Incident Components

Incidents don’t typically occur in isolation. They often affect one or more components of the service. Cachet allows you to link incidents to components to provide more context about the incident.

Once you’ve created an incident, you can link it to a component by editing the incident and clicking “Attach” in the “Components” panel on the incident page. When attaching a component, you may also select what status to update the component to.

​

Incident Updates

Typically, incidents are ongoing events that require updates to keep users informed. Incident updates can be added to an incident to provide more information about the incident. Incident updates consist of:

• Message: A detailed description of the update.
• Status: The status of the incident after the update.

To update an incident, head to the “Incidents” panel in the dashboard and click “Record Update” on the incident you want to update.

​

Incident Templates

Cachet allows you to create incident templates to help you quickly create incidents. Cachet supports creating incident templates with two templating languages:

Incident templates are particularly powerful when combined with the API as they allow you to create a new incident by passing a template and variables. An incident will be created with the template filled in with the variables you provide.