tree: 79e27cb8a809566ef895f2f8ac0d971ef076662d [path history] [tgz]
  1. BUILD.gn
  2. OWNERS
  3. README.md
  4. converter.cc
  5. converter.h
  6. converter_unittest.cc
  7. main.cc
  8. meta/
garnet/bin/catapult_converter/README.md

Catapult performance results converter

This directory contains the catapult_converter command line tool which takes perf test results in our format and converts them to the Catapult Dashboard's JSON “HistogramSet” format.

Parameters

The Catapult dashboard requires the following parameters (called “diagnostics”) to be present in each HistogramSet that is uploaded to the dashboard:

  • pointId: This parameter is taken from the --execution-timestamp-ms argument. The dashboard uses this value to order results from different builds in a graph.

  • benchmarks: This parameter is taken from the test_suite field in the JSON input file. This usually has the prefix “fuchsia.”, e.g. “fuchsia.microbenchmarks”.

  • masters: The term “master” is an outdated term from when Buildbot was used by Chrome infrastructure. The convention now is to use the name of the bucket containing the builder for this parameter. Despite the name of the field, this field contains a single string.

    Examples: fuchsia.ci, fuchsia.global.ci

    These names appear as headings in the “Bot” dropdown menu on https://chromeperf.appspot.com/report.

  • bots: The term “bot” is an outdated term from when Buildbot was used by Chrome infrastructure. The convention now is to use the name of the builder for this parameter. Despite the name of the field, this field contains a single string.

    Examples: peridot-x64-perf-dawson_canyon (old name, which is to be dropped), fuchsia-x64-nuc (replacement name)

    These names appear as selectable entries in the “Bot” dropdown menu on https://chromeperf.appspot.com/report.

  • logUrls: This parameter is taken from the --log-url argument.

    This should contain a link to the LUCI build log page (or a page on any similar continuous integration system) for the build that produced the perf test results. The Catapult dashboard will show this link if you select a point on a performance results graph.

    Note: Although the converter requires the --log-url argument, the Catapult dashboard does not require the logUrls field in the HistogramSet data.

This is an optional parameter that the Catapult dashboard accepts:

  • a_productVersions: The system version, like ‘0.20200123.2.1’.

For more information on Catapult's format, see How to Write Metrics.