PagerDuty Integration: Difference between revisions

From OSNEXUS Online Documentation Site
Jump to navigation Jump to search
← Older editNewer edit →
Visual
mNo edit summary
Line 1: Line 1:
[[Category:integration_guide]]
[[Category:integration_guide]]


PagerDuty is an alarm aggregation and dispatching service for system administrators and support teams. It collects alerts from your monitoring tools, gives you an overall view of all of your monitoring alarms, and alerts an on duty engineer if there's a problem.  
PagerDuty is an ITSM (IT Service Management) for IT organizations to manage their support process and ticketing. Quantastor integrates with PagerDuty to forward a copy of all alerts that are severity "Error", "Warning", or "Critical".  Integration with PagerDuty is done via a webhook URL which must be added to the QuantaStor Alert Manager screen as a new Alert Endpoint.


Quantastor can be setup to trigger PagerDuty alerts when Quantastor encounters an alert that is of severity "Error", "Warning", or "Critical". Getting setup only requires a few simple steps (internet connection required).
== Step 1 - Add a Service ==


=== Adding a New Service in PagerDuty ===
After logging into your PagerDuty account navigate to *Services* -> *Service Directory* then choose the "+ New Service" to add a new service endpoint.


{|
Enter a name for the service such as "QuantaStor Alerts" or something more specific to the storage grid you'll have alerts originating from "qs-grid-1 alerts".
|-
|
[[File:pagerDutySetup1.png|400px]]
|
After logging into your PagerDuty account click on the "Services" tab along the top.
From here click on the "Add New Service" button.


This service is what all of the Quantastor alerts will be kept under. This will keep the alerts separate from the other programs that may be sending their alerts to PagerDuty.
== Step 2 - Add an Integration ==
|-
|
[[File:pagerDutySetup2.png|400px]]
|
For the "Service Name" field I would recommend something that describes the box or grid that is being monitored. Also make sure to select "Generic API System" under service type. Quantastor uses PagerDuty's API to post the alert to PagerDuty. After everything is set click "Add Service".
|-
|
[[File:pagerDutySetup3.png|400px]]
|
Everything on the PagerDuty side should now be setup. Copy the "Service API Key" and set it aside. This key is the input parameter to tell Quantastor where to post the alert.
|}


=== Adding PagerDuty to Quantastor ===
QuantaStor integrates with PagerDuty via the "Events API V2" so you'll need to add that integration to the service.


{|
== Step 3 - Get the Integration Key ==
|-
|
[[File:Alert Manager Web.jpg|400px]]
|
Open the web interface for the Quantastor system. Right click on the storage system or grid, and select "Alert Manager".
|-
|
[[File:Alert Manager - Cloud Alerts.jpg|400px]]
|
In the text box titled "PagerDuty.com Service Key" paste the service key from before. Then click on "Apply".
|-
|
[[File:Alert Manager - Send User Generated Alert.jpg|400px]]
|-
|
[[File:Alert Manager - Alert Types.jpg|400px]]
|
To test if the system is working select generate test alert. Make sure to select a severity level of "Error", "Warning", or "Critical" and then click okay. If everything is setup correctly a test alert should now be generated and sent to PagerDuty.
|}


=== Example Alerts ===
After adding the integration click on the gear icon so that you can view the "Integration Key" which is also known as the "Routing Key" or "Routing Token".  It will look something like this:


When Quantastor sends an alert to PagerDuty it also sends a list of details to make solving the issue easier. These details include:
<pre>
* The serial number of the system
923c2db8f5384103c09fdf1a9f506162
* The startup time of the system
</pre>
* The location
* The title of the alert
* The version of the Quantastor service
* The time at which the alert was sent
* The name of the system
* The id of the system
* The current firmware version
* The severity of the alert
 
 
{|
|-
|
[[File:pagerduty5.png|400px]]
|
[[File:pagerduty4.png|400px]]
|}

Revision as of 18:49, 15 March 2022


PagerDuty is an ITSM (IT Service Management) for IT organizations to manage their support process and ticketing. Quantastor integrates with PagerDuty to forward a copy of all alerts that are severity "Error", "Warning", or "Critical". Integration with PagerDuty is done via a webhook URL which must be added to the QuantaStor Alert Manager screen as a new Alert Endpoint.

Step 1 - Add a Service

After logging into your PagerDuty account navigate to *Services* -> *Service Directory* then choose the "+ New Service" to add a new service endpoint.

Enter a name for the service such as "QuantaStor Alerts" or something more specific to the storage grid you'll have alerts originating from "qs-grid-1 alerts".

Step 2 - Add an Integration

QuantaStor integrates with PagerDuty via the "Events API V2" so you'll need to add that integration to the service.

Step 3 - Get the Integration Key

After adding the integration click on the gear icon so that you can view the "Integration Key" which is also known as the "Routing Key" or "Routing Token". It will look something like this: 

923c2db8f5384103c09fdf1a9f506162
Retrieved from "https://wiki.osnexus.com/index.php?title=PagerDuty_Integration&oldid=20248"