Alerts - PagerDuty

Objective

This document provides instructions on how to configure alert notifications in VoltConsole to route the alert messages to your PagerDuty service. For information on Volterra alerts, see Alerting with Webhooks.


Prerequisites

  • VES account

    Note: If you do not have an account, see Create a VES Account.

  • A PagerDuty account with administrative privileges to service configuration settings.

Configuration

Configuring to send alerts to the PagerDuty service requires you to first generate webhook for your PagerDuty service. After that, create alert receiver, policy, and policy set in the VoltConsole.

Create Webhook for PagerDuty Service

PagerDuty supports webhooks by providing service integration via API. This example shows instructions on generating the webhook configuration for a PagerDuty service.

Note: PagerDuty service integration generates an integration key which is used as webhook.

Step 1: Generate webhook configuration in PagerDuty.

Log into your enterprise PagerDuty portal and follow the instructions in the PagerDuty Webhooks page to generate the integration key for the service to which you want to post the alerts.

Step 2: Get the integration key from the webhook configuration in PagerDuty.

Navigate to your service configuration settings on PagerDuty and obtain the integration key under the Integrations section.

PagerDutySrvc
Figure: PagerDuty Service Configuration

The following is a sample servie integration on PagerDuty.

WhPagerDuty
Figure: PagerDuty Webhook Integration Key


Create Alert Receiver

This example shows the alert notification for PagerDuty.

Step 1:Start creating the alert receiver in VoltConsole.

Log into the VoltConsole and change to your namespace. Select Manage from the configuration menu and Alert Config from the options pane. Select Alert Receiver from the options under the Alert Config and click Add alert receiver.

AlertRecNav
Figure: Alert Receiver Creation Form

Step 2: Set PagerDuty as the receiver.

Enter name and select PagerDuty for the Receiver field.

Step 3: Configure the secret for PagerDuty.

Configure the settings for the Secret field as per the following guidelines:

  • Select Blindfold Secret for the Secret info field.
  • Enter the string obtained from applying Blindfold to the webhook configuration. See Blindfold your Application Secrets for information on how to encrypt your application secrets.
  • Select Base64 for the Secret Encoding field.

ar basic
Figure: Alert Receiver Configuration

Note: You can also select other values for the Secret info field and set the subsequent values as per the following guidelines.

Secret Guidelines
Vault Secret Enter the values for the provider and location.
Clear Secret Enter the value for the URL in the string:///<string> format.
Bootstrap Secret Enter the name of the secret.

It is recommended to encode your secret using the Base64 encryption and set the secret encoding as Base64. However, in case of clear secret, select the encoding as EncodingNone.

Step 4: Specify the API for PagerDuty service and complete creating the receiver.

Enter the URL to the PagerDuty service (to which you want to send the API request) in the URL field. Click Continue to complete creating the alert receiver.


Create Alert Policy

Step 1:Start creating alert policy.

Log into the VoltConsole and change to your namespace. Select Manage from the configuration menu and Alert Config from the options pane. Select Alert Policy from the options under the Alert Config and click Add alert policy.

Step 2:Select the alert receiver.

Enter a name for the policy and click Select receiver to open the receiver selection form. Select the receiver you created in the Create Alert Receiver chapter and click Select receiver to add the receiver to the policy.

ap basic
Figure: Alert Policy Receiver Configuration

Step 3: Configure notification intervals.

Enter the configuration for the Notification Parameters as per the following guidelines:

  • Enter a value in the [0-9][smhd] format for the Notify Interval for a Alert field. The [smhd] specifies seconds, minutes, hours, and days. An example value is 1h and default is 4h.
  • Enter a value in the [0-9][smhd] format for the Wait to Notify field. The [smhd] specifies seconds, minutes, hours, and days. An example value is 2m and default is 30s.
  • Enter a value in the [0-9][smhd] format for the Notify Interval for a Group field. The [smhd] specifies seconds, minutes, hours, and days. An example value is 5m and default is 1m.
Step 4: Set the alert match conditions and associated actions.

Select options for the Select Alerts Match Condition and the Action fields. This example configures the match for any condition using the Any value and send action using the Send value.

ap routes
Figure: Alert Policy Route Configuration

Note: You can also set the match conditions based on the severity, group name, and alert name.

Step 5: Optionally, add policy rules.

Click Add route to add more policy rules.

Step 6: Complete alert policy creation.

Click Continue to complete creating the alert policy.


Create Alert Policy Set

Step 1: Start creating the alert policy set.

Log into the VoltConsole and change to your namespace. Select Manage from the configuration menu and Alert Config from the options pane. Select Alert Policy Set from the options under the Alert Config and click Add alert policy set.

Step 2: Add the alert policy to the policy set.

Add a name and click Select policy to open the policy selection form. Select the created alert policy and click Select policy again to add the policies to the policy set.

aps basic
Figure: Alert Policy Set Configuration

Step 3: Complete creating the alert policy set.

Click Continue to complete creating the alert policy set.


Verification and Example

You can now verify the alert notifications by visiting your PagerDuty service page. The following image shows a sample of alerts sent to PagerDuty service:

pd alerts
Figure: Post of Alerts to PagerDuty Service


Concepts


How-to