kopai-mono

内容来源:README.md(说明文档) · 原始地址 · 查看安装指南

原始内容

Kopai

OpenTelemetry observability backend in TypeScript running on Node.js


license Ask DeepWiki

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 npm
@kopai/core Core logic and types npm
@kopai/sdk SDK npm
@kopai/cli CLI tool npm
@kopai/api OTEL signals API npm
@kopai/ui Dashboard React components npm
@kopai/ui-core DOM-free SDUI primitives npm
@kopai/collector OTLP collector, HTTP only npm
@kopai/sqlite-datasource SQLite datasource npm
@kopai/clickhouse-datasource ClickHouse datasource npm
@kopai/otel-testing-harness In-process OTEL testing harness npm
@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