---
title: Generating performance reports with the Metal Performance HUD
framework: xcode
role: article
role_heading: Article
path: xcode/generating-performance-reports-with-metal-performance-hud
---

# Generating performance reports with the Metal Performance HUD

Record your app’s performance using the heads-up display.

## Overview

Overview With the Metal Performance HUD, you can generate performance reports for a specified duration to analyze your app’s performance over that interval. When report generation begins, the system resets all existing metrics, and the HUD automatically enables the performance insights feature. You can also enable other optional HUD features, such as Encoder GPU Time Tracking (see Understand encoder GPU time tracking), to add more metrics to the report. Generate performance reports You can trigger performance report generation from the global menu, where you select the desired duration. Report durations can range from 5 seconds to 30 minutes.

There’s a 3-second delay before the Metal Performance HUD resets all metrics, enables performance insights, and starts data collection.

After the duration elapses, the HUD saves the report to your app’s temporary folder. The system also lists reports in the menu and the insights configuration panel, with options to reveal the report in the Finder or open it directly.

You can also specify a path to save the performance report to by using the MTL_HUD_REPORT_URL environment variable. export MTL_HUD_REPORT_URL=<path>

Analyze and interpret the performance reports Each performance report contains a list of collapsable sections. The complete list is below:

## See Also

### Runtime diagnostics

- [Inspecting live resources at runtime](xcode/inspecting-live-resources-at-runtime.md)
- [Validating your app’s Metal API usage](xcode/validating-your-apps-metal-api-usage.md)
- [Validating your app’s Metal shader usage](xcode/validating-your-apps-metal-shader-usage.md)
- [Monitoring your Metal app’s graphics performance](xcode/monitoring-your-metal-apps-graphics-performance.md)
- [Customizing the Metal Performance HUD](xcode/customizing-metal-performance-hud.md)
- [Understanding the Metal Performance HUD metrics](xcode/understanding-metal-performance-hud-metrics.md)
- [Gaining performance insights with the Metal Performance HUD](xcode/gaining-performance-insights-with-metal-performance-hud.md)
