⚡ Quick Start Guide

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

🔑 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!

⚠️

Important Security Note

Store your API key securely. Never commit it to version control. Use environment variables instead.

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

Installation:
npm install @tracekit/node-apm
Features:
  • Express & Fastify middleware
  • Full TypeScript support
  • Automatic batching & retry
View Documentation

Python SDK

Official SDK for Python 3.8+ applications

Installation:
pip install tracekit-apm
Features:
  • Flask, Django & FastAPI middleware
  • Type hints support
  • Context managers for tracing
View Documentation

Go SDK

Official SDK for Go applications

Installation:
go get github.com/Tracekit-Dev/go-sdk
Features:
  • Goroutine-safe logging
  • Automatic batching & retry
  • Context support for tracing
View Documentation

PHP SDK

Official SDK for PHP 8.1+ applications

Installation:
composer require tracekit/php-apm
Features:
  • Symfony & PSR-15 middleware
  • Strict types & enums
  • Auto-shutdown handling
View Documentation

Java SDK

Official SDK for Java & Kotlin applications

Installation (Maven):
<dependency><groupId>dev.tracekit</groupId><artifactId>tracekit-core</artifactId></dependency>
Features:
  • Spring Boot auto-configuration
  • Kotlin coroutine support
  • Annotation-based tracing
View Documentation

C# / .NET SDK

Official SDK for .NET 8+ applications

Installation:
dotnet add package TraceKit.AspNetCore
Features:
  • ASP.NET Core middleware
  • Dependency injection support
  • Minimal API integration
View Documentation

Laravel SDK

First-class Laravel integration package

Installation:
composer require tracekit/laravel-apm
Features:
  • Auto-discovery & zero config
  • Queue & job tracing
  • Blade directive support
View Documentation

Ruby SDK

Official SDK for Ruby 2.7+ and Rails applications

Installation:
bundle add tracekit
Features:
  • Rails Railtie auto-configuration
  • Sidekiq & Redis tracing
  • Security scanning built-in
View Documentation

🚀 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
✅

You're All Set!

Once configured, your traces will start appearing in the TraceKit dashboard automatically.

Next Steps

🚨

Set Up Alerts

Get notified when your services experience issues
📖

Learn About Alerting

Understand alert types and best practices