@summa-ledger/telemetry

Warning This package is under active development and in a highly experimental stage. APIs may change without notice. Extensive testing is still pending — do not use in production until a stable release is announced.

Anonymous usage analytics for the Summa CLI.

Installation

npm install @summa-ledger/telemetry

Usage

import { createTelemetry } from "@summa-ledger/telemetry";

const telemetry = createTelemetry({ version: "0.1.0" });

telemetry.track("cli.command", { command: "migrate" });

Telemetry State

Telemetry is opt-in and disabled by default. Users can enable it via summa telemetry on.

import { isTelemetryEnabled, readTelemetryState, writeTelemetryState } from "@summa-ledger/telemetry";

if (isTelemetryEnabled()) {
  // telemetry is active
}

Events are fire-and-forget -- they never block the CLI or throw errors.

Documentation

Full documentation available at https://summa.dev.

License

MIT