opentelemetry

Overview

This document provides a detailed guide to integrating OpenTelemetry with Callgoose SQIBS for:

• Real-time Incident Management
• Automated Incident Creation and Resolution
• Event-driven alerting and workflows

OpenTelemetry is a vendor-neutral observability framework that collects logs, metrics, and traces. By forwarding this telemetry data to Callgoose SQIBS, organizations can automate incident detection and response.

Prerequisites

Before starting, ensure the following:

• Callgoose SQIBS account
• Access to Incoming Webhook integration
• OpenTelemetry Collector installed
• Application instrumented (optional but recommended)
• Basic understanding of JSON payloads

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

https://****.callgoose.com/v1/process?from=opentelemetry&token=xxxx

2: Install OpenTelemetry Collector

Using Docker (Recommended)

docker run -p 4317:4317 -p 4318:4318 otel/opentelemetry-collector

3: Configure OpenTelemetry Collector

Create a configuration file:

receivers:
  otlp:
    protocols:
      grpc:
      http:

processors:
  batch:

exporters:
  http:
    endpoint: https://<CALLGOOSE_WEBHOOK_URL>
    headers:
      Content-Type: application/json

service:
  pipelines:
    logs:
      receivers: [otlp]
      processors: [batch]
      exporters: [http]

    metrics:
      receivers: [otlp]
      processors: [batch]
      exporters: [http]

    traces:
      receivers: [otlp]
      processors: [batch]
      exporters: [http]

4: Configure Callgoose SQIBS

4.1 Create Webhook Integration

1. Navigate to Settings → Integrations
2. Select Incoming Webhook
3. Copy the Webhook URL

5: Payload Structure

Telemetry data must be transformed into a structured payload.

Sample Payload

{
  "status": "error",
  "service": "user-service",
  "message": "High latency detected",
  "incident_id": "trace-456",
  "severity": "critical"
}

6: Trigger Configuration

6.1 Trigger Filter — Create Incident

The Trigger Filter is used to create an incident in Callgoose SQIBS when a failure or issue is detected from OpenTelemetry data.

• Payload JSON Key: status
• Key Value Contains: error
• Map Incident With: incident_id
• Incident Title: service
• Incident Description: message

Whenever OpenTelemetry sends a payload with "status": "error", a new incident is automatically created in Callgoose SQIBS.

6.2 Resolve Filter — Auto Resolve Incident

The Resolve Filter is used to automatically close an incident when the issue is resolved.

• Payload JSON Key: status
• Key Value Contains: ok
• Incident Mapped With: incident_id

When OpenTelemetry sends a payload with "status": "ok", the corresponding incident in Callgoose SQIBS is automatically marked as resolved.

Refer to the API Filter Instructions and FAQ for more details.

7: Application Instrumentation (Optional)

Node.js Example

const { NodeSDK } = require('@opentelemetry/sdk-node');
const { OTLPTraceExporter } = require('@opentelemetry/exporter-trace-otlp-http');

const sdk = new NodeSDK({
  traceExporter: new OTLPTraceExporter({
    url: "http://localhost:4318/v1/traces"
  })
});

sdk.start();

8: Data Transformation Strategy

Since OpenTelemetry sends raw telemetry:

• Extract relevant fields (severity, message, service)
• Map telemetry to incident fields
• Send only actionable events

9: Testing the Integration

1. Trigger an error in your application
2. Verify data reaches OpenTelemetry Collector
3. Confirm webhook delivery to Callgoose SQIBS
4. Check incident creation
5. Resolve the issue
6. Verify incident auto-resolution

Use Cases

• Application performance monitoring
• Error tracking and alerting
• Distributed system observability
• Automated incident lifecycle management

Best Practices

• Use unique incident_id (prefer trace_id)
• Normalize severity levels
• Filter noise using processors
• Use batching for performance
• Secure webhook endpoints

10:Conclusion

Integrating OpenTelemetry with Callgoose SQIBS enables a complete observability-driven incident management system. It allows organizations to automatically detect issues, create incidents, and resolve them efficiently without manual intervention.

• documentation of opentelemetry
• Callgoose SQIBS API Token Documentation
• Callgoose SQIBS API Endpoint Documentation
• API Filter Instructions and FAQ
• How to Send API