このページは Cloud Translation API によって翻訳されました。

パフォーマンスログ

ChromeDriver はパフォーマンスロギングをサポートしています。これにより、ドメイン「タイムライン」、「ネットワーク」、「ページ」のイベントと、指定したトレースカテゴリのトレースデータを取得できます。

パフォーマンスログを有効にする

パフォーマンスロギングはデフォルトでは有効になっていません。そのため、新しいセッションを作成するときに有効にする必要があります。

DesiredCapabilities cap = DesiredCapabilities.chrome();
LoggingPreferences logPrefs = new LoggingPreferences();
logPrefs.enable(LogType.PERFORMANCE, Level.ALL);
cap.setCapability(CapabilityType.LOGGING_PREFS, logPrefs);
RemoteWebDriver driver = new RemoteWebDriver(new URL("http://127.0.0.1:9515"), cap);

有効にすると、パフォーマンスログはタイムライン、ネットワーク、ページのイベントを収集します。トレースを有効にしたり、パフォーマンスロギングをカスタマイズしたりするには、読み進めてください。

Michael Klepikov が作成したデフォルトオプションを使用したパフォーマンスロギングの完全な例をご覧ください。

Angular Benchpress でもパフォーマンスロギングが使用されます。

トレースおよびカスタムロギング

パフォーマンスロギングをカスタマイズして、トレースを有効にする必要がある場合は、perfLoggingPrefs 機能（ChromeOptions 経由）を使用できます。トレースするには、1 つ以上の Chrome トレースカテゴリを指定します。詳しくは、Chrome トレースをご覧ください。

トレースが無効になっている場合、タイムラインドメインは暗黙的に無効になります。loggingPrefs 機能を使用してパフォーマンスログを有効にする必要があります。

DesiredCapabilities cap = DesiredCapabilities.chrome();
LoggingPreferences logPrefs = new LoggingPreferences();
logPrefs.enable(LogType.PERFORMANCE, Level.ALL);
cap.setCapability(CapabilityType.LOGGING_PREFS, logPrefs);
Map<String, Object> perfLogPrefs = new HashMap<String, Object>();
perfLogPrefs.put("traceCategories", "browser,devtools.timeline,devtools"); // comma-separated trace categories
ChromeOptions options = new ChromeOptions();
options.setExperimentalOption("perfLoggingPrefs", perfLogPrefs);
caps.setCapability(ChromeOptions.CAPABILITY, options);
RemoteWebDriver driver = new RemoteWebDriver(new URL("http://127.0.0.1:9515"), cap);

perfLoggingPrefs を使用して、ネットワークドメインとページドメインを個別に有効または無効にすることもできます。たとえば、トレース中にネットワークドメインを明示的に有効にできます。

...

Map<String, Object> perfLogPrefs = new HashMap<String, Object>();
perfLogPrefs.put("traceCategories", "browser,devtools.timeline,devtools");
perfLogPrefs.put("enableNetwork", true);
ChromeOptions options = new ChromeOptions();
options.setExperimentalOption("perfLoggingPrefs", perfLogPrefs);
caps.setCapability(ChromeOptions.CAPABILITY, options);

...

トレースが無効になっている場合、ChromeDriver は Chrome の起動時にブラウザ全体のトレースを行い、Chrome が閉じられるまでトレースを行います。トレースが実行されている間、Chrome はトレース停止までトレースイベントをメモリにバッファリングします。

トレースバッファがいっぱいになると、トレースイベントは記録されなくなります。バッファがいっぱいになって（トレースデータが失われる）ことを防ぐため、ChromeDriver は現在のトレースを定期的に停止し、バッファに格納されたイベントを収集し、テスト中の特定の時点でトレースを再開します。

トレースイベントの収集はテストのオーバーヘッドを増やす可能性があるため、ChromeDriver はテスト中の適切な時点でのみトレースイベントを収集します。トレースイベントは、ページナビゲーションイベントと、ChromeDriver ログ（パフォーマンスログなど）がリクエストされた場合にのみ収集されます。

バッファがいっぱいになる可能性は常にあるので、ChromeDriver はサポートされている Chrome バージョン（r263512 以降）のバッファ使用量をモニタリングします。バッファがいっぱいになると、ChromeDriver は警告をログに記録し、パフォーマンスログにエントリを追加します。

ログエントリを収集する

テストでは、パフォーマンスログエントリを取得できます。詳しくは、WebDriver ロギングドキュメントをご覧ください。

for (LogEntry entry : driver.manage().logs().get(LogType.PERFORMANCE)) {
  System.out.println(entry.toString());
}

各エントリは、次の構造の JSON 文字列です。

{
  "webview": <originating WebView ID>,
  "message": { "method": "...", "params": { ... }} // DevTools message.
}

method 値は、DevTools イベントのメソッドです。たとえば、タイムラインイベントには、バージョン 1.1（この記事の執筆時点での最新バージョン）までのすべてのバージョンのプロトコルで Timeline.eventRecorded というメソッドがあります。

トレースログエントリ

トレース機能は、バージョン 1.1 時点では公開されている DevTools プロトコルの一部ではないため、詳細はここで説明します。

すべてのトレースイベントのウェブビュー値は「ブラウザ」です。これは、イベントがブラウザ全体で収集されるためです。

トレースイベントの方法は 2 つあります。

tracing.dataCollected: params は、辞書形式の単一のトレーイベントです。
tracing.bufferUsage: params には、テスト中に DevTools トレースバッファがいっぱいになったことを示すメッセージを含む単一のエラーキーが含まれます。

トレースイベントの例を次に示します。

{
  "webview":"browser",
  "message":{
    "method":"Tracing.dataCollected",
    "params":{
      "args":{"layerTreeId":1},
      "cat":"cc,devtools",
      "name":"DrawFrame",
      "ph":"i",
      "pid":11405,
      "s":"t",
      "tid":11405,
      "ts":3846117219.0,
      "tts":1134680
    }
  }
}

パフォーマンス ログ