JFrog Pipelines

Overview

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

Prerequisites

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

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

2. Debugging and Troubleshooting

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

Follow these steps to set up monitoring, alerts, and webhook integrations in JFrog Pipelines, ensuring that the JSON payloads generated match the required format for Callgoose SQIBS.

3.1 Setting Up Webhook in JFrog Pipelines

• Log In to JFrog Pipelines
• Open the JFrog platform and log in using your credentials.
• Initial Setup
• Follow the on-screen instructions to complete the account setup.
• Instructions may include:
• Creating a repository.
• Connecting a developer client.
• Connecting a CI tool.
• Configure the Webhook
• Navigate to Administration in JFrog Pipelines.
• Go to General Management.
• Click on Webhooks.
• Create a New Webhook
• Select New Webhook to start creating a webhook for Callgoose SQIBS.
• Enter Webhook Details
• Name: Provide a unique name for the webhook (e.g., "Callgoose SQIBS Integration").
• URL: In the URL field, paste the endpoint URL provided by Callgoose SQIBS.
• Select Events to Trigger Alerts
• Choose the events for which you want to receive alerts. Common events include:
• Build was uploaded
• Build was promoted
• You can customize the event selection based on your requirements.
• Test the Webhook Connection
• Click on Test to verify if the webhook connection is successful.
• You can confirm the receipt of the test payload in the API Log section of Callgoose SQIBS.
• Save the Webhook
• Once the test is successful, click Save to activate the webhook.

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

4.1.1 Example JSON Payloads from JFrog Pipelines

Alert Triggered (event_type: "Uploaded")

json

{
  "domain": "build",
  "event_type": "uploaded",
  "data": {
    "build_name": "sample_build_name",
    "build_number": "1",
    "build_started": "1970-01-01T00:00:00.000+0000",
    "build_repo": "artifactory-build-info"
  },
  "subscription_key": "test",
  "jpd_origin": "https://zeanox.jfrog.io",
  "source": "jfrog/****@rit.ac.in"
}

4.2 Configuring API Filters

4.2.1 Integration Templates

If you see an JFrog Pipelines 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: "event_type"
• Key Value Contains: [uploaded, deleted, promoted]
• Map Incident With: null
• Incident Title From: "data"."build_name"
• 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 "data"."build_repo" key in the Incident Description From field, the incident description will be the value of the "data"."build_repo" key. In the example JSON payload provided earlier, this would result in a description like "artifactory-build-info".
• Resolve Filter (For Resolving Incidents):
• Payload JSON Key: null
• Key Value Contains: null
• Incident Mapped With: null

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 JFrog Pipelines.

5. Testing and Validation

5.1 Triggering Alerts

• Simulate a Monitoring Alert:
• Trigger a condition in JFrog Pipelines that causes an alert (e.g., Perform a test action in JFrog Pipelines that triggers one of the selected events.).
• Verify that an incident is created in Callgoose SQIBS with the correct information.

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.
• JFrog Pipelines Permissions: Confirm that the webhook in JFrog Pipelines 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 JFrog Pipelines 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 JFrog Pipelines matches the expected structure.

8. Conclusion

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

• JFrog Pipelines 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 JFrog Pipelines.