NodePing

Overview

This document provides a detailed guide to integrating NodePing 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 NodePing. The guide includes steps for setting up alerts in NodePing, configuring webhook notifications, creating API filters in Callgoose SQIBS, and troubleshooting.

Prerequisites

• NodePing Account: Access to NodePing 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 NodePing.

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.

• Generate an API Token:
• Follow the guide on How to Create API Token in Callgoose SQIBS.
• Find the API Endpoint:
• Refer to the Callgoose SQIBS API Endpoint Documentation to get the endpoint details where the JSON payloads from NodePing will be sent.

2. Debugging and Troubleshooting

You can enable debugging in the API tokens used with NodePing 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 NodePing to Send JSON Payloads

Follow these steps to set up monitoring, alerts, and webhook integrations in NodePing, ensuring that the JSON payloads generated match the required format for Callgoose SQIBS.

3.1 Setting Up Webhook in NodePing

• Login to NodePing
• Go to the NodePing website and log in using your credentials.
• Add Contact in NodePing
• Once logged in, click on the Contacts section from the navigation panel.
• Click on the Add Contact button.
• Create a New Contact
• Provide a name for the contact (e.g., Callgoose Webhook Contact).
• Click on Save.
• Configure Webhook Method
• After saving the contact, click on Add Method.
• From the Type field, choose Webhook.
• Set Webhook Details
• Choose Custom Template for the webhook type.
• Select POST as the method.
• Add Endpoint URL
• In the URL field, paste the endpoint URL provided by Callgoose (refer to Callgoose API Endpoint documentation to get the final URL format.
• Advanced Settings
• Click on Show Advanced to expand additional options.
• Configure Headers
• Under the Header section, click on Add.
• Add a key-value pair for headers:
• Key: Content-Type
• Value: application/json
• Configure Request Body
• Navigate to Body/Request Payload and paste the following JSON template:

{
  "label": "{label}",
  "event": "{event}",
  "checkid": "{_id}",
  "checkType": "{t}",
  "checkTarget": "{tg}",
  "startTime": "{s}",
  "endTime": "{e}",
  "message": "{m}"
}

• Click on Save to complete the webhook configuration.
• You can customise this payload format as you like. Refer NodePing Webhook Documentation for more variables.

3.2 Setting Up Checks in NodePing

• Create a New Check
• Now, navigate to the Checks section.
• Click on Add Check to create a new web check.
• Fill in the necessary details according to the type of web check you want to configure.
• Configure Notification Settings
• In the Notification Settings section, select the webhook we created earlier as the Notification Contact.
• Save the Check
• After filling out all the required fields, click on Save to activate the check.

3.3 Finalizing and Testing

• 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.

4. Configuring Callgoose SQIBS

4.1 Create API Filters in Callgoose SQIBS

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

4.1.1 Example JSON Payloads from NodePing

Alert Triggered (event: "down")

json

{
  "label": "Testing",
  "event": "down",
  "checkid": "20241021061735YX9LX-YYBJKWS3",
  "checkType": "HTTP",
  "checkTarget": "https://httpbin.org/status/406",
  "startTime": "1729508683689",
  "endTime": "1729508683998",
  "message": "HTTP status returned: 406"
}

Alert Resolved (event: "up")

json

{
  "label": "Testing",
  "event": "up",
  "checkid": "20241021061735YX9LX-YYBJKWS3",
  "checkType": "HTTP",
  "checkTarget": "https://httpbin.org/status/200",
  "startTime": "1729508917945",
  "endTime": "1729508918153",
  "message": "Success"
}

4.2 Configuring API Filters

4.2.1 Integration Templates

If you see an NodePing 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

• Trigger Filter (For Creating Incidents):
• Payload JSON Key: "event"
• Key Value Contains: [down]
• Map Incident With: "checkid"
• This corresponds to the unique checkid from the NodePing payload.
• Incident Title From: "message"
• 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.
• Resolve Filter (For Resolving Incidents):
• Payload JSON Key: "event"
• Key Value Contains: [up]
• Incident Mapped With: "checkid"
• This ensures the incident tied to the specific checkid is resolved when the alert status returns to normal.

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

4.3 Finalizing Setup

• Save the API Filters:
• Ensure that the filters are correctly configured and saved in Callgoose SQIBS.
• Double-check that all key mappings, incident titles, and descriptions are correctly aligned with the payload structure sent by Nodeping.

5. Testing and Validation

5.1 Triggering Alerts

• Simulate a Monitoring Alert:
• Trigger a condition in NodePing that causes an alert (e.g., using a maintenance page, disconnecting the server, or blocking access via firewall).
• Verify that an incident is created in Callgoose SQIBS with the correct information.

5.2 Resolving Alerts

• Acknowledge and Resolve the Alert:
• Once the issue is resolved in NodePing (e.g., Manually bring the website back online by restarting the web server or removing any block that caused the downtime), 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 correctly configured and that the API token is securely stored and used.
• NodePing Permissions: Confirm that the webhook in NodePing has appropriate permissions to send alerts and data to Callgoose SQIBS.

7. Troubleshooting

• No Incident Created: If no incident is created, verify that the webhook URL in NodePing is correct and that the JSON payload structure matches the API filters configured in Callgoose SQIBS.
• Incident Not Resolved: Ensure that the resolve filter in Callgoose SQIBS is correctly configured and that the JSON payload sent by NodePing matches the expected structure.

8. Conclusion

This guide provides a comprehensive overview of how to integrate NodePing with Callgoose SQIBS for effective incident management. By following the steps outlined, you can ensure that alerts from NodePing 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 NodePing and Callgoose SQIBS:

• NodePing 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 NodePing.