原始内容
Quick Start
Run with
npx @kopai/app start
- send OpenTelemetry signals to localhost:4318 using HTTP
- inspect the data using
@kopai/cli - view traces, logs and metrics in your browser at localhost:8000
See: OpenTelemetry Demo App running with @kopai/app.
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 (dhi.io/node:24-debian13) and published automatically on each release.
Packages
| Package | Description | Version |
|---|---|---|
| @kopai/app | Local OTEL Backend | |
| @kopai/core | Core logic and types | |
| @kopai/sdk | SDK | |
| @kopai/cli | CLI tool | |
| @kopai/api | OTEL signals API | |
| @kopai/ui | Dashboard React components | |
| @kopai/ui-core | DOM-free SDUI primitives | |
| @kopai/collector | OTLP collector, HTTP only | |
| @kopai/sqlite-datasource | SQLite datasource | |
| @kopai/clickhouse-datasource | ClickHouse datasource | |
| @kopai/otel-testing-harness | In-process OTEL testing harness | |
| @kopai/tsconfig | Shared TypeScript config |
Dependency Graph
┌─────────────┐
│ tsconfig │
└──────▲──────┘
│
┌──────┴──────┐
┌────────────┬──────────────┤ core ├──────────────┬────────────┬──────────────┐
│ │ └──────▲──────┘ │ │ │
│ │ │ │ │ │
┌─────┴─────┐ ┌────┴────┐ ┌──────┴──────┐ ┌─────┴─────┐ ┌────┴─────┐ ┌──────┴─────┐
│ api │ │ ui │ │ sdk │ │ collector │ │ sqlite- │ │clickhouse- │
└─────▲─────┘ └────▲────┘ └──────▲──────┘ └─────▲─────┘ │datasource│ │ datasource │
│ │ │ │ └────▲─────┘ └────────────┘
│ │ ┌─────┴─────┐ │ │
│ │ │ cli │ │ │
│ │ └───────────┘ │ │
│ │ │ │
└────────────┴───────┬───────────────────────────────────┴────────────┘
│
┌──────┴──────┐
│ app │
└─────────────┘
Examples
| Example | Description |
|---|---|
| clickhouse-observability-backend | Docker Compose: OTEL Collector → ClickHouse → @kopai/api |
| ui-react-app | React SPA showing custom SDUI renderers on @kopai/ui-core |
Development
pnpm install
pnpm build
pnpm dev
Contributing
See CONTRIBUTING.md.
License
Apache-2.0