Operations Guide
Repeatable health, warm-up, benchmark, and performance-triage workflows for operators and agents.
Highest-value workflows:
- add warm-up before first speech
- preserve
clientIdin SDK initialization - benchmark warm performance with real audio
- read the local dashboard before speculating about latency
Recommended operator loop:
vox doctor
vox warmup start
vox transcribe bench /path/to/audio.wav 5
vox perf dashboard --client <integration>
vox doctorvox warmup startvox transcribe bench /path/to/audio.wav 5vox perf dashboard --client <integration>
Recommended client naming
Use stable product-surface IDs instead of per-user or per-session IDs:
vox-climenu-barbrowser-extensioneditor-plugin
This keeps dashboard slices meaningful over time.
Performance triage order
When a user reports that transcription feels slow:
- confirm whether the report is about hot-path inference or cold-path readiness
- inspect
inferenceMsbefore speculating about model quality - inspect
totalMsandmodelLoadMsto separate warm-up cost from steady-state cost - compare samples by
clientIdandroute
Contributor checklist
- keep
clientId,route, andmodelIdintact in telemetry - avoid hiding model lifecycle inside helpers that make latency opaque
- prefer repeatable file-based benchmarks before changing live-session behavior
See Observability for metric interpretation and Quickstart for installation recovery.