Skip to main content

Module record

Module record 

Source
Expand description

The performance record: every raw trial of one comparison, with the provenance needed to reproduce it.

packaging/performance/qualify.sh budget writes one directory per trial. assemble reads that layout into a PerformanceRecord, which is what is published and what evaluate judges.

<artifact-dir>/
  contract.json              the contract, copied before the first trial
  contract.sha256            its digest, as `sha256sum` printed it
  provenance.env             revisions, images, digests, settings
  host.env                   host resources
  trials/round-<r>/<side>/<cell>/
    order                    the trial's position in the run, from 1
    workload.json            BrokerPerformanceWorkload's result, if it finished
    workload.log             its stderr
    resources-before.txt     per-broker /proc snapshot before the trial
    resources-after.txt      the same snapshot after it

Structs§

Host
The host every trial ran on.
Measurement
What one completed workload measured.
PerformanceRecord
Every trial of one comparison and where it came from.
ProcessSample
One broker process in a resource snapshot.
Subject
One side’s exact build.
Trial
One raw trial.

Enums§

Side
Which side of the comparison a trial measured.
TrialOutcome
How a trial ended.

Functions§

assemble
Assemble the record of a qualify.sh budget artifact directory.
parse_env
Parse key=value lines. Blank lines and # comments are skipped; a repeated key is an error, so a snapshot cannot silently lose a value.
parse_host
Parse host.env.
parse_snapshot
Parse a resource snapshot: blocks that each open with pod=<name>.
resource_delta
Broker CPU seconds and summed peak RSS bytes between two snapshots.