Quick Start Guide

Get TraceKit running with your application in just a few minutes.

Traces:  https://app.tracekit.dev/v1/traces
Metrics: https://app.tracekit.dev/v1/metrics
Header:  X-API-Key: your_api_key_here

Step 1: Generate an API Key

Every application sending traces to TraceKit needs an API key for authentication.

1. Navigate to API Keys in the dashboard
2. Click "Generate New Key"
3. Give your key a descriptive name (e.g., "Production Backend")
4. Copy the key immediately -- you won't see it again!

Step 2: Install SDK

Select your application's programming language and install the SDK:

Node.js SDK

Official SDK for Node.js and TypeScript applications.

npm install @tracekit/node-apm

Features:

• Express & Fastify middleware
• Full TypeScript support
• Automatic batching & retry

View Documentation | GitHub | npm

Python SDK

Official SDK for Python 3.8+ applications.

pip install tracekit-apm

Features:

• Flask, Django & FastAPI middleware
• Type hints support
• Context managers for tracing

View Documentation | GitHub | PyPI

Go SDK

Official SDK for Go applications.

go get github.com/Tracekit-Dev/go-sdk

Features:

• Goroutine-safe logging
• Automatic batching & retry
• Context support for tracing

View Documentation | GitHub | pkg.go.dev

PHP SDK

Official SDK for PHP 8.1+ applications.

composer require tracekit/php-apm

Features:

• Symfony & PSR-15 middleware
• Strict types & enums
• Auto-shutdown handling

View Documentation | GitHub | Packagist

Java SDK

Official SDK for Java & Kotlin applications.

<dependency>
  <groupId>dev.tracekit</groupId>
  <artifactId>tracekit-core</artifactId>
</dependency>

Features:

• Spring Boot auto-configuration
• Kotlin coroutine support
• Annotation-based tracing

View Documentation | GitHub | Maven Central

C# / .NET SDK

Official SDK for .NET 8+ applications.

dotnet add package TraceKit.AspNetCore

Features:

• ASP.NET Core middleware
• Dependency injection support
• Minimal API integration

View Documentation | GitHub | NuGet

Laravel SDK

First-class Laravel integration package.

composer require tracekit/laravel-apm

Features:

• Auto-discovery & zero config
• Queue & job tracing
• Blade directive support

View Documentation | GitHub | Packagist

Ruby SDK

Official SDK for Ruby 2.7+ and Rails applications.

bundle add tracekit

Features:

• Rails Railtie auto-configuration
• Sidekiq & Redis tracing
• Security scanning built-in

View Documentation | GitHub | RubyGems

Step 3: Configure OTLP Endpoint

All language integrations send traces to the same endpoint:

Endpoint: https://app.tracekit.dev/v1/traces
Header: X-API-Key: ctxio_your_api_key_here

Next Steps

• Code Monitoring -- Set non-breaking breakpoints and capture live variable snapshots
• Custom Metrics -- Track counters, gauges, and histograms with SDK-native methods
• Set Up Alerts -- Get notified when your services experience issues
• Notification Channels -- Configure Slack and Telegram notifications