Skip to main content

Auto Incident Setup

Auto Incident allows you to automatically create incidents in your status page when a monitored service goes down. This ensures your subscribers are immediately informed about any outages.

Setup Guide​

Step 1: Create a Component​

tip

Before starting, ensure you have a clear understanding of which services you want to monitor. Group related services together for better organization.

  1. Go to Component Management
  2. Select or create a Component Group
  3. Click Add Component
  4. Fill in the component details:
    • Name: Your service name (e.g., "Payment API")
    • Description: Brief description of the service
    • Status: Set to Operational initially
  5. Save the component

Step 2: Create a Monitor​

tip

Choose an appropriate check interval based on your service's criticality. For critical services, use shorter intervals (1-2 minutes). For less critical services, 5-10 minutes is sufficient.

  1. Go to Monitors tab
  2. Click Add Monitor
  3. Configure the monitor:
    • Monitor Type: Select Component
  4. Save the monitor

Step 3: Create an Alert Rule​

  1. Go to Alert Rules
  2. Click Add Rule
  3. Configure the rule:
    • Monitor Tab: Select your Component
    • Select Monitor: Choose the monitor you created
    • Sub Type: Choose Partial Outage, Major Outage, or other
  4. Save the rule

Step 4: Create an Alert Action​

important

Make sure to check Create Incident to enable automatic incident creation. Without this, notifications will be sent but no incident will be created on your status page.

  1. Go to Alert Actions
  2. Click Add Action
  3. Configure the action:
    • Type: Select Component
    • Create Incident: Check this box to automatically create incidents
    • Send Notification: Check this box to notify subscribers
  4. Save the action
  1. Go to Component Management
  2. Edit the component you created
  3. Select the Monitor you created
  4. Save the component

How It Works​

Once configured, here's what happens:

  1. Monitoring: The monitor checks your component at regular intervals (e.g., every 1 minute)
  2. Failure Detection: If the service is down for the configured condition (e.g., 3 consecutive failures in 3 minutes)
  3. Notification: The system sends notifications via your configured channels
  4. Incident Created: An incident is automatically created with:
    • Title: The Monitor Name
    • Description: The response/error message
    • Sub-Type: Partial Outage or Major Outage (as configured)
  5. Auto Resolution: When the service recovers, the incident is automatically resolved

Configuration Tips​

  • Failure Condition: Set how many consecutive failures trigger an incident (e.g., 3 down in 3 minutes)
  • Check Interval: Configure how often the monitor checks your service
  • Notification Channels: You can enable multiple notification methods (Email, Slack, SMS, etc.)