Paessler PRTG

Overview

This document provides a detailed guide to integrating Paessler PRTG with Callgoose SQIBS for real-time Incident Management, Incident Auto Remediation, Event-Driven Automation, and other Automation purposes. The integration enables automatic creation, updating, and resolution of incidents in Callgoose SQIBS based on alerts triggered in Paessler PRTG. The guide includes steps for setting up alerts in PRTG, configuring webhook notifications, creating API filters in Callgoose SQIBS, and troubleshooting.

Prerequisites

• Paessler PRTG Account: Access to PRTG for creating alerts and managing notifications.
• Callgoose SQIBS Account: With valid privileges to set up API filters and receive notifications.
• Webhook/API Endpoint: Available in Callgoose SQIBS to receive alerts from PRTG.

1.Obtain API Token and Endpoint Details

To integrate with Callgoose SQIBS, you first need to obtain an API token and find the API endpoint details.

i.Generate an API Token:

• Follow the guide on How to Create API Token in Callgoose SQIBS.

ii.Find the API Endpoint:

• Refer to the Callgoose SQIBS API Endpoint Documentation to get the endpoint details where the JSON payloads from PRTG will be sent.

2.Debugging and Troubleshooting

You can enable debugging in the API tokens used with PRTG notifications for troubleshooting purposes.

• Enable Debugging:
• You can update the debug value when adding or updating an API token.
• When API tracking is enabled, logs are stored in the API log section for your review. The debugging option will automatically disable after 48 hours.
• When API tracking is turned off, no logs are saved in the API log.
• Using API Log for Troubleshooting:
• The API log provides detailed information on all API calls made to Callgoose SQIBS.
• You can check the JSON values in each API log entry for troubleshooting purposes.
• Use the information in the API log to create or refine API filters to ensure incidents are created correctly based on the API payloads received.
• Callgoose SQIBS creates incidents according to your API filter configuration, giving you full control over how alerts from different services trigger incidents and alerts for your support team or automation processes.

3.Configuring Paessler PRTG to Send JSON Payloads

To configure Paessler PRTG to generate the JSON payloads similar to the examples provided, follow the steps outlined below. These steps will guide you through setting up the necessary alerts and webhook notifications within PRTG to ensure that the JSON payloads match those expected by Callgoose SQIBS.

3.1 Setting Up Alerts in PRTG

To generate the required JSON payloads, you first need to set up alerts within PRTG.

i.Log in to the PRTG Web Interface:

• Access the PRTG platform using your account credentials.

ii.Navigate to the Notification Templates Section:

• In the PRTG console, go to Setup > Account Settings > Notification Templates.

iii.Create a New Notification Template:

• Click on Add Notification Template.
• Specify Alert Conditions: Define the conditions that will trigger the notification, such as specific sensor states or thresholds (e.g., CPU Load > 80%).

iv.Configure the Notification Method:

• Choose Execute HTTP Action as the notification method to send data to a webhook.
• URL: Enter the webhook URL provided by Callgoose SQIBS.

3.2 Configuring the Webhook Notification

To ensure that the JSON payload sent matches the examples provided, follow these steps when configuring the webhook:

i.Add Webhook URL:

• In the URL field, enter the endpoint provided by Callgoose SQIBS.
• Ensure the protocol is HTTPS for secure data transmission.

ii.Customize Payload Format:

• Ensure that the payload includes key fields like "sensor", "status", "message", "priority", "datetime", "eventid", and others as shown in the example payloads.
• Example Payload Setup:

json
{
  "sensor": "%sensor",
  "status": "%status",
  "message": "%message",
  "priority": "%priority",
  "datetime": "%datetime",
  "eventid": "%eventid"
}

• Placeholder Explanation:
• "%sensor": Replaces with the name of the sensor.
• "%status": Replaces with the current status of the sensor.
• "%message": Replaces with the message from the sensor.
• "%priority": Replaces with the priority level of the alert.
• "%datetime": Replaces with the date and time of the event.
• "%eventid": Replaces with a unique ID for the event.

iii.Test the Webhook Configuration:

• Before activating the webhook, perform a test to ensure that the JSON payload is correctly formatted and is being sent to the Callgoose SQIBS API endpoint as expected.
• Review the payload in Callgoose SQIBS to confirm that it matches the expected structure.

3.3 Finalizing and Testing

i.Save and Activate the Notification Template:

• Once the notification template and webhook are correctly configured, save the notification configuration and activate it.

ii.Validate the Integration:

• Trigger the alert condition manually if possible to verify that the correct JSON payload is sent to Callgoose SQIBS.
• Resolve the alert to ensure the resolved state payload is also correctly sent and processed.

3.4 Additional Considerations

• Permissions: Ensure that the webhook has the necessary permissions to send alerts to the Callgoose SQIBS API endpoint.
• Security: Implement security measures such as HTTPS and API tokens to protect the data being transmitted between PRTG and Callgoose SQIBS.
• Logging and Debugging: Use the debugging and logging features in Callgoose SQIBS to monitor incoming payloads and troubleshoot any issues with the integration.

4. Configuring Callgoose SQIBS

4.1 Create API Filters in Callgoose SQIBS

To correctly map incidents from the PRTG alerts, you need to create API filters based on the JSON payloads received.

4.1.1 Example JSON Payloads from PRTG

Alert Triggered (status: "DOWN")

json
{
  "sensor": "CPU Load",
  "status": "DOWN",
  "message": "CPU Load exceeds 80%",
  "priority": "1",
  "datetime": "2024-08-05T12:00:00.000Z",
  "eventid": "123456"
}

Alert Resolved (status: "UP")

json
{
  "sensor": "CPU Load",
  "status": "UP",
  "message": "CPU Load is back to normal",
  "priority": "1",
  "datetime": "2024-08-05T12:30:00.000Z",
  "eventid": "123456"
}

4.2 Configuring API Filters

4.2.1 Integration Templates

If you see a PRTG integration template in the "Select Integration Template" dropdown in the API filter settings, you can use it to automatically add the necessary Trigger and Resolve filters along with other values. The values added by the template can be modified to customize the integration according to your requirements.

4.2.2 Manually Add/Edit the Filter

There are two filters that you can manually edit: Trigger and Resolve.

• Trigger Filter (For Creating Incidents):
• Payload JSON Key: "status"
• Key Value Contains: [DOWN]
• Map Incident With: "eventid"
• This corresponds to the unique eventid from the PRTG payload.
• Incident Title From: "sensor"
• This will use the name of the sensor as the incident title in Callgoose SQIBS.
• Incident Description From: Leave this empty unless you want to use a specific key-value from the JSON payload. If a key is entered, only the value for that key will be used as the Incident Description instead of the full JSON. By default, the Incident Description will include the full JSON values.
• Example: If you use the "message" key in the Incident Description From field, the incident description will be the value of the "message" key. In the example JSON payload provided earlier, this would result in a description like "CPU Load exceeds 80%".
• Resolve Filter (For Resolving Incidents):
• Payload JSON Key: "status"
• Key Value Contains: [UP]
• Incident Mapped With: "eventid"
• This ensures the incident tied to the specific eventid is resolved when the alert status returns to UP.

Refer to the API Filter Instructions and FAQ for more details.

4.3 Finalizing Setup

i.Save the API Filters:

• Ensure that the filters are correctly configured and saved in Callgoose SQIBS.

ii.Test the Integration:

• Manually trigger a PRTG alert to test if incidents are created in Callgoose SQIBS.
• Resolve the alert in PRTG and verify that the corresponding incident in Callgoose SQIBS is resolved.

5.Testing and Validation

5.1 Triggering Alerts

i.Simulate a Sensor Alert:

• Trigger a sensor alert condition in PRTG to test the integration.
• Verify that an incident is created in Callgoose SQIBS with the correct title and urgency.

5.2 Resolving Alerts

i.Resolve the Sensor Alert:

• Acknowledge or resolve the alert in PRTG to verify that the incident in Callgoose SQIBS is automatically marked as resolved.

6. Security Considerations

• API Security: Ensure that the Callgoose SQIBS API endpoint is correct and that you are using the correct API token.
• PRTG Permissions: Ensure that the webhook configuration in PRTG has appropriate permissions to send alerts to Callgoose SQIBS.

7. Troubleshooting

• No Incident Created: Verify that the webhook in PRTG is correctly configured and that the JSON payload structure matches the API filters configured in Callgoose SQIBS.
• Incident Not Resolved: Ensure the resolve filter is correctly configured and that the payloads from PRTG are being received and processed by Callgoose SQIBS.

8. Conclusion

This guide provides a comprehensive overview of how to integrate Paessler PRTG with Callgoose SQIBS for effective incident management. By following the steps outlined, you can ensure that alerts from PRTG are automatically reflected as incidents in Callgoose SQIBS, with proper resolution tracking when the issues are resolved.

For further customization or advanced use cases, refer to the official documentation for both Paessler PRTG and Callgoose SQIBS:

• Paessler PRTG Documentation
• Callgoose SQIBS API Token Documentation
• Callgoose SQIBS API Endpoint Documentation
• API Filter Instructions and FAQ
• How to Send API

This documentation will guide you through the integration process, ensuring that your incidents are managed effectively within Callgoose SQIBS based on real-time alerts from Paessler PRTG.