Skip to main content

Module builtins

Module builtins 

Source
Expand description

Built-in readout implementations.

Modules§

each_close
each_close — companion to scope_header for the on_each_end slot. Where scope_header opens an iteration with · {scope_name}, each_close closes it with the matching trailing marker.
error_readout
error_readout — phase-end error block.
metric
metric — the parameterised readout that surfaces workload-emphasised metrics (recall, latency, etc.).
phase_outcome
phase_outcome — the phase-end summary line.
phase_starting
phase_starting — opt-in pre-phase header. Push 2 removed the unconditional ▶ phase 'X' starting row from the live output; this readout brings it back as a workload-bound option, default-targetting on_phase_start.
phase_status
phase_status — the live-status readout.
phase_summary
phase_summary — the post-run summary line readout.
scope_close
scope_close — closing row for non-iteration scopes. Mirror of scope_open; bound by default to on_scope_end.
scope_header
scope_header — the · {scope_name} row that appears above each iteration of a for_each / for_combinations / do_while scope group.
scope_open
scope_open — opening row for non-iteration scopes (do_while, do_until, plain group blocks). Bound by default to on_scope_start.
session_banner
session_banner — the opening session row, default-bound to on_session_start (and re-used by the post-run summary’s first line, session: <name> (<workload>)).
session_notice
session_notice — the SRD-106 sticky-session announcement, seeded onto on_session_start by the runner when the stick_session rung re-attached the run to sessions/latest.
session_summary
session_summary — the session-level rollup line: phases: X completed, Y failed, Z not run (of N total).
trace
trace — a minimal diagnostic readout that surfaces every relevant ReadoutContext field as text for whatever event triggered it.
truncated_phases
truncated_phases — the (… and N more phases not listed) rollup that follows the post-run summary’s per-phase rows when the tail was truncated past a failure.