Telemetry · Getting Started

Installation

Install the telemetry package:

npm install @threadplane/telemetry

The package publishes separate entry points for browser, Node, and shared utilities:

import { provideThreadplaneTelemetry } from '@threadplane/telemetry/browser';
import { captureEvent, disableTelemetry } from '@threadplane/telemetry/node';
import { isTelemetryDisabled } from '@threadplane/telemetry';

Optional peers

@angular/core and posthog-js are optional peer dependencies.

Install @angular/core when you use the browser Angular provider and service:

npm install @threadplane/telemetry @angular/core

Install posthog-js only when you use direct browser PostHog delivery through posthogKey. New integrations should prefer sink or endpoint, because those keep delivery inside your application's analytics boundary.

npm install @threadplane/telemetry posthog-js

Browser entry point

Browser telemetry is opt-in. Calling provideThreadplaneTelemetry({ enabled: true, ... }) is what activates capture.

import { provideThreadplaneTelemetry } from '@threadplane/telemetry/browser';
 
provideThreadplaneTelemetry({
  enabled: true,
  endpoint: '/api/telemetry',
});

Node entry point

Node helpers live under @threadplane/telemetry/node.

import { captureRuntimeInstanceCreated } from '@threadplane/telemetry/node';
 
await captureRuntimeInstanceCreated({
  transport: 'langgraph',
  provider: 'openai',
  model: 'gpt-4.1',
});

Node telemetry respects the environment opt-out variables documented in Privacy and Opt-Out.

Next steps