HP SiteScope Integration Guide

HP SiteScope is an agentless application monitoring software from HP which collects server and application health checks across your infrastructure. It supports over 100 different applications out of the box and integrates very nicely with HP Operations Manager. PagerDuty extends HP SiteScope’s functionality by providing on-call scheduling, alerts and incidents tracking through the PagerDuty/SiteScope email integration. PagerDuty notifies you of the most critical SiteScope events so that you are able to take immediate action.

This guide describes how to integrate your HP SiteScope installation with PagerDuty using email integration. This guide will provide instructions on setting up alerts and alert actions in SiteScope. If you are having trouble completing the installation, please contact us.

In PagerDuty

1. From the Services menu, select Service Directory.
2. On your Service Directory page:If you are creating a new service for your integration, click +New Service. If you are adding your integration to an existing service, click the name of the service you want to add the integration to. Then click the Integrations tab and click the Add a new integration to this service link.
3. Select your app from the Integration Type menu and enter an Integration Name.If you are creating a new service for your integration, in General Settings, enter a Name for your new service. Then, in Incident Settings, specify the Escalation Policy, Notification Urgency, and Incident Behavior for your new service.
4. Click the Add Service or Add Integration button to save your new integration. You will be redirected to the Integrations page for your service.
5. Copy the Integration Email for your new integration:

In HP SiteScope

1. SSH into your SiteScope server.
2. Browse to your SiteScope install directory, then to the templates.mail subdirectory (i.e. /opt/HP/SiteScope/templates.mail).
3. Run the following command to download the PagerDuty email template:

   PagerDutyIncidentKey: <siteScopeHost>/<groupID>/<name>/<alert::name>
   
   Time: <time>
   Alert: <alert::name>
   Monitor: <name>
   Group: <FullGroupId>
   Status: <state>
   
   Metrics in error:
   <errorOnly>
   
   Metrics in warning:
   <warningOnly>
   
   SiteScope URL: <newSiteScopeURL>
   
   

4. In the SiteScope user interface, right click on the context-tree, and select New > Alert.
5. Enter PagerDuty for the Name.
6. Enter PagerDuty Alerts for the Alert description.
7. Select the Alert target that you would like to be covered by this alert. We selected SiteScope, which will include all child nodes.
8. Click on New Alert Action within the Alert Actions section.
9. Select Email as the Action Type.
10. Enter Error Action for the Action name.
11. Enter your PagerDuty integration email address into the Addresses field.
12. Select PagerDuty as the Template.
13. Select Error as the Status Trigger.
14. Click on OK.
15. Click on the New Alert Action again (Same as in step 8).
16. Select Email as the Action Type.
17. Enter Warning Action as the Action name.
18. Enter your PagerDuty integration email address into the Addresses field.
19. Select PagerDuty as the Template.
20. Select Warning as the Status Trigger.
21. Click on OK.
22. Click on the New Alert Action again (Same as in step 8).
23. Select Email as the Action Type.
24. Enter Resolve Action as the Action name.
25. Enter your PagerDuty integration email address into the Addresses field.
26. Select PagerDuty as the Template.
27. Check the box for Mark this action to close alert.
28. Select Good as the Status Trigger.
29. Click on OK.
30. Click on OK.
31. Congratulations, you have now integrated HP SiteScope with PagerDuty!

FAQ

What if a HP SiteScope event happens while my network is down?

You should also configure an external ping check service to monitor your mail server and site’s external connectivity. Of course, you can use PagerDuty to forward alerts from these services as well.

How are incidents de-duplicated?

Incidents are de-duplicated based on the PagerDutyIncidentKey variable which is defined in the PagerDuty template. By default, it is composed of:

<siteScopeHost>/<groupID>/<name>/<alert::name>

Please refer to the SiteScope manual for “How to Customize an Alert’s Message Content” if you would like to use different variables for your incident de-duplication.

How do you modify the incident description in PagerDuty?

The incident description is created based on the subject of the alert. You can go to the directory of your SiteScope installation and then to the templates.mail.subject folder (i.e. /opt/HP/SiteScope/templates.mail.subject). You can either create a new subject file or modify the Typical file. Please refer to the SiteScope manual for “How to Customize an Alert’s Message Content” for additional variables that you can use.

How do I setup HP SiteScope to work with multiple PagerDuty services?

First, create multiple HP SiteScope services within PagerDuty. Second, within HP SiteScope create multiple alerts (Step 4). Third, select different alert targets that you would like to be monitored by each service (Step 7). Lastly, within each Action use the email address that is associated with each of your PagerDuty services (Step 11).

Can the subject line be customized?

In order to customize the subject line, please refer to the SiteScope manual for “How to Customize an Alert’s Message Content.”

What aren’t my emails being sent to PagerDuty?

It’s possible that your email settings are incorrect. To verify these settings have been properly set, please follow the steps below.

1. Navigate to your SiteScope folder.
2. Click on General Preferences.
3. Click on Email Preferences.
4. Click on Advanced Settings.
5. Set an Error Action for your PagerDuty email.
6. Set a Warning Action for your PagerDuty email.
7. Set a Resolve Action for your PagerDuty email.

This should protect you from email misconfiguration as a cause of unsent alerts.