This documentation is for a prerelease version of O3DE. Click here to switch to the latest release, or select a version from the dropdown.

Version:

Icon of a magnifying glass.
  Edit on GitHub

IN THIS ARTICLE

Performance Metrics Gathering in O3DE

Performance Metrics Gathering Explained

The Performance Metrics Gathering API in the Open 3D Engine (O3DE) provides a standardized API for gathering metrics relevant to for querying a feature system performance metrics. It provides a C++ interface for recording metrics based on the Google Trace Event Format via the Event Logger API. A Statistic collection API is provided via the Statistical Manager , which can record statistics over a period of frames and calculate higher level statistical results, including minimum, maximum, standard deviation, and variance. These two APIs are tied to the Performance Collector system, which encapsulates a Statistical Manager and a JSON trace Event Logger to record statistical metrics data to record gathered statistics to the Google Trace Event Format.

To learn how to use the Event Logger API in order to set up a JSON Trace Event Log into the Google Trace Event Format and preview the logs in a Chromium-based browser, read Recording using Json Trace Event Logger.