Configuring Applications for the PagerDuty SyncPack

Download this manual as a PDF file 

This section describes how to set up the PowerFlow applications for the PagerDutySyncPack.

Creating and Aligning a Configuration Object in PowerFlow

A configuration object supplies the login credentials and other required information needed to execute the steps for a PowerFlow application. The Configurations page () of the PowerFlow user interface lists all available configuration objects for that system.

You can create as many configuration objects as you need. A PowerFlow application can only use one configuration object at a time, but you can use (or "align") the same configuration object with multiple applications.

To use this SyncPack, you will need to use an existing configuration object in the PowerFlow user interface or create a new configuration object. Next, you can integrate one PagerDuty instance with multiple SL1 instances by creating a separate configuration for each SL1 instance.

Creating a Configuration Object

For this SyncPack, you can make a copy of the "PagerDuty Base Config" configuration object, which is the sample configuration file that was installed with the PagerDuty SyncPack.

The "PagerDuty Base Config" configuration object contains all of the required variables. Simply update the variables from that object to match your SL1 and PagerDuty settings.

To create a configuration object based on the "PagerDuty Base Config" configuration object:

  1. In the PowerFlow user interface, go to the Configurations page ().
  2. Click the Actions button () for the "PagerDuty Base Config" configuration object and select Edit. The Configuration pane appears:

An image of the configuration object page.

  1. Click Copy as. The Create Configuration pane appears.

  2. Complete the following fields:

    • Friendly Name. Name of the configuration object that will display on the Configurations page.
    • Description. A brief description of the configuration object.
    • Author. User or organization that created the configuration object.
    • Version. Version of the configuration object.

  1. In the Configuration Data field, update the default variable definitions to match your PowerFlow configuration:

    • event_api. The URL of the PagerDuty event API for all PagerDuty instances. The default value is "https://events.pagerduty.com/v2/enqueue". You do not need to update this field.
    • integration_key. The routing/integration key to use when sending events.

      • For information on creating a PagerDuty service and accessing the integration key, see https://support.pagerduty.com/docs/services-and-integrations#create-a-new-service.

    • pd_base_url. The base URL of the PagerDuty REST API for all PagerDuty instances. The default value is "https://api.pagerduty.com". You do not need to update this field.
    • rest_api_key. The api key to use when syncing information to SL1 from PagerDuty.

      • For more information on generating a PagerDuty REST API key, see https://support.pagerduty.com/docs/generating-api-keys#generating-a-general-access-rest-api-key.

    • sl1_host. The hostname or IP address of the SL1 system the incident states will synchronize to.
    • sl1_user. The username for your SL1 system.
    • sl1_password. The password for your SL1 system.
    • proxy_host. The hostname or IP address of the HTTP proxy that will be used when making an API request to PagerDuty.
    • proxy_user. The username for your associated HTTP proxy.
    • proxy_password.The password for your associated HTTP proxy.
    • platform_identifier. The parameter that is appended to the event ID to create the PagerDuty dedup key. When you configure your SL1 system to send event data to PagerDuty via PowerFlow, the "platform_identifier" parameter in the Run Book Action must match this value.
    • summary_string. The string that reflects how the summery field is constructed before it is sent to PagerDuty. You can use Run Book Variables to dynamically include SL1 event data in the summary field. For example, the default value, "%S: %X: %M", includes the severity, affected device, and event message in the summary string.

      • For more information on Run Book Variables, see Run Book Variables.

    • custom_details. A structure of "key:value" pairs that can be used to provide additional SL1 event data to PagerDuty. You can use Run Book Variables to dynamically include SL1 event data in this field.

      • For more information on Run Book Variables, see Run Book Variables.

    • resolve_events. A value to indicate whether events should be resolved in SL1 when the incident is resolved in PagerDuty. The default value is "False". If the value is "False", SL1 events will not be automatically cleared in SL1 when the corresponding PagerDuty incident is resolved.
    • link_events. A value to indicate whether events should be updated with the incident URL from PagerDuty. The default value is "True". If the value is "True", the External Ticket ID field will be updated with the ID and URL of the PagerDuty incident.

      • SL1 supports only one value in this field. To avoid conflicts with other integrations, set this value to 'False' if your SL1 system has been integrated with another incident management system, e.g. ServiceNow.

  1. Click Save. You can now align this configuration object with one or more applications.

Aligning a Configuration Object and Configuring PowerFlow Applications

With this SyncPack, any status changes made to an SL1 Event is sent to PagerDuty to update the corresponding incident. Any status changes to the PagerDuty incident are synced back to the corresponding SL1 event. You will need to align the PagerDuty applications with the relevant configuration object in PowerFlow, and, if needed, update any other fields on the Configuration pane for the applications.

To run this SyncPack, you must "align" the configuration object to run with the following PowerFlow applications:

  • "Clear resolve event from ScienceLogic"
  • "Get PagerDuty log and incident data"
  • "Get resolve alert data from PagerDuty"
  • "Get trigger alert data from PagerDuty"
  • "Get alert and user data from PagerDuty and ScienceLogic"
  • "Post event updates to ScienceLogic"
  • "Create event in PagerDuty from SL1 event"

To align the configuration object with the relevant PowerFlow applications:

  1. On the Applications page of the PowerFlow user interface, open one of the PowerFlow applications listed above and click Configure (). The Configurations pane for that application appears:

    An image of the Configure page.

  1. From the Configurations drop-down, select the configuration object you want to use.

    The values for proxy_host and the other parameters that appear in the Configuration pane with a padlock icon () are populated either by the configuration object you aligned with the application or by the Run Book Action. Do not modify these values. If you encounter an error, make sure your Run Book Action is configured properly.

  1. Click Save to align that configuration with the application.
  2. Wait until you see the "App & Confg modifications saved" pop-up message before proceeding.
  3. Repeat this process for the other PowerFlow applications.

Scheduling PowerFlow Applications

Using the PagerDuty Incident IntegrationPowerPack, you can optionally configure a single PowerFlow instance and single PagerDuty instance with multiple SL1 instances using the automation actions included in the PowerPack. To run the automation, you must create a configuration for each SL1 instance and schedule the "Get PagerDuty log and incident data" application.

For more information on the automation action included in the PagerDuty Incident IntegrationPowerPack, see Editing the PagerDuty Automation Action.

You can create one or more schedules for a single application in the PowerFlow user interface. When creating each schedule, you can specify the queue and the configuration file for that application.

To schedule an application:

  1. On the Applications page (), click the Schedule button for the application you want to schedule. The Schedule window appears, displaying any existing schedules for that application:

    If you set up a schedule using a cron expression, the details of that schedule display in a more readable format in this list. For example, if you set up a cron expression of */4 * * * *, the schedule on this window includes the cron expression along with an explanation of that expression: "Every 0, 4, 8, 12, 16, 20, 24, 28, 32, 36, 40, 44, 48, 52, and 56th minute past every hour".

  1. Select a schedule from the list to view the details for that schedule.

  2. Click the + icon to create a schedule. A blank Schedule window appears:

  1. In the Schedule window, complete the following fields:
  • Schedule Name. Type a name for the schedule.
  • Switch to. Use this toggle to switch between a cron expression and setting the frequency in seconds.
  • Cron expression. Select this option to schedule the application using a cron expression. If you select this option, you can create complicated schedules based on minutes, hours, the day of the month, the month, and the day of the week. As you update the cron expression, the Schedule window displays the results of the expression in more readable language, such as Expression: "Every 0 and 30th minute past every hour on the 1 and 31st of every month", based on */30 * * /30 * *.
  • Frequency in seconds. Type the number of seconds per interval that you want to run the application.
  • Custom Parameters. Type any JSON parameters you want to use for this schedule, such as information about a configuration file or mappings.

  1. Click Save Schedule. The schedule is added to the list of schedules on the initial Schedule window. Also, on the Applications page, the word "Scheduled" appears in the Scheduled column for this application, and the Schedule button contains a check mark:

After you create a schedule, it continues to run until you delete it. Also, you cannot edit an existing schedule, but you can delete it and create a similar schedule if needed.

To view or delete an existing schedule:

  1. On the Applications page, click the Schedule button for the application that contains a schedule you want to delete. The Schedule window appears.

  1. Click the down arrow icon () to view the details of an existing schedule:

  1. To delete the selected schedule, click Delete. The schedule is removed.

When either multiple SL1 instance or multiple PagerDuty instances are involved with PowerFlow, you should create an individual configuration object for each SL1 or PagerDuty instance. Next, create an individual schedule for each configuration object. Each schedule should use a configuration object that is specific to that single SL1 or PagerDuty instance. Creating copies of a PowerFlow application from a SyncPack for the purpose of distinguishing between domains is not supported, and will result in issues on upgrades.