Skip to main content

fidelity-kit benchmark

fidelity-kit benchmark​

Benchmark each workload once and save flat metrics

Usage​

fidelity-kit benchmark --registry <registry> [--out <out>] [--machine <machine>] [--new-run] [--session <session>] [--machine-name <machine-name>] [--renderer <renderer>]... [--scene <scene>]... [--renderers <renderers>] [--scenes <scenes>] [--headful] [--live] [--host <host>] [--port <port>] [--root-url <root-url>] [--collection <collection>] [--renderer-root <renderer-root>] [--renderer-port <renderer-port>] [--seed <seed>] [--cooldown-ms <cooldown-ms>] [--recycle <recycle>] [--width <width>] [--height <height>] [--isolation <isolation>] [--allow-software] [--executable-path <executable-path>] [--vsync <vsync>] [--chrome-arg <chrome-arg>]... [--fail-on-error]
FlagTypeRequiredDescription
--registrystringYesAliases: suite
--outstringNoDefault: performance-results
--machinestringNoMachine folder ID inside --out (defaults to a slug of the host name)
--new-runbooleanNoStart a new dated run without prompting
--sessionstringNoAdd to an existing YYYY-MM-DD-HH-MM run, or latest
--machine-namestringNoHuman-readable machine description saved to machine.json
--rendererstringNoRenderer ID glob(s), repeatable or comma separated; Variadic
--scenestringNoScene ID glob(s), repeatable or comma separated; Variadic
--renderersstringNoRenderer ID glob(s), comma separated; intersects --renderer
--scenesstringNoScene ID glob(s), comma separated; intersects --scene
--headfulbooleanNoDefault: false
--livebooleanNoDefault: false
--hoststringNoDefault: localhost
--portnumberNoDefault: 4400
--root-urlstringNoRoot URL of the browser render server
--collectionstringNoOpt-in performance collection in a unified suite
--renderer-rootstringNoStatic renderer directory served cross-site on 127.0.0.1
--renderer-portnumberNoDefault: 4401
--seednumberNo
--cooldown-msnumberNoDefault: 2000
--recyclenumberNoRecycle Chrome every N runs
--widthnumberNoDefault: 1920
--heightnumberNoDefault: 1080
--isolationstringNoIsolation mode; unified suites default to a fresh page for remote render hosts; Choices: iframe, page
--allow-softwarebooleanNoDefault: false
--executable-pathstringNo
--vsyncstringNoThroughput benchmarks require vsync off (recorded in each result); Choices: off
--chrome-argstringNoExtra Chrome flag, repeatable; use --chrome-arg=--flag (recorded in environment.chromeFlags); Variadic
--fail-on-errorbooleanNoDefault: true