intentkit-dashboard
v1.0.0
Published
Observability dashboard for IntentKit — real-time telemetry visualization
Maintainers
Readme
intentkit-dashboard
Observability dashboard for IntentKit. Visualizes real-time telemetry from intentkit-observe in a dark-themed web UI with live feed, function stats, role breakdown, error tracking, and session replay.
Install
npm install intentkit-dashboard intentkit-observeUsage
import { createObserve } from 'intentkit-observe';
import { startDashboard } from 'intentkit-dashboard';
import { IntentRegistry } from 'intentkit';
const registry = new IntentRegistry();
const observe = createObserve({ storage: 'memory', capturePayloads: true });
registry.use(observe.middleware);
// ... register your functions ...
const dashboard = await startDashboard({
observe,
port: 4100,
serviceName: 'My Service',
});
console.log(`Dashboard: ${dashboard.url}`);
// Shutdown
dashboard.close();
await observe.destroy();Options
| Option | Type | Default | Description |
|--------|------|---------|-------------|
| observe | { query: ObserveQueryAPI } | required | The observe instance from createObserve() |
| port | number | 4100 | HTTP port for the dashboard |
| password | string | none | Basic auth password (optional) |
| serviceName | string | 'IntentKit' | Displayed in the dashboard header |
Dashboard Tabs
- Live Feed — Real-time table of recent function calls with expandable details
- Functions — Bar chart + sortable table with call counts, error rates, and latency percentiles
- Roles — Pie chart + table showing calls per role with function breakdown
- Errors — Error codes with counts, affected functions, and expandable recent details
- Session — Enter a Request ID to view the full call timeline for that session
API Endpoints
The dashboard also exposes JSON endpoints for programmatic access:
GET /api/stats— Function statisticsGET /api/calls?limit=50&function=&role=&status=— Recent callsGET /api/calls/:id— Single call detailsGET /api/roles— Role statisticsGET /api/errors— Error breakdownGET /api/session/:requestId— Session timeline
License
MIT
