--- slug: "kopai-mono" source_type: "readme" source_url: "https://cdn.jsdelivr.net/gh/kopai-app/kopai-mono@main/README.md" repo: "https://github.com/kopai-app/kopai-mono" source_file: "README.md" branch: "main" ---

Kopai

OpenTelemetry observability backend in TypeScript running on Node.js


license Ask DeepWiki

Docs
## Quick Start Run with ``` npx @kopai/app start ``` - send OpenTelemetry signals to localhost:4318 using HTTP - inspect the data using [`@kopai/cli`](https://github.com/kopai-app/kopai-mono/tree/HEAD/packages/cli) - view traces, logs and metrics in your browser at localhost:8000 See: [OpenTelemetry Demo App running with @kopai/app](https://github.com/kopai-app/opentelemetry-demo/tree/main/kopai). ## Docker A public Docker image is available on GitHub Container Registry: ``` docker run --rm -p 8000:8000 -p 4318:4318 ghcr.io/kopai-app/kopai:latest ``` The image is built on [Docker Hardened Images](https://hub.docker.com/hardened-images) (`dhi.io/node:24-debian13`) and published automatically on each release. ## Packages | Package | Description | Version | | ---------------------------------------------------------------- | ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | | [@kopai/app](https://github.com/kopai-app/kopai-mono/tree/HEAD/packages/app) | Local OTEL Backend | [![npm](https://img.shields.io/npm/v/@kopai/app?label=latest)](https://www.npmjs.com/package/@kopai/app) | | [@kopai/core](https://github.com/kopai-app/kopai-mono/tree/HEAD/packages/core) | Core logic and types | [![npm](https://img.shields.io/npm/v/@kopai/core?label=latest)](https://www.npmjs.com/package/@kopai/core) | | [@kopai/sdk](https://github.com/kopai-app/kopai-mono/tree/HEAD/packages/sdk) | SDK | [![npm](https://img.shields.io/npm/v/@kopai/sdk?label=latest)](https://www.npmjs.com/package/@kopai/sdk) | | [@kopai/cli](https://github.com/kopai-app/kopai-mono/tree/HEAD/packages/cli) | CLI tool | [![npm](https://img.shields.io/npm/v/@kopai/cli?label=latest)](https://www.npmjs.com/package/@kopai/cli) | | [@kopai/api](https://github.com/kopai-app/kopai-mono/tree/HEAD/packages/api) | OTEL signals API | [![npm](https://img.shields.io/npm/v/@kopai/api?label=latest)](https://www.npmjs.com/package/@kopai/api) | | [@kopai/ui](https://github.com/kopai-app/kopai-mono/tree/HEAD/packages/ui) | Dashboard React components | [![npm](https://img.shields.io/npm/v/@kopai/ui?label=latest)](https://www.npmjs.com/package/@kopai/ui) | | [@kopai/ui-core](https://github.com/kopai-app/kopai-mono/tree/HEAD/packages/ui-core) | DOM-free SDUI primitives | [![npm](https://img.shields.io/npm/v/@kopai/ui-core?label=latest)](https://www.npmjs.com/package/@kopai/ui-core) | | [@kopai/collector](https://github.com/kopai-app/kopai-mono/tree/HEAD/packages/collector) | OTLP collector, HTTP only | [![npm](https://img.shields.io/npm/v/@kopai/collector?label=latest)](https://www.npmjs.com/package/@kopai/collector) | | [@kopai/sqlite-datasource](https://github.com/kopai-app/kopai-mono/tree/HEAD/packages/sqlite-datasource) | SQLite datasource | [![npm](https://img.shields.io/npm/v/@kopai/sqlite-datasource?label=latest)](https://www.npmjs.com/package/@kopai/sqlite-datasource) | | [@kopai/clickhouse-datasource](https://github.com/kopai-app/kopai-mono/tree/HEAD/packages/clickhouse-datasource) | ClickHouse datasource | [![npm](https://img.shields.io/npm/v/@kopai/clickhouse-datasource?label=latest)](https://www.npmjs.com/package/@kopai/clickhouse-datasource) | | [@kopai/otel-testing-harness](https://github.com/kopai-app/kopai-mono/tree/HEAD/packages/otel-testing-harness) | In-process OTEL testing harness | [![npm](https://img.shields.io/npm/v/@kopai/otel-testing-harness?label=latest)](https://www.npmjs.com/package/@kopai/otel-testing-harness) | | [@kopai/tsconfig](https://github.com/kopai-app/kopai-mono/tree/HEAD/packages/tsconfig) | Shared TypeScript config | | ### Dependency Graph ``` ┌─────────────┐ │ tsconfig │ └──────▲──────┘ │ ┌──────┴──────┐ ┌────────────┬──────────────┤ core ├──────────────┬────────────┬──────────────┐ │ │ └──────▲──────┘ │ │ │ │ │ │ │ │ │ ┌─────┴─────┐ ┌────┴────┐ ┌──────┴──────┐ ┌─────┴─────┐ ┌────┴─────┐ ┌──────┴─────┐ │ api │ │ ui │ │ sdk │ │ collector │ │ sqlite- │ │clickhouse- │ └─────▲─────┘ └────▲────┘ └──────▲──────┘ └─────▲─────┘ │datasource│ │ datasource │ │ │ │ │ └────▲─────┘ └────────────┘ │ │ ┌─────┴─────┐ │ │ │ │ │ cli │ │ │ │ │ └───────────┘ │ │ │ │ │ │ └────────────┴───────┬───────────────────────────────────┴────────────┘ │ ┌──────┴──────┐ │ app │ └─────────────┘ ``` ## Examples | Example | Description | | ------------------------------------------------------------------------------- | --------------------------------------------------------- | | [clickhouse-observability-backend](https://github.com/kopai-app/kopai-mono/tree/HEAD/examples/clickhouse-observability-backend) | Docker Compose: OTEL Collector → ClickHouse → @kopai/api | | [ui-react-app](https://github.com/kopai-app/kopai-mono/tree/HEAD/examples/ui-react-app) | React SPA showing custom SDUI renderers on @kopai/ui-core | ## Development ```bash pnpm install pnpm build pnpm dev ``` ## Contributing See [CONTRIBUTING.md](https://github.com/kopai-app/kopai-mono/blob/HEAD/CONTRIBUTING.md). ## License Apache-2.0