AIDK API Reference / aidk-kernel / TelemetryProvider

Interface: TelemetryProvider

Defined in: packages/kernel/src/telemetry.ts:87

Interface for telemetry providers (e.g., OpenTelemetry, DataDog).

Implement this interface to integrate with your observability platform.

Example

import { trace, metrics } from '@opentelemetry/api';

const otelProvider: TelemetryProvider = {
  startTrace(name) { return trace.getTracer('aidk').startSpan(name).spanContext().traceId; },
  startSpan(name) { return trace.getTracer('aidk').startSpan(name); },
  // ... implement other methods
};

Telemetry.setProvider(otelProvider);

Methods

endTrace()

endTrace(): void;

Defined in: packages/kernel/src/telemetry.ts:95

End the current trace.

Returns

void

---

getCounter()

getCounter(
   name: string, 
   unit?: string, 
   description?: string): Counter;

Defined in: packages/kernel/src/telemetry.ts:97

Get or create a counter metric.

Parameters

Parameter	Type
name	string
unit?	string
description?	string

Returns

Counter

---

getHistogram()

getHistogram(
   name: string, 
   unit?: string, 
   description?: string): Histogram;

Defined in: packages/kernel/src/telemetry.ts:99

Get or create a histogram metric.

Parameters

Parameter	Type
name	string
unit?	string
description?	string

Returns

Histogram

---

recordError()

recordError(error: any): void;

Defined in: packages/kernel/src/telemetry.ts:93

Record an error in the current trace/span.

Parameters

Parameter	Type
error	any

Returns

void

---

startSpan()

startSpan(name: string): Span;

Defined in: packages/kernel/src/telemetry.ts:91

Start a new span within the current trace.

Parameters

Parameter	Type
name	string

Returns

Span

---

startTrace()

startTrace(name: string): string;

Defined in: packages/kernel/src/telemetry.ts:89

Start a new trace and return its ID.

Parameters

Parameter	Type
name	string

Returns

string