Observability
This page lists what IdentityFlow 0.3.0 tells you about running workflows and where to read it, so you can decide what to monitor.
IdentityFlow 0.3.0 exports no traces and no metrics. OTEL_* environment
variables have no effect, nothing listens on port 9464, and /metrics
answers 404.
For a single run, the record IdentityFlow keeps for every instance answers most questions:
- Current state and steps. The instance page,
/instances/<id>, shows the status and each step with its status and times. For operators, the Diagnostics section of the operations page counts errored steps and shows the instance’s message. See Operate running workflows. - Ordered events. The Audit tab lists every recorded event with the account that caused it. See Audit trail.
- The same data through GraphQL. The
operations,businessandauditviews return it to your own tools; see the GraphQL API reference. - Operational metrics. The Operations page shows the completion rate, the error rate and the number of finished instances.
The program writes its log to standard output and standard error. Collect it
with the process supervisor you run it under. The lines that show a normal
start are listed in
Install and run IdentityFlow.
A start that fails ends with the reason, for example
WF_DEFINITION_BUNDLE_CHANGED or WF_DATABASE_MIGRATION_MISMATCH.
To check from a monitoring system that the program is up, request
/auth/login without following redirects and expect 303, or 308 when
ORIGIN is not set. 0.3.0 has no
health endpoint.
When a Workflow Test fails, the message names the workflow, the step, the actor and the events in order, and leaves out parameters, dialog answers, event payloads, binding arguments and results, secrets, tokens and raw errors. You can paste it into an issue as it is. See Test workflows.
If you log or trace from your own bindings or hooks, keep credentials and external payloads out of those records. What you write to the console ends up in the program’s log.