NetApp Cloud Insights (CI)

Overview

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

Prerequisites

• NetApp Cloud Insights (CI) Account: Access to CI 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 CI.

1. Obtain API Token and Endpoint Details

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

1.1 Generate an API Token:

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

1.2 Find the API Endpoint:

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

2. Debugging and Troubleshooting

You can enable debugging in the API tokens used with CI 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 NetApp Cloud Insights (CI) to Send JSON Payloads

To configure CI 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 CI to ensure that the JSON payloads match those expected by Callgoose SQIBS.

3.1 Access Webhook Settings:

• Log in to NetApp Cloud Insights.
• Navigate to Admin > Notifications.
• Click on Webhook.

3.2 Add a Webhook:

• Click on Add Webhook.
• You will see the following options:

Add a Webhook

Name:
Template Type: Generic

URL: https://<Callgoose Webhook URL>

[ ] Validate SSL Certificate for secure communication

Method: POST
Custom Headers:
    Content-Type: application/json
    Accept: application/json

3.3 Customize the Message Body:

When you choose Template Type: Generic, the following JSON structure will be automatically filled in the Message Body field:

json

{
    "blocks":[
        {
            "type":"section",
            "text":{
                "type":"mrkdwn",
                "text":"*Cloud Insights Alert - %%alertId%%* \nSeverity - *%%severity%%*"
            }
        },
        {
            "type":"divider"
        },
        {
            "type":"section",
            "fields":[
                {
                    "type":"mrkdwn",
                    "text":"*Monitor:*\n %%monitorName%%"
                },
                {
                    "type":"mrkdwn",
                    "text":"*Monitor Type:*\n %%monitorType%%"
                },
                {
                    "type":"mrkdwn",
                    "text":"*Triggered On:*\n %%triggeredOn%%"
                },
                {
                    "type":"mrkdwn",
                    "text":"*Notification Rule(s):*\n %%notificationRuleNames%%"
                },
                {
                    "type":"mrkdwn",
                    "text":"*Condition:*\n %%alertCondition%%"
                },
                {
                    "type":"mrkdwn",
                    "text":"*Description:*\n %%alertDescription%%"
                }
            ]
        },
        {
            "type":"section",
            "text":{
                "type":"mrkdwn",
                "text":"<https://%%cloudInsightsHostname%%%%alertRelativeUrl%%|View Details>"
            }
        }
    ]
}

3.4 Custom Headers:

Ensure the following headers are automatically applied:

Custom Header
Content-Type: application/json
Accept: application/json

3.5 Create and Test the Webhook:

• After completing the above settings, click Create Webhook.
• Use the Test Webhook option to verify if the integration is working correctly and that the payload structure is being sent properly.

4. Setting Up Alerts in NetApp Cloud Insights

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

4.1 Log in to the NetApp Cloud Insights Console:

• Access the CI platform using your account credentials.

4.2 Navigate to the Alerts Section:

• In the CI console, go to Alerts > Create Alert.

4.3 Create a New Alert:

• Click on Add Alert to create a new alert.
• Specify Alert Conditions: Define the conditions that will trigger the alert, such as specific performance thresholds, security events, or custom metrics.

4.4 Configure the Notification Method:

• Choose Webhook as the notification method to send data to a webhook and choose Callgoose SQIBS webhook.

5. Configure Callgoose SQIBS API Endpoint and Filters

5.1 Obtain API Token and Endpoint:

• Refer to Callgoose SQIBS API Documentation to generate an API token and get the appropriate API endpoint for receiving webhook notifications.

5.2 Set Up API Filters in Callgoose SQIBS:

You will configure filters in Callgoose SQIBS to map incoming alerts to incidents.

Example JSON Payload :

• Triggered Alert (Severity: Critical):

json

{
  "alertId": "ci456",
  "severity": "Critical",
  "alertDescription": "Disk usage exceeded 90% on server ABC",
  "alertCondition": "Threshold breached",
  "triggeredOn": "server:ABC, volume:vol01",
  "monitorName": "Disk Usage Monitor",
  "monitorType": "Storage",
  "cloudInsightsHostname": "cloudinsights.example.com",
  "alertRelativeUrl": "/alerts/ci456"
}

• Resolved Alert (Severity: Normal):

json

{
  "alertId": "ci456",
  "severity": "Normal",
  "alertDescription": "Disk usage on server ABC returned to normal",
  "alertCondition": "Threshold restored",
  "triggeredOn": "server:ABC, volume:vol01",
  "monitorName": "Disk Usage Monitor",
  "monitorType": "Storage",
  "cloudInsightsHostname": "cloudinsights.example.com",
  "alertRelativeUrl": "/alerts/ci456"
}

5.3 Set Up API Filters:

In Callgoose SQIBS, configure API filters as follows:

• Trigger Filter (for creating incidents):
• Payload Key: "severity"
• Value Contains: [Critical]
• Map Incident With: "alertId"
• Incident Title From: "monitorName"
• Incident Description From: "alertDescription"
• Resolve Filter (for resolving incidents):
• Payload Key: "severity"
• Value Contains: [Normal]
• Map Incident With: "alertId"

5.4 Finalize Setup:

• Save the API filters and test the integration by manually triggering an alert in NetApp Cloud Insights to confirm incidents are correctly created and resolved in Callgoose SQIBS.

6. Testing & Validation

6.1 Test Triggered Alerts:

• Trigger an alert in NetApp Cloud Insights and check if the incident is created in Callgoose SQIBS with the expected details.

6.2 Test Resolved Alerts:

• Resolve the alert in NetApp Cloud Insights and verify that the corresponding incident in Callgoose SQIBS is marked as resolved.

Default Alert Parameters in NetApp Cloud Insights:

Here are the default alert parameters that will be used when configuring the payload:

Name Description

%%alertDescription%% Alert description

%%alertId%% Alert ID

%%alertRelativeUrl%% Relative URL to the alert page (use with %%cloudInsightsHostname%% for full URL)

%%metricName%% Monitored metric

%%monitorName%% Monitor name

%%monitorType%% Monitor type

%%severity%% Alert severity level

%%alertCondition%% Alert condition

%%triggerTime%% Alert trigger time (in GMT format)

%%triggerTimeEpoch%% Alert trigger time (in Epoch format)

%%triggeredOn%% Key-value pairs of the triggered object

%%triggeredOnKeys%% Keys of the monitored object

%%triggeredOnValues%% Values of the monitored object

%%value%% Metric value that triggered the alert

%%cloudInsightsLogoUrl%% Data Infrastructure Insights logo URL

%%cloudInsightsHostname%% Data Infrastructure Insights Hostname (used to build URLs)

%%cloudInsightsTenantName%% Data Infrastructure Insights Site Name for the tenant

7. Finalizing and Testing

7.1 Save and Activate the Alert:

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

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

7.3 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 CI 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.

8. Troubleshooting

• No Incident Created: If no incident is created, verify that the webhook URL in NetApp Cloud Insights 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 CI matches the expected structure.

9. Conclusion

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

• NetApp Cloud Insights 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 NetApp Cloud Insights.