Attaching runbooks to alarms

You've created an alert, and connected to an unSkript Webhook. Let's connect it to a RunBook!

In order to connect an alarm to a RunBook you must have first completed the following steps:

  1. Create an alert

    1. Create a Cloudwatch Alert

  2. Sync the alerts into unSkript

  3. The Alarm must have fired at least once. You can test the alert from Grafana or Cloudwatch as a proxy.

  4. Have a RunBook in mind to connect to the alert.

With these steps completed, we are ready to connect the Alert to the RunBook.

Attaching your Alarm to a RunBook

  1. Find your Alarms: Click the Events button in the top navigation of unSkript. You'll land on the listing of alarms that are already attached to RunBooks (if this is the first alarm, the table will be empty).

  2. Alarms not attached to RunBooks: Since your alarms are not yet attached to a RunBook, click "unattached" on the top right of the table. This will give you a list of all alarms that have been synced into unSkript, but do not yet have a RunBook connected. You can use the search box to filter the results. The the screenshot below, we have filtered on the term "docs."

  3. Attach your alarm: Click the checkbox to select the alarms you'd like to connect to a RunBook, and then click the "attach RunBook" button that is above the table.

  4. Select your RunBook: Select the RunBook you'd like to connect to the alarm

  5. If your alarm has fired, you will be prompted to connect the output of the alarm to the input parameters of your RunBook.

If your alarm has not fired, you can TEST your alarm.

  1. To connect alarm parameters to RunBook input parameters, we will use JQ commands:

  2. In the screenshot above, the left side shows the input parameters for the RunBook (in this case "alarm_name" and "alarm_value." The right side shows the 5 most recent alerts from the alarm.

    1. Use JQ commands to select the items from the JSON to populate the RunBook inputs.

    2. if you have never used jq, there is an autofill feature. Type a period into the box, and a set of options will appear.

    3. Once you have chosen the desired path, click return, and the value will appear below the field.

  3. Click attach RunBook to connect the alert to the RunBook.

Last updated