Harness

Overview

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

Prerequisites

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

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

2. Debugging and Troubleshooting

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

To configure Harness 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 Harness.

3.1 Setting Up Alerts and Webhook Notification for Pipeline Events

If you need to trigger notifications based on pipeline events, follow these steps.

• Before setting up alerts for pipeline events, ensure the following prerequisites are met:
• Connectors: Ensure that you have the necessary connectors configured. Refer Harness Connectors for more details.
• Repository: Ensure that a repository is set up in Harness.
• Pipelines: Create or select an existing pipeline for which you want to set up alerts.
• Navigate to the Pipelines Section:
• After logging in to Harness, go to the Pipelines section from the main menu.
• Select or Create a Pipeline:
• Choose the pipeline for which you want to set up alerts. If you don’t have one, create a new pipeline.
• Configure Notification Settings:
• Inside the pipeline settings, click on Notify to open the notification configuration panel.
• Set Up Webhook Notification:
• Name: Give a name to the notification configuration.
• Pipeline Events: Select the specific pipeline events that will trigger the alert (e.g., pipeline failure, success, or specific status changes).
• Channel Type: Select Webhook as the notification method.
• Enter Webhook URL:
• In the 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.
• Test the Webhook:
• Click on Test to verify if the webhook configuration is working as expected.
• Save the Configuration:
• Once verified, save the webhook configuration to enable alerting for the pipeline events.

3.2 Setting Up Alerts and Webhook Notification for Repository Events

If you need to trigger notifications based on repository events (such as commits or pull requests), follow these steps:

• Navigate to Code Repositories:
• In the Harness console, go to the Code Repositories section.
• Select the Repository:
• Choose the specific repository for which you want to set up webhook notifications.
• Configure the Webhook:
• Click on Webhooks under Code Repository, then click on New Webhook.
• Enter Webhook Details:
• Name and Description: Provide a name and description for the webhook.
• Payload URL: In the Payload URL field, enter the API endpoint URL provided by Callgoose SQIBS. Refer API Endpoint for more details.
• Select Repository Events:
• Choose the events that should trigger the webhook (e.g., new commits, pull requests, or branch merges).
• Create the Webhook:
• Click on Create Webhook to finalize the setup. The webhook will now send JSON payloads for the selected repository events to Callgoose SQIBS.

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

4.1.1 Example JSON Payloads from Harness

Alert Triggered (eventType: "PipelineFailed")

json

{
  "eventData": {
    "accountIdentifier": "J3_yx****",
    "orgIdentifier": "default",
    "projectIdentifier": "default_project",
    "pipelineIdentifier": "NewPipeline",
    "pipelineName": "NewPipeline",
    "planExecutionId": "zvWg********",
    "executionUrl": "https://app.harness.io/ng/#/account/J3_yx****/cd/orgs/default/projects/default_project/pipelines/NewPipeline/executions/zvWg********/pipeline",
    "pipelineUrl": "https://app.harness.io/ng/#/account/J3_yx****/cd/orgs/default/projects/default_project/pipelines/NewPipeline/pipeline-studio",
    "eventType": "PipelineFailed",
    "nodeStatus": "failed",
    "triggeredBy": {
      "triggerType": "MANUAL"              ,
      "name"       : "****"     ,
      "email"      : "****@gmail.com"
    },
    "moduleInfo": {},
    "startTime": "Fri Sep 20 04:17:26 GMT 2024",
    "startTs": 1726805846,
    "endTime": "Fri Sep 20 04:17:30 GMT 2024",
    "errorMessage": "There are no eligible delegates available in the account to execute the task.\n\nTaskId : KrOZ7N8DShCx-MDCtiYTXA-DEL",
    "endTs": 1726805850
  }
}

Alert Resolved (eventType: "PipelineSuccess")

json

{
  "eventData": {
    "accountIdentifier": "J3_yx****",
    "orgIdentifier": "default",
    "projectIdentifier": "default_project",
    "pipelineIdentifier": "NewPipeline",
    "pipelineName": "NewPipeline",
    "planExecutionId": "zvWg****",
    "executionUrl": "https://app.harness.io/ng/#/account/J3_yx****cd/orgs/default/projects/default_project/pipelines/NewPipeline/executions/zvWg****/pipeline",
    "pipelineUrl": "https://app.harness.io/ng/#/account/J3_yx****/cd/orgs/default/projects/default_project/pipelines/NewPipeline/pipeline-studio",
    "eventType": "PipelineSuccess",
    "nodeStatus": "completed",
    "triggeredBy": {
      "triggerType": "MANUAL"              ,
      "name"       : "****"     ,
      "email"      : "****@gmail.com"
    },
    "moduleInfo": {},
    "startTime": "Fri Sep 20 04:17:26 GMT 2024",
    "startTs": 1726805846,
    "endTime": "Fri Sep 20 04:17:30 GMT 2024",
    "endTs": 1726805850
  }
}

4.2 Configuring API Filters

4.2.1 Integration Templates

If you see a Harness 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: "eventData"."eventType"
• Key Value Contains: [pipelineFailed]
• Map Incident With: "eventData"."planExecutionId"
• This corresponds to the unique planExecutionid from the Harness payload.
• Incident Title From: "eventData"."eventType"
• This will use the event type 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 "eventData"."errorMessage" key in the Incident Description From field, the incident error message will be the value of the "description" key. In the example JSON payload provided earlier, this would result in a description like "There are no eligible delegates available in the account to execute the task.\n\nTaskId : KrOZ7N8DShCx-MDCtiYTXA-DEL".

Resolve Filter (For Resolving Incidents):

• Payload JSON Key: "eventData"."eventType"
• Key Value Contains: [pipelineSuccess]
• Incident Mapped With: "eventData"."planExecutionId"
• This ensures the incident tied to the specific planExecutionid 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 Honeycomb.

5. Testing and Validation

5.1 Triggering Alerts

• Simulate an Alert:
• Trigger a condition in Harness that causes an alert (e.g., a pipeline failure or a pull request).
• 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 Harness (e.g., pipeline issues are fixed), 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.
• Harness Permissions: Confirm that the webhook in Harness 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 Harness 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 Harness matches the expected structure.

8. Conclusion

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

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