Phare

Overview

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

Prerequisites

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

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 Phare will be sent.

2. Debugging and Troubleshooting

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

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

3.1 Configuring Webhook Notification in Phare

• Log in to Phare
• Use your Phare credentials to log in to the platform.
• Navigate to Integrations
• Once logged in, click on Integrations from the main menu.
• Configure an Outgoing Webhook
• Select Outgoing Webhooks from the available options.
• Click on New Installation.
• Enter a name in the Integration Name field for easy identification.
• In the Callback URL field, paste the API endpoint URL provided by Callgoose SQIBS.
• Note: The final API endpoint may vary based on authentication and other URL parameters. Refer to the Callgoose SQIBS API documentation to find your specific endpoint: API Endpoints.
• Save the Webhook
• Click Save to complete the webhook setup.

3.2 Configuring an Alert Policy in Phare

• Create an Alert Policy
• Go to the Dashboard in Phare.
• Navigate to the Uptime section and click on Alert Policies.
• Click on Create Alert Policy.
• Provide a name and select the appropriate project.
• Click Create.
• Select the newly created alert policy and click on Create Rule.
• Configure the rule as follows:
• Select the event and rate limit interval.
• Select the outgoing webhook as the Alert Integration.
• You will see a custom webhook schema like this:

{
  "id": "$MONITOR_ID",
  "name": "$MONITOR_NAME",
  "status": "$MONITOR_STATUS",
  "protocol": "$MONITOR_PROTOCOL",
  "request": "$MONITOR_REQUEST",
  "regions": "$MONITOR_REGIONS",
  "interval": "$MONITOR_INTERVAL",
  "incident_confirmations": "$MONITOR_INCIDENT_CONFIRMATIONS",
  "recovery_confirmations": "$MONITOR_RECOVERY_CONFIRMATIONS",
  "project": {
    "id": "$PROJECT_ID",
    "name": "$PROJECT_NAME",
    "slug": "$PROJECT_SLUG"
  }
}

• Edit the schema as needed.
• Use the documentation link on the same page for further guidance.
• Click Create to finalize the alert policy.

3.3 Configuring Monitor in Phare

• Create an Uptime Monitor
• Go to the Dashboard in Phare.
• Navigate to the Uptime section and click on Create Monitor.
• Configure the Monitor
• Fill out the configuration details for the monitor according to your requirements.
• In the Alert Policy section, select the alert policy you created earlier.
• Finalize the Setup
• Click Create to save the Uptime Monitor.

3.4 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 Phare alerts, you need to create API filters based on the JSON payloads received.

4.1.1 Example JSON Payloads from Phare

Alert Triggered (status: "ongoing")

json

{
  "id": "113247",
  "slug": "LUMIN-1",
  "title": "Service is not working as expected",
  "error": "$INCIDENT_ERROR",
  "state": "unknown",
  "status": "ongoing",
  "impact": "majorOutage",
  "project": {
    "id": "34454",
    "name": "Luminious guiding tower",
    "slug": "luminious-guiding-tower"
  },
  "monitor": {
    "id": "18801",
    "name": "HTTPBIN"
  }
}

Alert Resolved (status: "recovered")

json

{
  "id": "113247",
  "slug": "LUMIN-1",
  "title": "Service is not working as expected",
  "error": "$INCIDENT_ERROR",
  "state": "unknown",
  "status": "recovered",
  "impact": "majorOutage",
  "project": {
    "id": "34454",
    "name": "Luminious guiding tower",
    "slug": "luminious-guiding-tower"
  },
  "monitor": {
    "id": "18801",
    "name": "HTTPBIN"
  }
}

4.2 Configuring API Filters

4.2.1 Integration Templates

If you see a Phare 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: "status"
• Key Value Contains: [ongoing]
• Map Incident With: "id"
• This corresponds to the unique id from the Phare payload.
• Incident Title From: "impact"
• 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 "title" key in the Incident Description From field, the incident description will be the value of the "title" key. In the example JSON payload provided earlier, this would result in a description like "Service is not working as expected".
• Resolve Filter (For Resolving Incidents):
• Payload JSON Key: "status"
• Key Value Contains: [recovered]
• Incident Mapped With: "id"
• This ensures the incident tied to the specific id 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 Phare.

5. Testing and Validation

5.1 Triggering Alerts

• Simulate a Monitoring Alert:
• Trigger a condition in Phare that causes an alert (e.g., Manually take a website offline).
• 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 Phare (e.g., when the website returns to a normal level), 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.
• Phare Permissions: Confirm that the webhook in Phare 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 Phare 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 Phare matches the expected structure.

8. Conclusion

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

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