TraceKit DocsIntegration Overview
Overview of TraceKit integration options including REST API and CLI. Choose the best approach for your application.
TraceKit Integration
Integrate TraceKit into your applications using our REST API or CLI tool. Choose the approach that best fits your workflow.
What is TraceKit Integration?
TraceKit provides multiple ways to integrate monitoring into your applications. Whether you prefer a simple command-line tool or full programmatic control via REST API, we've got you covered.
Integration Methods
OTLP Direct (No SDK Required)
Already running OpenTelemetry? Skip the SDK entirely. TraceKit accepts standard OTLP over HTTP -- just configure your exporter:
Traces: https://app.tracekit.dev/v1/traces
Metrics: https://app.tracekit.dev/v1/metrics
Header: X-API-Key: your_api_key_hereWorks with any language, any framework, any existing OTel setup. No code changes needed beyond updating the exporter endpoint.
When do you need the SDK? Only for features outside the OpenTelemetry spec: live breakpoints (non-breaking production debugging), automatic PII scrubbing, and LLM auto-instrumentation. If you only need tracing and metrics, OTLP direct is all you need.
CLI Integration
The fastest way to get started. One command sets up everything automatically.
- Automatic framework detection
- SDK installation included
- Health monitoring setup
- Interactive setup wizard
tracekit initAPI Integration
Full programmatic control for custom integrations and partner applications.
- RESTful API endpoints
- Email-based registration
- Health check API
- Webhook support
POST /v1/integrate/registerWhat You Get
- Hacker Plan (Free) -- 200,000 traces per month forever, completely free
- Email Notifications -- Automatic alert setup for service issues
- Health Monitoring -- Uptime tracking with heartbeats and endpoint checks
- Dashboard Access -- Full-featured web UI for traces, metrics, and alerts
Comparison
| Feature | OTLP Direct | CLI | API |
|---|---|---|---|
| Setup Time | 1 config change | 1 command | Multiple API calls |
| SDK Required | No | Optional | Manual |
| Framework Detection | N/A | Automatic | Manual |
| Live Breakpoints | No | Yes (with SDK) | Yes (with SDK) |
| LLM Instrumentation | No | Yes (with SDK) | Yes (with SDK) |
| Best For | Existing OTel users | New projects | Frameworks and partners |
Choosing a Method
When to use each method:
- OTLP Direct: You already have OpenTelemetry set up and just want tracing/metrics
- CLI: Starting fresh, want the fastest setup with optional SDK features
- API: Framework integrations, partner applications, custom workflows
Ready to Integrate?
- CLI Integration Guide -- Start with one command setup
- API Integration Guide -- Build custom integrations
Embeddable Widgets
Embed TraceKit status widgets in your dashboards and status pages. Real-time service health, error rates, and performance metrics.
API Integration
Integrate with TraceKit using the REST API. Register services, send traces, manage health checks, and configure webhooks programmatically.