MongoAtlas

Overview

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

Prerequisites

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

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

2. Debugging and Troubleshooting

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

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

3.1 Setting Up Alerts in MongoDB Atlas

To configure alerts and generate the required JSON payloads, follow the steps below within the MongoDB Atlas platform:

• Log in to MongoDB Atlas:
• Access the MongoDB Atlas console using your account credentials.
• Create Organization and Project (if not already created):
• If you don’t have an organization and project set up in MongoDB Atlas, create them now.
• While creating organization choose MongoDB Atlas.
• Refer Create Atlas Account for more details.
• Access Project Settings:
• Navigate to your project.
• Click on the three dots next to the project name and select Project Settings.
• Navigate to Alerts:
• In the project settings, click on Alerts.
• Create a New Alert:
• Click on Add New Alert to begin setting up a new alert.
• Select Alert Category and Condition:
• Choose the alert category that fits your needs. For example:
• Category: Host
• Condition/Metric: Select the specific target host and condition that should trigger the alert. Refer Configure Alerts for more details.

3.2 Configuring the Webhook Notification

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

• Navigating to Configure the Webhook Notification
• In the "Add Notification" section, click Add Notifier.
• Select Webhook as the notification method.
• Enter Webhook URL:
• In the Webhook URL field, provide the API endpoint URL obtained from Callgoose Sqibs. Refer to the API Endpoint documentation for more details on selecting the final endpoint format.
• Save the Alert:
• Once all details are filled in, click Save to complete the alert setup.

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

4.1.1 Example JSON Payloads from MongoAtlas

Alert Triggered (status: "OPEN"):

json

{
  "replicaSetName": "atlas-8txmel-shard-0",
  "metricName": "NETWORK_BYTES_IN",
  "created": "2024-09-23T10:25:25Z",
  "groupId": "66f0d3fe915a764c67b8da65",
  "hostnameAndPort": "atlas-8txmel-shard-00-01.xlxbb.mongodb.net:27017",
  "humanReadable": "Project: Project 0\n\nOrganization: Hanuman's Org - 2024-09-23\n\n----------------------------------------\n\nOPEN\nNetwork: Bytes In has gone above 17 bytes (avg/sec)\ncluster0-shard-00-01.xlxbb.mongodb.net\nCreated: 2024/09/23 10:25 GMT\nReplica Set: atlas-8txmel-shard-0\nType: Primary\nCurrent Value: 29.7 bytes\n\n----------------------------------------\n\n",
  "orgId": "66f0d3fe915a764c67b8da07",
  "alertConfigId": "66f1103d8fda2921a8cc0c67",
  "clusterName": "Cluster0",
  "userAlias": "cluster0-shard-00-01.xlxbb.mongodb.net",
  "eventTypeName": "OUTSIDE_METRIC_THRESHOLD",
  "links": [
    {
      "rel": "self",
      "href": "https://cloud.mongodb.com/api/atlas/v1.0/groups/66f0d3fe915a764c67b8da65/alerts/66f14215a3b06b32867e034c"
    }
  ],
  "id": "66f14215a3b06b32867e034c",
  "updated": "2024-09-23T10:25:25Z",
  "currentValue": {
    "number": 29.7,
    "units": "BYTES"
  },
  "status": "OPEN"
}

Alert Resolved (status: "CLOSED"):

json

{
  "replicaSetName": "atlas-8txmel-shard-0",
  "metricName": "NETWORK_BYTES_IN",
  "created": "2024-09-23T10:25:25Z",
  "groupId": "66f0d3fe915a764c67b8da65",
  "hostnameAndPort": "atlas-8txmel-shard-00-01.xlxbb.mongodb.net:27017",
  "humanReadable": "Project: Project 0\n\nOrganization: Hanuman's Org - 2024-09-23\n\n----------------------------------------\n\nCLOSED\nNetwork: Bytes In has gone above 17 bytes (avg/sec)\ncluster0-shard-00-01.xlxbb.mongodb.net\nCreated: 2024/09/23 10:25 GMT\nReplica Set: atlas-8txmel-shard-0\nType: Primary\nCurrent Value: 5.2 bytes\n\n----------------------------------------\n\n",
  "orgId": "66f0d3fe915a764c67b8da07",
  "alertConfigId": "66f1103d8fda2921a8cc0c67",
  "clusterName": "Cluster0",
  "userAlias": "cluster0-shard-00-01.xlxbb.mongodb.net",
  "eventTypeName": "OUTSIDE_METRIC_THRESHOLD",
  "links": [
    {
      "rel": "self",
      "href": "https://cloud.mongodb.com/api/atlas/v1.0/groups/66f0d3fe915a764c67b8da65/alerts/66f14215a3b06b32867e034c"
    }
  ],
  "id": "66f14215a3b06b32867e034c",
  "lastNotified": "2024-09-23T10:25:25Z",
  "updated": "2024-09-23T10:33:25Z",
  "currentValue": {
    "number": 5.200086668111135,
    "units": "BYTES"
  },
  "resolved": "2024-09-23T10:33:25Z",
  "status": "CLOSED"
}

4.2 Configuring API Filters

4.2.1 Integration Templates

If you see a MongoAtlas 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: [“OPEN”]
• Map Incident With: "alertConfigId"
• This corresponds to the unique alertCongifId from the MongoAtlas payload.
• Incident Title From: "eventTypeName"
• This will use the eventTypeName 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 "humanReadable" key in the Incident Description From field, the incident description will be the value of the "humanReadable" key. In the example JSON payload provided earlier, this would result in a description like "Project: Project 0\n\nOrganization: Hanuman's Org - 2024-09-23\n\n----------------------------------------\n\nCLOSED\nNetwork: Bytes In has gone above 17 bytes (avg/sec)\ncluster0-shard-00-01.xlxbb.mongodb.net\nCreated: 2024/09/23 10:25 GMT\nReplica Set: atlas-8txmel-shard-0\nType: Primary\nCurrent Value: 5.2 bytes\n\n----------------------------------------\n\n".
• Resolve Filter (For Resolving Incidents):
• Payload JSON Key: "status"
• Key Value Contains: ["CLOSED"]
• Incident Mapped With: "alertConfigId"
• This ensures the incident tied to the specific alertConfigId 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 MongoAtlas.

5. Testing and Validation

5.1 Triggering Alerts

• Simulate a Monitoring Alert:
• Trigger a condition in MongoAtlas that causes an alert (e.g., Network: Bytes In exceeding a threshold).
• 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 MongoAtlas (e.g., Network: Bytes In 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. This prevents unauthorized access and ensures that only legitimate data is processed.
• MongoAtlas Permissions: Confirm that the webhook in MongoAtlas has appropriate permissions to send alerts and data to Callgoose SQIBS. Limit access to the webhook to prevent unauthorized data transmission.

7. Troubleshooting

• No Incident Created: If no incident is created, verify that the webhook URL in MongoAtlas is correct and that the JSON payload structure matches the API filters configured in Callgoose SQIBS. Check the API logs in Callgoose SQIBS for any errors or mismatches in the JSON keys.
• Incident Not Resolved: Ensure that the resolve filter in Callgoose SQIBS is correctly configured and that the JSON payload sent by MongoAtlas matches the expected structure. Review the API logs to confirm that the resolution payload was received and processed correctly.

8. Conclusion

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

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