このページは 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 経由）。トレースを有効にするには、Chrome のトレースカテゴリを 1 つ以上指定します。詳しくは、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);

...

トレースが有効になっている場合、Chrome の起動時に ChromeDriver はブラウザ全体のトレースを開始し、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.
}

メソッド値は、DevTools イベントのメソッドです。たとえば、タイムラインイベントのメソッドは、バージョン 1.1 以前のすべてのプロトコルバージョン（作成時点の最新のバージョン）で Timeline.eventRecorded です。

トレースログエントリ

バージョン 1.1 では、公開済みの DevTools プロトコルにトレースは含まれていないため、ここではその詳細を説明します。

イベントはブラウザ全体で収集されるため、すべてのトレースイベントの WebView の値は「browser」になります。

利用可能なトレースイベントメソッドは次の 2 つです。

tracing.dataCollected: パラメータは、辞書形式の単一のトレースイベントです。
tracing.bufferUsage: パラメータには単一のエラーキーが含まれ、テスト中に 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
        }
    }
}

パフォーマンス ログ