respan | Respan Docs

@respan/respan is the main package for Respan tracing. It provides the Respan class that initializes OpenTelemetry, manages instrumentations, and exposes decorators for structured traces.

Install

$ npm install @respan/respan @respan/respan-sdk @respan/tracing

Quick start

1 import { Respan } from "@respan/respan";
2 import { OpenAIInstrumentor } from "@respan/instrumentation-openai";
3 
4 const respan = new Respan({
5   apiKey: process.env.RESPAN_API_KEY,
6   instrumentations: [new OpenAIInstrumentor()],
7 });
8 await respan.initialize();

Configuration

Parameter	Type	Default	Description
`apiKey`	`string`	`RESPAN_API_KEY` env var	Respan API key
`baseURL`	`string`	`https://api.respan.ai`	API base URL
`appName`	`string`	`"default"`	Application name for traces
`instrumentations`	`Instrumentation[]`	`[]`	Plugin instrumentations to activate
`traceContent`	`boolean`	`true`	Capture input/output content
`logLevel`	`string`	`"error"`	Log level (`debug`, `info`, `warn`, `error`)