Skip to content

docs: document structured logging and correlation fields #256

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
brain-marchine wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: document structured logging and correlation fields #256

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions docs/logging.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Structured logging

StableRoute backend uses request-scoped correlation via `X-Request-Id` (see
`docs/middleware-order.md`). Each handler calls `sendError` / `recordEvent` with
the active request id so operators can trace a single client call through audit
events and Prometheus gauges.

Recommended log fields when extending handlers:

- `requestId` — propagated from middleware
- `route` — Express path template
- `status` — HTTP status emitted
- `eventType` — audit log category when applicable

Pair and webhook mutations emit structured audit events (`pair.registered`,
`webhook.created`, etc.) rather than ad-hoc `console.log` output.