Instruments プロファイリング (macOS/iOS)
このスキルは、ユーザーがネイティブアプリのパフォーマンスプロファイリングやスタック分析を必要とする場合に使用します。
焦点:Time Profiler、xctrace CLI、適切なバイナリ/アプリインスタンスの選択。
クイックスタート (CLI)
- テンプレート一覧表示:
xcrun xctrace list templates - Time Profiler 記録 (起動):
xcrun xctrace record --template 'Time Profiler' --time-limit 60s --output /tmp/App.trace --launch -- /path/To/App.app
- Time Profiler 記録 (アタッチ):
- アプリを自分で起動し、PID を取得して、次を実行:
xcrun xctrace record --template 'Time Profiler' --time-limit 60s --output /tmp/App.trace --attach <pid>
- Instruments でトレースを開く:
open -a Instruments /tmp/App.trace
注意:xcrun xctrace --help は有効なサブコマンドではありません。xcrun xctrace help record を使用してください。
正しいバイナリの選択 (重要)
注意点:Instruments が異なるアプリをプロファイルする可能性があります(例:LaunchServices が別のバンドルに解決された場合)。 以下のルールに従ってください:
- 確定的な起動のために、直接バイナリパスを優先:
xcrun xctrace record ... --launch -- /path/App.app/Contents/MacOS/App
.appを起動する場合は、意図したバンドルであることを確認:open -n /path/App.appps -p <pid> -o comm= -o command=で確認
/Applications/App.appとローカルビルドの両方が存在する場合、ローカルビルドのパスを明示的にターゲットにする。- 起動後、プロセスのパスを確認してからトレースを信頼する。
コマンド引数 (xctrace)
--template 'Time Profiler':xctrace list templatesのテンプレート名。--launch -- <cmd>:--以降はターゲットコマンド(バイナリまたはアプリバンドル)。--attach <pid|name>:実行中のプロセスにアタッチ。--output <path>:.trace出力。省略した場合、ファイルはカレントディレクトリに保存。--time-limit 60s|5m:キャプチャ時間を設定。--device <name|UDID>:iOS デバイス実行時に必須。--target-stdout -:起動したプロセスの標準出力をターミナルにストリーム(CLI ツールに便利)。
スタックのエクスポート (CLI)
- トレーステーブルの調査:
xcrun xctrace export --input /tmp/App.trace --toc
- 生のタイムプロファイルサンプルをエクスポート:
xcrun xctrace export --input /tmp/App.trace --xpath '/trace-toc/run[@number="1"]/data/table[@schema="time-profile"]' --output /tmp/time-profile.xml
- スクリプト(Python/Rust)で後処理し、スタックを集計。
Instruments UI ワークフロー
- テンプレート:Time Profiler
- 「Record」を使用し、遅いパスをキャプチャ(起動時 vs 定常状態)
- Call Tree のヒント:
- Hide System Libraries
- Invert Call Tree
- Separate by Thread
- ホットフレームとコール数に注目
注意点と修正
- 間違ったアプリがプロファイルされる:LaunchServices がインストール済みアプリをローカルビルドの代わりに解決する。
- 修正:直接バイナリパスを使用するか、既知の PID で
--attachを使用。
- 修正:直接バイナリパスを使用するか、既知の PID で
- サンプルが取得されない/空のトレース:アプリがすぐに終了するか、処理が実行されない。
- 修正:より長いキャプチャ時間、録画中にワークロードをトリガー。
- プライバシープロンプト:
xctraceに Developer Tools 権限が必要な場合がある。- 修正:システム設定 → プライバシーとセキュリティ → デベロッパツール → ターミナル/Xcode を許可。
- XML エクスポートが大きい:
time-profileエクスポートは巨大になる。- 修正:XPath でフィルタリングし、オフラインで集計。ターミナルに出力しない。
iOS 固有の注意事項
- デバイス:
xcrun xctrace list devicesと--device <UDID>を使用。 - 必要に応じて Xcode から起動し、
xctrace --attachでアタッチ。 - 意味のあるスタックを得るためにデバッグシンボルを確保。
確認チェックリスト
- トレースプロセスパスがターゲットビルドと一致することを確認。
- スタックに期待するアプリフレームが表示されていることを確認。
- キャプチャが遅い操作(起動/更新)をカバーしていること。
- 最適化時の自動差分比較のためにスタックをエクスポート。