VibeKit provides built-in support for OpenTelemetry, the industry-standard observability framework. This integration allows you to collect traces, metrics, and logs from your VibeKit operations for monitoring and debugging purposes.

What is OpenTelemetry?

OpenTelemetry is a collection of APIs, libraries, agents, and instrumentation to provide observability for cloud-native software. It enables you to:

  • Trace requests across distributed systems
  • Collect metrics about application performance
  • Generate logs with structured data
  • Export data to various observability backends

Configuration

To enable OpenTelemetry in VibeKit, add the telemetry configuration to your VibeConfig:

import { VibeKit, VibeConfig } from "@vibe-kit/sdk";

const config: VibeConfig = {
  agent: {
    type: "codex",
    model: {
      apiKey: "sk-proj-****",
    },
  },
  environment: {
    e2b: {
      apiKey: "e2b_****",
    },
  },
  github: {
    token: "ghp_****",
    repository: "superagent-ai/vibekit",
  },
  telemetry: {
    isEnabled: true,
    endpoint: "https://test-otel-endpoint.com/v1/traces",
    serviceName: "test-vibekit",
    serviceVersion: "1.0.0",
    headers: {
      Authorization: "Bearer test-token",
    },
    timeout: 5000,
    samplingRatio: 1.0,
    resourceAttributes: {
      environment: "test",
    },
  },
};

const vibeKit = new VibeKit(config);

Configuration Options

OptionTypeDescriptionDefault
isEnabledbooleanEnable/disable telemetry collectionfalse
endpointstringOTLP endpoint URL for trace export-
serviceNamestringName of your service for identification"vibekit"
serviceVersionstringVersion of your service"1.0.0"
headersobjectCustom headers for the OTLP exporter{}
timeoutnumberTimeout for trace export in milliseconds30000
samplingRationumberSampling ratio (0.0 to 1.0)1.0
resourceAttributesobjectAdditional resource attributes{}

Supported Backends

VibeKit’s OpenTelemetry integration works with any OTLP-compatible observability backend, including:

What Gets Traced

When telemetry is enabled, VibeKit automatically traces:

  • Code generation requests and responses
  • Agent interactions and decision making
  • Environment setup and teardown
  • GitHub operations
  • Error conditions and exceptions

Each trace includes relevant metadata such as:

  • Request/response payloads (sanitized)
  • Execution duration
  • Success/failure status
  • Agent model information
  • Environment details