コンポジションのトレース

多くの場合、トレースはパフォーマンスの問題を初めて調査するときに最適な情報源です。これによって、何が問題であり、どこから調べ始めるべきかについて、仮説を立てることができます。

Android でサポートされているトレースには、システム トレースとメソッド トレースの 2 つのレベルがあります。

システム トレースは、特にトレース用にマークされた領域のみを追跡するため、オーバーヘッドが少なく、アプリのパフォーマンスに大きな影響を及ぼすことはありません。システム トレースは、コードの特定のセクションの実行にかかっている時間を確認するのに便利です。

メソッド トレースは、アプリのすべての関数呼び出しを追跡します。コストが非常に大きいため、アプリのパフォーマンスに大きく影響しますが、何が起こっているか、どの関数が呼び出されているか、どのくらいの頻度で呼び出されているかについて、全体像を把握できます。

デフォルトでは、システム トレースには個別のコンポーズ可能な関数は含まれません。メソッド トレースで使用できます。

現在、システム トレース内にコンポーズ可能な関数を表示するための新しいシステム トレース機能をテストしています。この機能により、システム トレースレベルの煩わしさの低さと、メソッド トレースレベルのコンポジションの詳細を実現できます。

コンポジションのトレースをセットアップする

プロジェクトで再コンポジションのトレースを試すには、少なくとも次のバージョンに更新する必要があります。

  • Android Studio Flamingo
  • Compose UI: 1.3.0
  • Compose Compiler: 1.3.0

トレースを実行するデバイスまたはエミュレータも、API レベル 30 以上である必要があります。

さらに、Compose Runtime Tracing に新しい依存関係を追加する必要があります。

implementation("androidx.compose.runtime:runtime-tracing:1.0.0-beta01")

この依存関係により、再コンポーズを含むシステム トレースを取得すると、コンポーズ可能な関数が自動的に表示されます。

システム トレースを行う

システム トレースを行い、新しい再コンポジションのトレースの実際の動作を確認する手順は次のとおりです。

  1. プロファイラを開きます。

    Android Studio - プロファイリングを開始する
    図 2. Android Studio - プロファイリングを開始する

  2. [CPU タイムライン] をクリックします。

    Android Studio Profiler - CPU のタイムライン
    図 3. Android Studio Profiler - CPU のタイムライン

  3. トレースする UI にアプリを移動し、[System Trace] と [Record] を選択します。

    トレース オプション - システム トレース
    図 4. トレース オプション - システム トレース

  4. アプリを使用すると、再コンポーズが行われ、記録が停止されます。トレースが処理されて表示されると、再コンポジションのトレースでコンポーザブルを確認できるようになります。キーボードとマウスを使用して、トレースでズームおよびパンできます。トレースの操作に慣れていない場合は、トレースを記録するのドキュメントをご覧ください。

    システム トレース
    図 5. システム トレース

    グラフ内のコンポーザブルをダブルクリックすると、そのソースコードに移動します。

  5. [Flame Chart] では、ファイルと行番号とともにコンポーザブルを確認することもできます。

    フレーム チャート
    図 6. フレーム チャート

注意点

APK サイズのオーバーヘッド

この機能のオーバーヘッドはできる限り最小限に抑えることを目指していましたが、Compose コンパイラによって APK に埋め込まれたトレース文字列により、Compose アプリの APK サイズが増加します。このサイズの増加は、アプリで Compose をあまり使用していない場合には比較的小さく、完全な Compose アプリでは大きくすることができます。さらに、これらのトレース文字列は難読化されないため、前述のようにトレースツールに表示されます。バージョン 1.3.0 以降では、Compose コンパイラによってすべてのアプリにそれらが挿入されます。

製品版ビルドでトレース文字列を削除するには、次の ProGuard ルールを追加します。

-assumenosideeffects public class androidx.compose.runtime.ComposerKt {

   boolean isTraceInProgress();

   void traceEventStart(int,int,int,java.lang.String);

   void traceEventStart(int,java.lang.String);

   void traceEventEnd();

}

これらの関数は将来変更される可能性がありますが、変更については、Compose のリリースノートに記載されます。

APK サイズのコストは発生しますが、これらを維持することにより、プロファイリングされる APK が、アプリユーザーによって実行される APK と同じであることが保証されます。

正確なタイミング

パフォーマンス テストと同様に正確なプロファイリングを行うには、プロファイル可能なアプリに従って、アプリを profileable と non-debuggable にする必要があります。

ターミナルからトレースをキャプチャする

ターミナルからコンポジション トレースをキャプチャできます。そのためには、Android Studio が通常行う通常の手順を自動的に行う必要があります。

依存関係を追加する

まず、アプリに依存関係を追加します。

implementation("androidx.tracing:tracing-perfetto:1.0.0")
implementation("androidx.tracing:tracing-perfetto-binary:1.0.0")

レコード コマンドを生成する

  1. Perfetto を使用してレコード コマンドを生成します。

  2. 次の例のように、track_event データソース セクションを手動で追加します。

    adb shell perfetto \
  -c - --txt \
  -o /data/misc/perfetto-traces/trace \
<<EOF
buffers: {
    size_kb: 63488
    fill_policy: RING_BUFFER
}
buffers: {
    size_kb: 2048
    fill_policy: RING_BUFFER
}
data_sources: {
    config {
        name: "track_event"
    }
}
duration_ms: 10000
flush_period_ms: 30000
incremental_state_config {
    clear_period_ms: 5000
}
EOF

トレースをキャプチャする

  1. アプリを起動して、トレースするセクションを準備します。

  2. ブロードキャストを発行して、アプリでトレースを有効にします。

    # set app package variable, e.g. com.google.samples.apps.nowinandroid.debug
# can be found through `adb shell ps -ef` or `adb shell cmd package list packages`
package=<your app process>

# issue a broadcast to enable tracing
adb shell am broadcast \
-a androidx.tracing.perfetto.action.ENABLE_TRACING \
$package/androidx.tracing.perfetto.TracingReceiver

  3. 以前に作成した録画コマンドを開始します。

トレースを開く

  1. adb pull <location>: デバイス（record コマンドで指定された場所）からのトレース。

  2. Perfetto で開きます。

Jetpack Macrobenchmark を使用してトレースをキャプチャする

トレースを結果として提供する Jetpack Macrobenchmark を使用してパフォーマンスを測定できます。macrobenchmark を使用してコンポジション トレースを有効にするには、次のことを行う必要があります。

  1. Macrobenchmark テスト モジュールに以下の依存関係を追加します。

    implementation("androidx.tracing:tracing-perfetto:1.0.0")
implementation("androidx.tracing:tracing-perfetto-binary:1.0.0")

  2. ベンチマークを実行する前に androidx.benchmark.fullTracing.enable=true インストルメンテーション引数を追加しました。Macrobenchmark インストルメンテーション引数の詳細については、Macrobenchmark インストルメンテーション引数をご覧ください。

フィードバック

この機能についてのフィードバック、バグ、ご要望がございましたら、ぜひお寄せください。Issue Tracker からフィードバックを送信できます。

前へ
レイアウトの検査