TeamCity

Overview

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

Prerequisites

• TeamCity Account: Access to TeamCity for setting up 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 TeamCity.

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. API Token Documentation

1. Find the API Endpoint:

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

2. Debugging and Troubleshooting

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

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

3.1 Setting Up Notifications in TeamCity

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

1. Log in to the TeamCity Console:

• Access the TeamCity platform using your account credentials.

1. Navigate to the Build Configuration:

• In the TeamCity console, go to the project or build configuration for which you want to set up notifications.

1. Set Up Build and Deployment Notifications:

• Configure the build or deployment steps to send notifications when specific conditions are met (e.g., build failure, build success, deployment completed).

1. Configure the Notification Method:

• Choose Webhook as the notification method to send data to a webhook.
• Webhook URL: Enter the webhook URL provided by Callgoose SQIBS.

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", "project", "branch", "description", "timestamp", and others as shown in the example payloads.

1. Example Payload Setup:

json

{
  "build": {
    "id": "$BUILD_ID",
    "status": "$STATUS",
    "project": "$PROJECT",
    "branch": "$BRANCH",
    "description": "$DESCRIPTION",
    "timestamp": "$TIMESTAMP"
  }
}

1. Placeholder Explanation:

• "$STATUS": Replaces with the status of the build (e.g., SUCCESS, FAILURE).
• "$BUILD_ID": A unique identifier for the build.
• "$PROJECT": The project name in TeamCity.
• "$BRANCH": The branch name in the source control.
• "$DESCRIPTION": A descriptive message of the build or deployment.
• "$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 Notification:

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

1. Validate the Integration:

• Trigger a build or deployment manually if possible to verify that the correct JSON payload is sent to Callgoose SQIBS.
• Resolve any issues or failures in the build or deployment to ensure that the resolved state payload is also correctly sent and processed.

1. Additional Considerations:

• Permissions: Ensure that the webhook has the necessary permissions to send notifications to the Callgoose SQIBS API endpoint.
• Security: Implement security measures such as HTTPS and API tokens to protect the data being transmitted between TeamCity 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.

4. Configuring Callgoose SQIBS

4.1 Create API Filters in Callgoose SQIBS

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

4.1.1 Example JSON Payloads from TeamCity

Build Failed (status: "FAILURE")

json

{
  "build": {
    "id": "build123",
    "status": "FAILURE",
    "project": "Project Alpha",
    "branch": "master",
    "description": "Build failed due to unit test errors.",
    "timestamp": "2024-08-05T12:00:00.000Z"
  }
}

Build Successful (status: "SUCCESS")

json

{
  "build": {
    "id": "build123",
    "status": "SUCCESS",
    "project": "Project Alpha",
    "branch": "master",
    "description": "Build completed successfully.",
    "timestamp": "2024-08-05T12:30:00.000Z"
  }
}

4.2 Configuring API Filters

4.2.1 Integration Templates

If you see a TeamCity 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: [FAILURE, ERROR]
• Map Incident With: "build.id"
• This corresponds to the unique build.id from the TeamCity payload.
• Incident Title From: "build.description"
• This will use the build description 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 "description" key in the Incident Description From field, the incident description will be the value of the "description" key. In the example JSON payload provided earlier, this would result in a description like "Build failed due to unit test errors."
• Resolve Filter (For Resolving Incidents):
• Payload JSON Key: "status"
• Key Value Contains: [SUCCESS]
• Incident Mapped With: "build.id"
• This ensures the incident tied to the specific build.id is resolved when the build status returns to success.

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

1. Test the Integration:

• Manually trigger a build or deployment in TeamCity 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 or deployment issue in TeamCity and ensure that the corresponding incident in Callgoose SQIBS is marked as resolved.

5. Testing and Validation

5.1 Triggering Build/Deployment Alerts

1. Simulate a Build Failure:

• Introduce an error in the code or configuration that triggers a build failure in TeamCity.
• Verify that an incident is created in Callgoose SQIBS with the correct information, including the project name, branch, and error description.

1. Simulate a Successful Build:

• Fix the error and trigger a successful build.
• Verify that the incident in Callgoose SQIBS is automatically marked as resolved, and ensure that the correct information is reflected in the incident resolution.

5.2 Resolving Alerts

1. Acknowledge and Resolve the Alert:

• Once the issue is resolved in TeamCity (e.g., the build is successful), 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.
• TeamCity Permissions: Confirm that the webhook in TeamCity has appropriate permissions to send alerts and data to Callgoose SQIBS.
• Data Encryption: Ensure that the transmission of data between TeamCity 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 TeamCity 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 TeamCity matches the expected structure.

8. Conclusion

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

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