Documentation
¶
Overview ¶
Command loadreport renders the pull request comment the CI load job posts when a load test fails. It reads the sample log written by hack/ci/cpu-sampler.sh and the plain-text summaries written by hack/ci/pprof-sampler.sh and hack/ci/pgstat-sampler.sh, and prints GitHub markdown on stdout: a CPU summary, a Mermaid chart of busy and steal over time, a chart of the top processes, and the two summaries folded into details sections.
go run ./hack/ci/loadreport -cpu cpu-samples.log \
-pprof pprof/summary.txt -pgstat pgstat/summary.txt \
-label "load (optimistic true, race false)" \
-repository hatchet-dev/hatchet -run-id 1 \
[-max-bytes 60000]
The summaries are optional and may be missing or empty. -repository and -run-id come from the workflow's own context and only build the link to the run; when either is missing or invalid the link is left out. Every file is untrusted and must be a regular file of at most 8 MiB; sanitize.go documents the policy. On any input error a short message goes to stderr, the exit code is 1 and nothing is written to stdout.
Source Files