Quickstart
1. Run Vigie
bunx vigie --seed
That starts ClickHouse, ingest and the app on http://localhost:5310. ClickHouse comes from an installed binary, else Docker, else a downloaded binary. If a port is taken, Vigie uses the next free one and says so.
--seed sends a day of realistic telemetry from a made-up shop called Acme, so every page has something to show. Leave it out to start empty.
On your machine Vigie has no sign-in and only listens on 127.0.0.1. It loads ./definitions from the folder you run it in.
2. Connect your app
node ace add @vigiejs/adonis
npx @vigiejs/nestjs init
OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4318
The installers find the Vigie running on your machine, set up traces, write VIGIE_URL and VIGIE_KEY to .env, and send a test event. They only say "connected" once Vigie has accepted it.
3. Open a request
Start your app and call any route. Open Logs in Vigie: the request is there with its route, status, duration and trace. Click it to see the database queries it ran and the calls it made.
Next
- Adonis and NestJS: what the packages record, and how to add your own fields.
- Definitions: teach Vigie your app's words.
- Deploy: run it on a server for production.