Logz.io

Logz.io is a cloud-based, open-source observability platform that enables you to manage all your monitoring tools on one scalable system. Combined with xMatters, Logz.io collects and analyzes logs to help on-call resolvers reduce response time while troubleshooting issues.

This workflow lets you send actionable alerts to on-call resources when xMatters gets a signal from Logz.io. Responders can initiate an incident with the press of a button, or you can build on the flow to perform automated resolution tasks.

How it works

When an alert is generated in Logz.io, it sends a JSON-formatted webhook to xMatters, based on the user-defined alert rules. A Logz.io trigger in xMatters parses the webhook and initiates a flow. The webhook includes essential alert data that is included in notifications sent to users, and details about the origin of the alert that you can use to enrich the notifications or use when building automated tasks.

Install the workflow

The following instructions describe how to install the workflow through the xMatters one-click installation process.

  1. Go to the Workflows Templates page and click the Logz.io tile.
  2. On the Install Workflow dialog box, give the workflow a name (this must be unique in your instance) and add an optional description.
    • You can edit these later, if needed.

  3. Click Install.
    • After the workflow installs, the screen shows next steps as well an installation log. The installation log gives you additional information about the installation, such as if you have languages in your instance that aren't configured for the messages in the workflow.
  4. Select the authentication method you want to use.
  5. Copy the trigger URL — you’ll use this to configure a webhook in Logz.io.
    • The trigger URL includes the recipients parameter, which specifies who should be notified. By default, this parameter is set to notify you, the logged in user, but you can set it to target any user or group you want.
  6. Click Done.

Configure Logz.io to send requests to the trigger URL

To have Logz.io send alerts to the flow trigger, you need to create a custom endpoint and set it to use the trigger URL. 

Set recipients in the trigger URL

The trigger expects the recipients in the trigger URL. When you copy the URL from xMatters, it includes the recipients parameter: recipients=<yourname>. Of course, you don’t want to receive all the alerts.

To change the recipients for alerts from this webhook, swap out your name for the people or groups you want to target. For example, to target the Antares service team and the Database Admins add recipients=antaresteam,dbadmins to the trigger URL. Remember to URL-encode any special characters in your group names.

We recommend using groups so you can take advantage of the xMatters group features — rotations, escalations, and absences — to reach the right on-call people to jump on an issue.

How to use the workflow

When an alert rule you’ve set to use the action group fires, it sends a signal to xMatters, which creates an alert and notifies the individual or the on-call members of the groups you set as recipients in the webhook URL.

When a condition you've set fires, it sends a signal to xMatters, which creates an alert and notifies the individual or the on-call members of the people or groups you set as recipients in the webhook URL. When the trigger receives a signal saying the issue is resolved, it automatically terminates related alerts in xMatters.

Next Steps

Now that you've installed the workflow, you can use it as-is, or customize it to suit your needs better. Here are some examples of things you can add to the workflow to customize it: