PRTG comprehensively monitors network availability and bandwidth usage, and provides system administrators with live readings and periodical usage trends. Combined with xMatters, you can notify on-call resolvers and give them the information they need to start working on the issue.
This workflow lets you send actionable alerts to on-call resources when xMatters gets a signal from PRTG. 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 PRTG, it sends a JSON-formatted webhook to xMatters, based on the user-defined alert rules. A PRTG 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.
The following instructions describe how to install the workflow through the xMatters one-click installation process.
- Go to the Workflows Templates page and click the PRTG tile.
- 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.
- 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.
- Copy the trigger URL — you’ll use this to configure a webhook in PRTG.
- 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.
- Click Done.
Configure PRTG to send requests to the trigger URL
To have PRTG send alarms to the flow trigger, you need to create a Notification Template and set it to use the trigger URL.
- In PRTG, navigate to Setup > Account Settings > Notification Templates.
- Hover over the + button and select Add Notification Template.
- On the Notification Template settings page, add a Template Name.
- Use the default Notification Summarization setting (Send first DOWN and UP messages ASAP, then summarize).
- Enable the Execute HTTP Action toggle.
- In the URL field, add the xMatters trigger URL.
- Add the target names of any recipients you want xMatters to notify when the alarm fires.
- For example, if you want to notify Emma Pearson, Mary McBride, and the on-call members in the Monitor Team responsible for the service, you'd add ?recipients=epearson,mmcbride,monitor%20team to the URL.
- You must URL-encode any special characters or spaces in the target names.
- Set the HTTP Method to POST and enter the following code into the Payload field:
- Click Create.
You're ready to use the webhook to trigger automated flows, including steps such as sending alerts and initiating incidents, though we always recommend testing before putting things into use.
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.
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.
The person responding to the notification has the following response options:
- Acknowledge: Acknowledges the notifications and stops escalations.
- Escalate: Immediately escalates the alert to the next on-call resolver in a targeted group.
- Close: Ends the xMatters alert and stops notifying all targeted recipients.
- Initiate Incident: Initiates an incident in xMatters.
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:
- Use Slack, Zoom, and Microsoft Teams steps to add collaboration channels to the flow.
- Change the severity of incidents created when a recipient selects the Initiate Incident response.
- Update the message sent to resolvers to include the information most relevant to your team.
- Use the PRTG Alerts trigger to build your own custom flows.