Zabbix

Overview

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

Prerequisites

• Zabbix Account: Access to Zabbix for creating triggers and managing actions.
• 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 Zabbix.

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

2. Debugging and Troubleshooting

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

To configure Zabbix 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 triggers and webhook notifications within Zabbix to ensure that the JSON payloads match those expected by Callgoose SQIBS.

3.1 Setting Up Triggers in Zabbix

To generate the required JSON payloads, you first need to set up triggers within Zabbix.

1. Log in to the Zabbix Console:

• Access the Zabbix platform using your account credentials.

2. Navigate to the Configuration Section:

• Go to the Configuration section, then select Hosts to manage the monitored hosts.

3. Create a New Trigger:

• Select a host and go to Triggers.
• Create Trigger: Click on Create trigger to set up a new trigger.
• Define the Trigger Expression: Specify the conditions that will activate the trigger, such as CPU utilization exceeding a threshold.

4. Configure Trigger Severity:

• Assign a severity level to the trigger (e.g., Disaster, High, Warning).

3.2 Configuring Actions in Zabbix

To send notifications to Callgoose SQIBS, you need to set up an action that uses a webhook to deliver JSON payloads.

Navigate to the Actions Section:

• Go to Configuration > Actions.

Create a New Action:

• Click on Create action.
• Specify Action Conditions: Define the conditions under which the action will be triggered, such as specific trigger severities or hosts.

Set Operation Details:

• Under Operations, select Send to a webhook.
• Webhook URL: Enter the webhook URL provided by Callgoose SQIBS.
• Message Format: Customize the message format to send a structured JSON payload.

1. Example Payload Setup:

• Ensure that the payload includes key fields like "triggerName", "triggerStatus", "severity", "host", "timestamp", and others as shown in the example payloads.

json

{
  "triggerName": "{TRIGGER.NAME}",
  "triggerStatus": "{TRIGGER.STATUS}",
  "severity": "{TRIGGER.SEVERITY}",
  "host": "{HOST.NAME}",
  "timestamp": "{EVENT.DATE} {EVENT.TIME}",
  "eventId": "{EVENT.ID}",
  "itemName": "{ITEM.NAME}",
  "itemValue": "{ITEM.VALUE}"
}

3.3 Finalizing and Testing

1. Save and Activate the Action:

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

2. Validate the Integration:

• Trigger the condition manually if possible to verify that the correct JSON payload is sent to Callgoose SQIBS.
• Resolve the trigger 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 Zabbix 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 Zabbix triggers, you need to create API filters based on the JSON payloads received.

4.1.1 Example JSON Payloads from Zabbix

Trigger Activated (triggerStatus: "PROBLEM")

json

{
  "triggerName": "High CPU usage on server1",
  "triggerStatus": "PROBLEM",
  "severity": "Disaster",
  "host": "server1.example.com",
  "timestamp": "2024-08-05T12:00:00.000Z",
  "eventId": "123456",
  "itemName": "CPU utilization",
  "itemValue": "95%"
}

Trigger Resolved (triggerStatus: "OK")

json

{
  "triggerName": "High CPU usage on server1",
  "triggerStatus": "OK",
  "severity": "Information",
  "host": "server1.example.com",
  "timestamp": "2024-08-05T12:30:00.000Z",
  "eventId": "123456",
  "itemName": "CPU utilization",
  "itemValue": "50%"
}

4.2 Configuring API Filters

4.2.1 Integration Templates

If you see a Zabbix 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: "triggerStatus"
• Key Value Contains: [PROBLEM]
• Map Incident With: "eventId"
• This corresponds to the unique eventId from the Zabbix payload.
• Incident Title From: "triggerName"
• This will use the name of the trigger 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 "itemName" key in the Incident Description From field, the incident description will be the value of the "itemName" key. In the example JSON payload provided earlier, this would result in a description like "CPU utilization".
• Resolve Filter (For Resolving Incidents):
• Payload JSON Key: "triggerStatus"
• Key Value Contains: [OK]
• Incident Mapped With: "eventId"
• This ensures the incident tied to the specific eventId is resolved when the trigger status returns to OK.

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

4.3 Finalizing Setup

1. Save the API Filters:

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

2. Test the Integration:

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

5. Testing and Validation

5.1 Triggering Alerts

1. Simulate a High CPU Usage Event:

• Increase the CPU load on a host or monitored resource to trigger the alert in Zabbix.
• Verify that an incident is created in Callgoose SQIBS with the correct title and urgency.

5.2 Resolving Alerts

1. Lower the CPU Usage:

• Once the CPU usage returns to normal levels, the trigger status should be updated in Zabbix, and the incident should be resolved in Callgoose SQIBS.
• Verify that the incident in Callgoose SQIBS is 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.
• Zabbix Permissions: Restrict access to your Zabbix triggers and notifications with appropriate roles and permissions to ensure that only authorized actions can be performed.

7. Troubleshooting

• No Incident Created: Verify that the Zabbix webhook is correctly set up 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 Zabbix are being received and processed by Callgoose SQIBS.

8. Conclusion

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

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