Migrate to the new vitals solution

Perfecto collects useful performance data for an open device or application. With the release of version 23.2, Perfecto introduces changes to the existing solution. The main differences are listed in the following table.

To prepare your automation tests for the new vitals solution, you need to take the following into account:

  • The API endpoint to retrieve vitals data has changed.

  • The format of the Vitals CSV file has changed. It includes different columns.

For instructions on how to use the new endpoint and to see a sample CSV file in the new format, see Vitals CSV file.

Restriction: Vitals collection is supported on devices running iOS 15 or later and Android 12 or later. Earlier versions may work as well but are not officially supported.

This feature is not currently supported in hybrid clouds.

Product area Old solution (until version 23.1) New solution (from version 23.2)

Manual Testing view

Perfecto only collects vitals and displays the Vitals panel in the right pane if you click the vitals icon in the open device toolbar.

Perfecto collects vitals by default. The Vitals panel is always available in the right pane, but you can minimize it if needed.

Manual Testing view

Downloading the vitals CSV file retrieves data from the last time you downloaded the file until the current moment. On first download, Perfecto retrieves data from the beginning of the session until the current moment.

Downloading the vitals CSV file always retrieves data from the beginning of the session until the current moment.

Manual Testing view

Perfecto does not display incident indicators.

Perfecto displays incident indicators on the vitals graph.

Insights

N/A

Perfecto displays an incident indicator in the History and trends widget if performance issues have been detected.

Report Library

N/A

Perfecto displays an incident indicator in the Statistic charts and in the test details table.

Single Test Report (STR)

Performance data is available as a Vitals CSV file that you can download by clicking the download icon and then selecting Vitals.

The file includes the following columns:

  • Timestamp

  • Formatted Timestamp

  • Memory Cache (KB)#Device

  • Network Out - Total - Delta (Bytes)#Device

  • Network Out - Total (Bytes)#Device

  • Network In - Total - Delta (Bytes)#Device

  • Network In - Total (Bytes)#Device

  • Memory Free (KB)#Device

  • CPU Total (%)#Device

  • Memory Used (KB)#Device

Perfecto displays an incident indicator in the report header as well as next to the relevant step or command. In addition, the Vitals graph is included below the video, along with incident indicators. Clicking a step on the left jumps to the relevant point on the video and Vitals graph timeline, and clicking a point on the timeline jumps to the corresponding step in the left pane.

Performance data is available as a Vitals CSV file that you can download by clicking the download icon and then selecting Vitals.

The file includes the following columns:

  • Timestamp

  • Formatted Timestamp

  • Relative Time

  • App Name

  • CPU (%)

  • MEMORY (MB)

  • NETWORK_IN (Mbps)

  • NETWORK_OUT (Mbps)

  • POWER (between 1 and 100)

If the file includes any lines without metrics, this means that no application was open on the device screen. Perfecto only collects vitals from the application running in the foreground.

Smart Reporting Public API

Vitals data is available as part of the execution driver report that you retrieved through the API endpoint URL https://<reporting-server>/export/api/v3/test-executions.

The report includes a link to the vitals report (CSV file) generated if the script activates the Start Vitals command.

The data retrieved includes the following columns:

  • Timestamp

  • Formatted Timestamp

  • Memory Cache (KB)#Device

  • Network Out - Total - Delta (Bytes)#Device

  • Network Out - Total (Bytes)#Device

  • Network In - Total - Delta (Bytes)#Device

  • Network In - Total (Bytes)#Device

  • Memory Free (KB)#Device

  • CPU Total (%)#Device

  • Memory Used (KB)#Device

Vitals data can be retrieved as a CSV file using a new API endpoint (URL: https://<your-cloud>.app.perfectomobile.com/export/api/v3/metrics/csv). )

For more information on retrieving the Vitals CSV file using the new endpoint, see Vitals CSV file.

The data retrieved includes the following columns:

  • Timestamp

  • Formatted Timestamp

  • Relative Timestamp

  • App Name

  • CPU (%)

  • MEMORY (MB)

  • NETWORK_IN (Mbps)

  • NETWORK_OUT (Mbps)

  • POWER (between 1 and 100)

If the file includes any lines without metrics, this means that no application was open on the device screen. Perfecto only collects vitals from the application running in the foreground.