hmallen99
commented
1 month ago XCode Instruments
Profiling options
xctrace is the command line equivalent of XCode instruments. The tool allows us to generate data about game performance, memory leaks, CPU profiling. I.e. all the data we need to profile for a game engine. The tricky part of this will be hooking everything up to AWS device cloud.
man page: https://keith.github.io/xcode-man-pages/xctrace.1.html.
Finding an attached device
xcrun xctrace list devicesFinding supported templates
xcrun xctrace list templatesRecording with xctrace
Attaching xctrace to a running process:
xcrun xctrace record --template 'Time Profiler' --device-name 'iPhone 15 Pro Max Simulator' --attach ReactTestAppLaunching a process with xctrace:
xcrun xctrace record --template 'Time Profiler' --device-name 'iPhone 15 Pro Max Simulator' --launch ios/benchmarking-test-app.xcworkspaceThe generated profiles can be visualized in XCode instruments. We will also want to parse the data so that a pass/fail can be generated for the benchmark.
Problem
We want to profile real iOS devices in AWS device farm using XCode instruments. This is challenging, since we will need to run instruments from the command line and likely connect to a running XCode process from a test device. There are not any resources online of how to do this exactly.
Some possible ways to do this will be through Appium, which has support for XCode instruments, or by directly connecting an AWS mac to the device and running xctrace.
We will need to export the instruments trace for viewing and parse the trace to give the benchmark a pass/fail and upload to a GitHub page..