CircleCI

Overview

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

Prerequisites

• CircleCI Account: Access to CircleCI for managing build and deployment pipelines.
• Callgoose SQIBS Account: With valid privileges to set up API filters and receive notifications.
• Webhook/API Endpoint: Available in Callgoose SQIBS to receive notifications from CircleCI.

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.

1. Generate an API Token:

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

1. Find the API Endpoint:

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

2. Debugging and Troubleshooting

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

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

3.1 Setting Up Notifications in CircleCI

To generate the required JSON payloads, you first need to set up notifications within CircleCI.

1. Log in to the CircleCI Console:

• Access the CircleCI platform using your account credentials.

1. Navigate to the Project Settings:

• In the CircleCI console, go to the "Project Settings" for the specific project you want to integrate with Callgoose SQIBS.

1. Set Up Webhook Notifications:

• Under "Webhooks," click on "Add Webhook."
• Enter the Webhook URL provided by Callgoose SQIBS.
• Ensure the protocol is HTTPS for secure data transmission.

3.2 Configuring the Webhook Notification

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

1. Add Webhook URL:

• In the Webhook URL field, enter the endpoint provided by Callgoose SQIBS.
• Ensure the protocol is HTTPS for secure data transmission.

1. Customize Payload Format:

• Ensure that the payload includes key fields like "status", "build_num", "branch", "author", "build_url", and others as shown in the example payloads.
• Example Payload Setup:

json

{
  "payload": {
    "build_num": "$BUILD_NUM",
    "status": "$STATUS",
    "branch": "$BRANCH",
    "author": "$AUTHOR",
    "build_url": "$BUILD_URL",
    "timestamp": "$TIMESTAMP"
  }
}

• Placeholder Explanation:
• $BUILD_NUM: Replaces with the unique build number.
• $STATUS: The status of the build or deployment (e.g., SUCCESS, FAILED).
• $BRANCH: The branch being built or deployed.
• $AUTHOR: The author who triggered the build or deployment.
• $BUILD_URL: The URL to the build or deployment details.
• $TIMESTAMP: The time the event occurred.

1. Test the Webhook Configuration:

• Before activating the webhook, perform a test to ensure that the JSON payload is correctly formatted and is being sent to the Callgoose SQIBS API endpoint as expected.
• Review the payload in Callgoose SQIBS to confirm that it matches the expected structure.

3.3 Finalizing and Testing

1. Save and Activate the Webhook:

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

1. Validate the Integration:

• Trigger a build or deployment in CircleCI to verify that the correct JSON payload is sent to Callgoose SQIBS.
• Verify that the incident appears in Callgoose SQIBS with the correct title, description, and mapped values.

4. Configuring Callgoose SQIBS

4.1 Create API Filters in Callgoose SQIBS

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

4.1.1 Example JSON Payloads from CircleCI

• Build/Deployment Triggered (status: "SUCCESS"):

json

{
  "payload": {
    "build_num": "1234",
    "status": "SUCCESS",
    "branch": "main",
    "author": "devops@example.com",
    "build_url": "https://circleci.com/gh/username/repo/1234",
    "timestamp": "2024-08-05T12:00:00.000Z"
  }
}

• Build/Deployment Failed (status: "FAILED"):

json

{
  "payload": {
    "build_num": "1235",
    "status": "FAILED",
    "branch": "develop",
    "author": "devops@example.com",
    "build_url": "https://circleci.com/gh/username/repo/1235",
    "timestamp": "2024-08-05T12:30:00.000Z"
  }
}

4.2 Configuring API Filters

4.2.1 Integration Templates

If you see a CircleCI 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: [FAILED, SUCCESS]
• Map Incident With: "payload.build_num"
• This corresponds to the unique build number from the CircleCI payload.
• Incident Title From: "payload.branch"
• This will use the branch name 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.
• Resolve Filter (For Resolving Incidents):
• Payload JSON Key: "status"
• Key Value Contains: [SUCCESS]
• Incident Mapped With: "payload.build_num"
• This ensures the incident tied to the specific build number is resolved when the build or deployment status is successful.

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.
• Double-check that all key mappings, incident titles, and descriptions are correctly aligned with the payload structure sent by CircleCI.

1. Test the Integration:

• Trigger a build or deployment in CircleCI to test if incidents are created in Callgoose SQIBS.
• Verify that the incident appears in Callgoose SQIBS with the correct title, description, and mapped values.
• Resolve the build/deployment in CircleCI and ensure that the corresponding incident in Callgoose SQIBS is marked as resolved.

5. Testing and Validation

5.1 Triggering Builds and Deployments

1. Simulate a Build/Deployment:

• Trigger a build or deployment in CircleCI to simulate a development or operational task.
• Verify that an incident is created in Callgoose SQIBS with the correct information.

5.2 Resolving Incidents

1. Complete the Build/Deployment:

• Once the build or deployment is completed in CircleCI, verify that the incident in Callgoose SQIBS is updated or marked as resolved based on the success or failure status of the build.

1. Check Incident Resolution:

• Ensure that the incident created in Callgoose SQIBS is resolved when the build or deployment completes successfully in CircleCI.
• If the build or deployment fails again, a new incident should be created or the existing one updated depending on your API filter configuration.

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.
• CircleCI Permissions: Confirm that the webhook in CircleCI has appropriate permissions to send notifications and data to Callgoose SQIBS.
• Data Encryption: Ensure that the transmission of data between CircleCI and Callgoose SQIBS is encrypted, especially if sensitive information is involved.

7. Troubleshooting

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

8. Conclusion

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

• CircleCI 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 notifications from CircleCI.