Email Connectivity with All Quiet: Streamlining Incident Creation

Image

Published: Thursday, 23 November 2023

📧 Connect and streamline: Transform emails into incidents within All Quiet, optimizing your incident management with ease.

Welcome to our step-by-step guide on integrating All Quiet with your email notifications! Setting up an email integration in All Quiet automatically generates a unique email address for you. We'll show you how to use this nifty feature to send alerts from your observability platforms straight to All Quiet, effortlessly turning those emails into actionable incidents. You'll learn how to fine-tune attribute mapping to ensure your incidents are captured accurately. Let’s dive in and streamline your incident management process!

Create Email Integration

  1. Select 'Integrations' from the sidebar menu. Click on the 'Inbound' tab.
  2. Fill in the 'Display Name' field with your desired integration name, such as 'My Email Integration'.
  3. Choose your team from the 'Team' dropdown menu.
  4. Select 'Email' as the integration type.
  5. Finally, click on the 'Create integration' button to complete the setup.
Create Email Integration

Individual Email Recipient

  1. Locate the unique email address under 'Email Integration'—this is the address you'll use to send emails that automatically create incidents in the integration's team.
  2. Observe that the 'Latest payloads' section is currently empty, indicating that no emails have yet been sent to this unique address.
  3. Refer to the 'Payload Example' section for the format your email should follow to ensure proper incident creation within All Quiet.
Individual Email Recipient

Send a Test Email

Begin by opening your preferred email client to compose a test message. This is simply a dry run to understand how emails are turned into structured incident reports in All Quiet. The exact content isn't important—it's just to illustrate the process. Once your email client is open, follow these steps:

  1. Compose a sample email, entering a subject such as 'Incident: High CPU consumption on prod-app-01' to represent the type of incident you'd like to report.
  2. In the email body, draft a mockup of incident details, for instance, identifying the server, the environment it's in, and a brief description of the issue, like 'CPU > 75%'.
  3. Send this sample email to the unique email address generated by your All Quiet email integration setup.
Send a Test Email

Inspect Email Payload

  1. Click the 'Reload' button to fetch the latest email payloads received by the All Quiet platform.
  2. Select the most recent payload from the 'Latest payloads' list to view its details.
  3. Review the loaded payload in the 'Payload Example' field, which now contains the actual data sent from your email client, including fields such as 'Message-ID', 'Subject', and 'To'.
Inspect Email Payload

Map Attributes

  • Review the attribute mapping configuration in section (1), which specifies how email content is mapped to incident attributes. In this example, the 'Status' attribute is extracted from the subject line of the email using a regular expression.
  • Examine the 'Server' attribute mapping, which pulls information directly from the email's text body to populate the incident fields.
  • Look at the incident preview in section (2) to verify that the mapping has correctly transformed the email content into a structured incident, displaying fields such as 'Server', 'Environment', and 'Details'.
Map Attributes


            {
  "attributes": [
    {
      "name": "Status",
      "mappings": [
        {
          "jsonPath": "$.subject"
        },
        {
          "regex": "^[^:]*"
        },
        {
          "map": "Incident->Open,->Resolved"
        }
      ]
    },
    {
      "name": "Server",
      "mappings": [
        {
          "jsonPath": "$.textBody"
        },
        {
          "regex": "Server:\\s*(.+)"
        }
      ]
    },
    {
      "name": "Environment",
      "mappings": [
        {
          "jsonPath": "$.textBody"
        },
        {
          "regex": "Environment:\\s*(.+)"
        }
      ]
    },
    {
      "name": "Details",
      "mappings": [
        {
          "jsonPath": "$.textBody"
        },
        {
          "regex": "Details:\\s*(.+)"
        }
      ]
    },
    {
      "name": "Severity",
      "mappings": [
        {
          "static": "Critical"
        }
      ]
    }
  ]
}
        

With the attribute mappings now in place, you've seen how simple it is to transform a standard email into a structured incident within All Quiet. This powerful functionality bridges the gap between your observability platform's alerts and All Quiet's incident management system, allowing for a smoother, more automated workflow.

Read all blog posts and learn about what's happening at All Quiet.