ThreadplaneTelemetryService
Browser-side telemetry service.
The service no-ops unless provideThreadplaneTelemetry({ enabled: true })
configured it. It enriches sent events with sample_weight, then delivers
them through sink, endpoint, or legacy PostHog configuration.
import { ThreadplaneTelemetryService } from '@threadplane/telemetry/browser';Declaration
export declare class ThreadplaneTelemetryService {
capture(event: ThreadplaneTelemetryEvent, properties?: Record<string, unknown>): Promise<void>;
captureRuntimeInstanceCreated(input: ThreadplaneBrowserRuntimeTelemetry): Promise<void>;
captureRuntimeRequestCreated(input: ThreadplaneBrowserRuntimeTelemetry & {
requestType: string;
}): Promise<void>;
captureStreamEnded(input: ThreadplaneBrowserStreamTelemetry): Promise<void>;
captureStreamErrored(input: ThreadplaneBrowserStreamErrorTelemetry): Promise<void>;
captureStreamStarted(input: ThreadplaneBrowserStreamTelemetry): Promise<void>;
}Members
capture · overload 1
Capture an event using the configured delivery and sampling options.
capture(event: ThreadplaneTelemetryEvent, properties?: Record<string, unknown>): Promise<void>;Parameters
event· requiredThreadplaneTelemetryEventproperties· optionalRecord<string, unknown>
Returns
Promise<void>captureRuntimeInstanceCreated · overload 1
Capture a runtime construction event.
captureRuntimeInstanceCreated(input: ThreadplaneBrowserRuntimeTelemetry): Promise<void>;Parameters
input· requiredThreadplaneBrowserRuntimeTelemetry
Returns
Promise<void>captureRuntimeRequestCreated · overload 1
Capture a runtime request creation event.
captureRuntimeRequestCreated(input: ThreadplaneBrowserRuntimeTelemetry & {
requestType: string;
}): Promise<void>;Parameters
input· requiredThreadplaneBrowserRuntimeTelemetry & { requestType: string; }
Returns
Promise<void>captureStreamEnded · overload 1
Capture a stream-end event.
captureStreamEnded(input: ThreadplaneBrowserStreamTelemetry): Promise<void>;Parameters
input· requiredThreadplaneBrowserStreamTelemetry
Returns
Promise<void>captureStreamErrored · overload 1
Capture a stream-error event, sending only the derived error class.
captureStreamErrored(input: ThreadplaneBrowserStreamErrorTelemetry): Promise<void>;Parameters
input· requiredThreadplaneBrowserStreamErrorTelemetry
Returns
Promise<void>captureStreamStarted · overload 1
Capture a stream-start event.
captureStreamStarted(input: ThreadplaneBrowserStreamTelemetry): Promise<void>;Parameters
input· requiredThreadplaneBrowserStreamTelemetry
Returns
Promise<void>