PagerDuty alert
The PagerDuty alert method sends alerts through PagerDuty to notify Nobl9 users whenever an incident is triggered.
Authentication
PagerDuty requires specifying the Integration Key that allows it to send you an incident alert. For more details on how to obtain the Integration Key, go to Services and Integrations | PagerDuty documentation.
Known limitations
Currently Nobl9 doesn't return the severity level when a PagerDuty alert is triggered.
Configuring the PagerDuty alert method
You can configure your PagerDuty alert method directly in the Nobl9 UI, or by applying a YAML file in sloctl
.
Nobl9 UI
To set up the alert method in the Nobl9 UI, follow these steps:
- Navigate to Integrations > Alert Methods.
- Click
.
- Click the relevant Alert Method icon.
Then, in the PagerDuty Configuration Wizard:
-
Enter the Integration Key (mandatory).
For more information, refer to the Authentication section. -
Select a Project.
Specifying a project is helpful when multiple users are spread across multiple teams or projects. When the Project field is left blank, Nobl9 uses thedefault
project. -
Enter a Display Name.
You can enter a user-friendly name with spaces in this field. -
Enter a Name.
The name is mandatory and can only contain lowercase, alphanumeric characters, and dashes (for example,my-alert-method-1
). Nobl9 duplicates the display name here, transforming it into the supported format, but you can edit the result. -
Enter a Description.
Here you can add details such as who is responsible for the integration (team/owner) and the purpose of creating it. -
Configure Alert Resolution feature for PagerDuty:
- For PagerDuty alerts, users can select the checkbox in the Alert Resolution section on PagerDuty alert method wizard.
- With this feature activated, Nobl9 will send a notification after the Cooldown period is over.
- Optionally, you can add a message that will be attached to your 'all clear' notification.
cautionThis feature is only available for PagerDuty alert method
- Click Add alert method
YAML configuration for PagerDuty alerts
- Example
- Example
apiVersion: n9/v1alpha
kind: AlertMethod
metadata:
name: string # Mandatory
displayName: string # Optional
project: default # Mandatory
spec:
description: string # Optional
pagerduty:
integrationKey: # PagerDuty integration key
apiVersion: n9/v1alpha
kind: AlertMethod
metadata:
name: pagerduty-notification
displayName: PagerDuty notification
project: default
spec:
description: Sends notification to PagerDuty endpoint
pagerDuty:
integrationKey: "12345678901234567890123456789012"
Configuring sendResolution
for PagerDuty - YAML
It is possible to configure the PagerDuty alert method to send additional messages to PagerDuty to resolve the incident. This can be configured by adding an optional section sendResolution
to your PagerDuty YAML configuration.
sendResolution
feature for PagerDuty adheres to the following rules:
-
If you added the section
sendResolution
in your YAML configuration, then notification is sent to resolve an incident in PagerDuty. -
By default
sendResolution
isnil
. This means that the all-clear notification is not sent by default. -
sendResolution[ ]:message
- string, optional.- If you provide value for this field, it is attached to the summary of incident resolution.
noteOnly PagerDuty supports sending all-clear to the external system. For other alert method types, this section is ignored.
-
Here's an example of the sendResolution YAML configuration for PagerDuty:
apiVersion: n9/v1alpha
kind: AlertMethod
metadata:
name: pager-duty-notification-sending-resolution
displayName: PagerDuty notification
spec:
description: Open new Incident with "Nobl9 Test" service
pagerDuty:
integrationKey: "[secret]"
sendResolution:
message: Alert is now resolved
Sending notification for a resolved alert to PagerDuty
If you configure the PagerDuty alert method to send all-clear, an additional message is sent to PagerDuty service to resolve the incident.
- PagerDuty UI:
![Fig 2.: Resolved incident in PagerDuty](/img/PagerDuty_resolved1.png)
- PagerDuty events API:
![Fig 3.: Resolved incident in PagerDuty](/img/PagerDuty_resolved2.png)
The all-clear message is sent for both alert statuses: Canceled and Resolved.
Testing the PagerDuty alert method in the UI
- Navigate to Integrations > Alert Methods.
- Click the required alert method.
Its Details page opens. - Click Test under the alert method name:
- For the correct configuration, Nobl9 displays Test completed successfully! under the button
- Otherwise, Nobl9 displays the Test failed message, specifying what is set incorrectly