This is designed to help administrators integrate ScienceLogic EM7 management system with PagerDuty’s IT alerting and incident management service. This guide will help prepare you for the integration tasks.
If you are having trouble completing the installation, please contact us.
- Requires ScienceLogic EM7 7.2.2.x or better
- Requires administrative accounts for both products
To integrate PagerDuty with ScienceLogic the following steps will be required.
- Create PagerDuty API Service
- Import PagerDuty Power-Pack into ScienceLogic system
- Create credential for PagerDuty API
- Align ScienceLogic Run Book Automation policies
- Advanced Integration (optional)
It is recommended that you familiarize yourself with the ScienceLogic Run Book Automation (RBA) functionality before activating the PagerDuty Power-Pack. The default PagerDuty RBA policies are very broad and will create new PagerDuty incidents for every event in ScienceLogic that is of severity: minor, major, and critical.
Understanding the Integration
The ScienceLogic PagerDuty integration Power-Pack offers several key functions:
- Run Book Automation policies to trigger, resolve, and acknowledge events from ScienceLogic to PagerDuty.
- Dynamic Application to collect PagerDuty performance metrics, and synchronize incidents acknowledged from PagerDuty.
- PagerDuty performance KPI dashboard with historical dynamic trending.
- PagerDuty example credentials for both Run Book Actions and Dynamic Applications.
- PagerDuty device classes and icons for both Pingable and Virtual devices.
The PagerDuty integration relies on Run Book Automation policies to “push” both events and related event actions to PagerDuty. Activities emanating from PagerDuty, for instance acknowledging an incident, are synchronized through a Dynamic Application. The following diagram shows the dataflow for how ScienceLogic events and PagerDuty incidents are synchronized.
Incidents resolved in the PagerDuty will not automatically resolve events in ScienceLogic. This is because most events in ScienceLogic will automatically resolve themselves if they are no longer active or detected. For instance, if a monitored device is detected as being unavailable, ScienceLogic will create an event, and then create an incident in PagerDuty. If the incident in PagerDuty is resolved but the device is still detected as being unavailable, ScienceLogic will automatically create another event and PagerDuty incident. However if the incident is resolved in PagerDuty, but the event still remains in ScienceLogic, duplicate events will be suppressed. Once the event is no longer valid, ScienceLogic will automatically resolve the event and update the incident in PagerDuty.
We will create a PagerDuty “Generic API” service in the PagerDuty web portal for the ScienceLogic Run Book Automation integration. We will also add an API access key for ScienceLogic Dynamic Application performance and synchronization. Both steps will require you record the “key” to add to the respective ScienceLogic credential. You will need administrative access to your PagerDuty account.
Create a “Generic API system” service:
- In your account, under the Services tab, click “Add New Service”.
- Enter a name for the service (in our example we used ScienceLogic EM7), and select an escalation policy.
- Start typing “ScienceLogic” under “Integration Type” to filter your choices. Then, click the Add Service button.
- Once the service is created, you’ll be taken to the service page. On this page, you’ll see the “Service key”, which will be needed for the ScienceLogic Run Book Automation credential.
- Note: You may create multiple “Generic API” services for use with different PagerDuty policies. The ScienceLogic PagerDuty Power-Pack can be aligned to any number of different PagerDuty accounts and “Generic API” services.
Add API Access Key (for Dynamic Application)
Login in to your PagerDuty portal using an administrator account. Click on the “API Access” on the navigation menu at the top of the page. If there is no API Access Keys defined, create a new key. Add a description for the key, for instance ScienceLogic Synchronization, and then select the “Create Key” button.
When complete, copy the API key for use with the ScienceLogic Dynamic Application Credential.
In ScienceLogic EM7:
Importing the PagerDuty Power-Pack
In this section we will install the PagerDuty Power-Pack and then configure both the Run Book Automation credential and the Dynamic Application credential.
Obtain the latest copy of the “PagerDuty Integration” Power-Pack. In this document we will be using version 0.7.x of the Power-Pack.
Using normal Power-Pack installation procedures, got the System tab, select Manage\Power-Packs, and then select the Action button, and select “Import Power-Pack” Locate the Power-Pack file, and then select the Import button.
Configure RBA Credential
With the Power-Pack installed, we can now configure our Run Book Automation credential. Navigate to the System tab, select Manage\Credentials. Locate the “PagerDuty RBA Credential” credential and then check on the wrench to edit it. In the “Username” field, enter the PagerDuty “Service API Key” you copied from the previous chapter. Click the Save button to update the credential, or use the Save As button to create a new credential.
Configure Dynamic Application Credential
The Dynamic Application credential is needed if you wish to synchronize incident changes from PagerDuty to ScienceLogic. Navigate to the System tab and select Manage\Credentials. Locate the “PagerDuty DA Credential” credential and then check on the wrench to edit it.
In the “Username” field, enter the PagerDuty “API Access Key” you copied from the previous section. In the Hostname field, add the URL of our PagerDuty account, for instance: https://mycompany.pagerduty.com. This should be the same account that you use to access your PagerDuty administration interface. Click the Save button to update the credential, or use the Save As button to create a new credential.
Configure Run Book Automation Policies
Importing the PagerDuty Power-Pack
In this section we will configure the PagerDuty Run Book Automation Policy, aligning the credential, and begin sending events to PagerDuty. The Run Book Automation policies provided by ScienceLogic will create outbound incidents in PagerDuty.
Run Book Actions
Navigate to the Run Book Actions page by clicking on Registry tab, then Run Book, and then Actions. You will notice three PagerDuty actions.
- PagerDuty Trigger Incident
- PagerDuty Acknowledge Incident
- PagerDuty Resolve Incident
Each of these actions performs a different function and allows you to align different Automation policies based on your business needs. To configure these actions, we muct manually edit each and align the proper PagerDuty credential that contains the PagerDuty API key.
Edit each Action by clicking on the yellow wrench, then select the PagerDuty Credential, then select Save.
Note: PagerDuty Actions must run on the ScienceLogic Database, double check that the Action Run Context is set to Database
Once complete, let’s double-check the PagerDuty Automation Policies.
Like the PagerDuty Run Book Actions, there are three Automation Policies. Each Automation Policy performs a different task based on criteria established in the Policy. By default the PagerDuty Automation Policies are very broad, allowing every ScienceLogic event that has a severity higher than or equal to “minor” to trigger a PagerDuty incident. Although this may be good to begin testing your PagerDuty integration, it is advised to adjust each PagerDuty Automation policy to meet the needs of your business.
Navigate to the Run Book Automation page by clicking on Registry tab, then Run Book, and then Automation. You will notice three PagerDuty actions.
Click the yellow wrench for each policy to edit it. Note that the default policies work against all devices, in all organizations. Make sure the matching RBA Action is aligned. When done making changes, click the Save button. With all Automation Policies validated, we can now proceed to the next section.
In this section we will create a PagerDuty device, and manually align the PagerDuty Synchronization and Performance Dynamic Application. The Synchronization and Performance Dynamic Application provided by ScienceLogic will provide near-real time performance data regarding your PagerDuty service, as well as synchronize changes emanating from PagerDuty.
Create PagerDuty Device
Although the PagerDuty Dynamic Application may be aligned to any ScienceLogic device, in this section we will walkthrough creating a dedicated PagerDuty device. Navigate to the Discovery Console Panel by clicking on System > Manage > Discovery. Create a new discovery session to discover a pingable device, setting the IP address to the desired location. Next select “Discover Non-SNMP” devices, and when complete select Save.
Run the discover session by clicking on the lightning bolt icon. In the Discover Session modal, the device will be modeled as a standard Linux device.
Click the device icon to edit the device properties. On the device properties page, click the red toolbox icon to change the device class. Select “PagerDuty | Incident Management (Pingable)” device class, then select Apply.
When complete the device icon and device class information will be aligned to PagerDuty.
Align Dynamic Application
To align the Pager Duty Synchronization and Performance Dynamic Application, click on the Collection tab while in the Device Properties panel.
Next, select Action, then Add Dynamic Application. Type “Pager” in the search box, then Select the “PagerDuty” Synchronization & Performance” application. Select the “PagerDuty DA Credential” with the “API Access Key” you created in Chapter 3. Select the Save button to save changes.
Once aligned, the application will take about 60 seconds to populate. By default the application runs every 60 seconds looking for updates to existing ScienceLogic events and updating performance and status data.
The application performance metrics will begin collecting every 60 seconds.
Using PagerDuty Integration
Run Book (Forward Synchronization)
Every ScienceLogic event that matches the PagerDuty Run Book Automation policy will create a new PagerDuty incident. Once an incident is created, notification and escalation policies on the Pager Duty system will go into effect.
ScienceLogic’s Run Book Automation integration is a forward synchronization process, meaning that events and activities emanate from the ScienceLogic system to the PagerDuty service system. Just as new ScienceLogic events will create new PagerDuty incidents, acknowledging or clearing events from within ScienceLogic’s event monitor will perform the same function via the PagerDuty API.
Acknowledging incidents from the PagerDuty service portal will only update events in ScienceLogic if the PagerDuty Synchronization and Performance Dynamic Application is configured. If events are auto cleared by ScienceLogic, because either the event has timed-out or the system no-longer detects there’s still a problem, events will also be automatically resolved in PagerDuty. The below example shows a ScienceLogic Event Console with several different active events:
The same events are synchronized in PagerDuty as triggered incidents:
Note: For this example all events are creating incidents in PagerDuty, which is a function of the ScienceLogic Run Book Automation policy and can be adjusted to meet the needs of your business.
Since PagerDuty requires a unique incident ID to de-duplicate events, ScienceLogic uses the device ID, called the DID, to help eliminate duplicate event storms for a single device. If a device has multiple events, the parent event (usually the highest severity event) will be used for the PagerDuty incident. If subsequent events appear after the initial event correlation process by ScienceLogic (usually time based), the new event will update the PagerDuty incident with the new description. In PagerDuty we can see the primary “critical” event for device “puppet-serv”:
In ScienceLogic we can see this event for device “puppet-serv”:
When events are acknowledged in ScienceLogic, the acknowledged status will be synchronized to PagerDuty. This process can take up to 60 seconds.
Once synchronized the status of the PagerDuty incident is updated. Resolving an event in the ScienceLogic event monitor also updates the status of the Incident in PagerDuty.
Note the below event which once resolved is also cleared in PagerDuty.
In PagerDuty, the incident is removed, but can be found by clicking the “Resolved” link.
Acknowledging in PagerDuty (Reverse Synchronization)
Incidents that are acknowledged in the PagerDuty portal or Smart Phone applications will synchronize back to ScienceLogic if the PagerDuty Dynamic Application has been installed.
By default, synchronization can take up to 60 seconds, however users can change the frequency be editing the Dynamic Application properties. In order to maintain continuity of user assignment, ScienceLogic matches the PagerDuty assigned username to the ScienceLogic username. If there is a match ScienceLogic events will be updated to matching PagerDuty incidents. If no username can be found, no updates will be made.
For instance, if the username in ScienceLogic is “jdoe”, the same username must exist in PagerDuty for the reverse synchronization process to update events in ScienceLogic. The primary reason for this is because of ScienceLogic uses advanced auditing and change control process that must know which user account is acknowledging events.
In PagerDuty, any ScienceLogic created incident will have additional notes and details about the event. The details include information about the device, including the last occurrence, severity, and IP address. Users can also navigate from PagerDuty to ScienceLogic by clicking the Client URL link.
Performance Metrics and Dashboard
If the “PagerDuty Synchronization & Performance” Dynamic Application is installed, users can see several different performance metrics, including:
- Number of Resolved Incidents
- Number of Acknowledged Incidents
- Number of Triggered Incidents
- Transaction Time of PagerDuty API Requests
- Number of Active Incidents (Acknowledged + Triggered)
- Percentage of Acknowledged Incidents
In addition to the above performance metrics, the “Percentage of Acknowledged” metric also has an alarm threshold that can be adjusted to meet the needs of your environment. The threshold value can be set on the Device Properties > Thresholds tab.
In addition to performance metrics and alerts, the ScienceLogic PagerDuty solution provides an interactive performance dashboard. In case you have multiple PagerDuty accounts, the dashboard will support multi-tenancy allowing a consolidated view of all PagerDuty performance metrics.
Advanced Configuration and Troubleshooting
Distributed Architecture Implementation
For distributed ScienceLogic implementations, special setting must be made in order for the PagerDuty Synchronization & Performance Dynamic Application to work. Edit the Dynamic Application from the System > Applications page. Click the yellow wrench next to the “PagerDuty: Synchronization & Performance” application. After the browser window opens, click on the “Snippet” tab. Click on the yellow wrench next to the Snippet in the Snippet Registry.
The following variables must be changed to reflect your environment.
- MASTER_DATABASE_USER=”<your username>”
- MASTER_DATABASE_PASSWD=”<your password>”
Change the MASTER_DATABASE_HOST to the IP address of the ScienceLogic central database server. If the username or password is different than the default, change those as well.
The collector must be able to communicate with the central database server. As a result, port 7706 must be open. This can be validated by testing the MySQL connection from the collector’s command line.
mysql --host=192.168.2.87 --port=7706 –u root -p
If you get “ERROR 1130: Host is not allowed to connect to this MySQL server”, you will need to allow a specific client IP address (for example: 192.168.1.4) to access the MySQL database.
Logon the Central Database CLI or use the DB Tool in the UI.
mysql> use mysql; mysql> GRANT ALL ON *.* to root@'192.168.1.4' IDENTIFIED BY 'your-root-password'; mysql> FLUSH PRIVILEGES;
Lastly, update firewall rules to make sure TCP port 7706 is open on the Central Database. In our testing of ScienceLogic 7.3.0, the port 7706 was found to be open.
When an event is acknowledged or resolved in ScienceLogic (event monitor or auto-clear), it runs the matching RBA policy and tells the PagerDuty API to acknowledge/resolve the matching incident. The PagerDuty API does not support any fields to indicate who acknowledged the incident; as a result API acknowledged incidents show up as “Through the API”.
Although this is normal behavior, ScienceLogic also provides audit logging of who on the ScienceLogic system acknowledges or resolves an incident. This is available by navigating to the Incident Log of any incident.
Need some help?
Please contact us if you require further assistance in getting setup.