Tracing

Playwrightトレースを収集および保存するためのAPI。Playwrightスクリプト実行後、トレースビューアでPlaywrightトレースを開くことができます。

アクションを実行する前にトレースの記録を開始します。最後に、トレースを停止してファイルに保存します。

Browser browser = chromium.launch();
BrowserContext context = browser.newContext();
context.tracing().start(new Tracing.StartOptions()
  .setScreenshots(true)
  .setSnapshots(true));
Page page = context.newPage();
page.navigate("https://playwright.dokyumento.jp");
context.tracing().stop(new Tracing.StopOptions()
  .setPath(Paths.get("trace.zip")));

メソッド

group

バージョン v1.49 で追加

tracing.group

注意

利用可能な場合は test.step を代わりに使用してください。

トレース内に新しいグループを作成し、Tracing.groupEnd() が呼び出されるまで、後続のAPI呼び出しをこのグループに割り当てます。グループはネストでき、トレースビューアに表示されます。

使用法

// All actions between group and groupEnd
// will be shown in the trace viewer as a group.
page.context().tracing().group("Open Playwright.dev > API");
page.navigate("https://playwright.dokyumento.jp/");
page.getByRole(AriaRole.LINK, new Page.GetByRoleOptions().setName("API")).click();
page.context().tracing().groupEnd();

引数

name String #

トレースビューアに表示されるグループ名。
options Tracing.GroupOptions (オプション)
- setLocation Location (オプション)#
  - setFile String
  - setLine int (オプション)
  - setColumn int (オプション)
  トレースビューアに表示されるグループのカスタムロケーションを指定します。デフォルトは Tracing.group() 呼び出しの場所です。

戻り値

void #

groupEnd

バージョン v1.49 で追加

tracing.groupEnd

Tracing.group() によって作成された最後のグループを閉じます。

使用法

Tracing.groupEnd();

戻り値

void #

start

バージョン v1.12 で追加

tracing.start

トレースを開始します。

使用法

context.tracing().start(new Tracing.StartOptions()
  .setScreenshots(true)
  .setSnapshots(true));
Page page = context.newPage();
page.navigate("https://playwright.dokyumento.jp");
context.tracing().stop(new Tracing.StopOptions()
  .setPath(Paths.get("trace.zip")));

引数

options Tracing.StartOptions (オプション)
- setName String (オプション)#
  
  指定された場合、中間トレースファイルは、setTracesDir ディレクトリ内の指定された名前プレフィックスを持つファイルに保存されます。BrowserType.launch() で指定します。最終的なトレースzipファイル名を指定するには、代わりに Tracing.stop() に path オプションを渡す必要があります。
- setScreenshots boolean (オプション)#
  
  トレース中にスクリーンショットをキャプチャするかどうか。スクリーンショットはタイムラインプレビューを構築するために使用されます。
- setSnapshots boolean (オプション)#
  
  このオプションがtrueの場合、トレースは
  - すべてのアクションでDOMスナップショットをキャプチャします
  - ネットワークアクティビティを記録します
- setSources boolean (オプション)バージョン v1.17 で追加#
  
  トレースアクションのソースファイルを含めるかどうか。アプリケーションのソースコードを含むディレクトリのリストは、PLAYWRIGHT_JAVA_SRC 環境変数で提供する必要があります（パスはWindowsでは ';'、他のプラットフォームでは ':' で区切る必要があります）。
- setTitle String (オプション)バージョン v1.17 で追加#
  
  トレースビューアに表示されるトレース名。

戻り値

void #

startChunk

バージョン v1.15 で追加

tracing.startChunk

新しいトレースチャンクを開始します。同じ BrowserContext 上で複数のトレースを記録する場合は、Tracing.start() を一度使用し、Tracing.startChunk() と Tracing.stopChunk() で複数のトレースチャンクを作成します。

使用法

context.tracing().start(new Tracing.StartOptions()
  .setScreenshots(true)
  .setSnapshots(true));
Page page = context.newPage();
page.navigate("https://playwright.dokyumento.jp");

context.tracing().startChunk();
page.getByText("Get Started").click();
// Everything between startChunk and stopChunk will be recorded in the trace.
context.tracing().stopChunk(new Tracing.StopChunkOptions()
  .setPath(Paths.get("trace1.zip")));

context.tracing().startChunk();
page.navigate("http://example.com");
// Save a second trace file with different actions.
context.tracing().stopChunk(new Tracing.StopChunkOptions()
  .setPath(Paths.get("trace2.zip")));

引数

options Tracing.StartChunkOptions (オプション)
- setName String (オプション)バージョン v1.32 で追加#
  
  指定された場合、中間トレースファイルは、setTracesDir ディレクトリ内の指定された名前プレフィックスを持つファイルに保存されます。BrowserType.launch() で指定します。最終的なトレースzipファイル名を指定するには、代わりに Tracing.stopChunk() に path オプションを渡す必要があります。
- setTitle String (オプション)バージョン v1.17 で追加#
  
  トレースビューアに表示されるトレース名。

戻り値

void #

stop

バージョン v1.12 で追加

tracing.stop

トレースを停止します。

使用法

Tracing.stop();
Tracing.stop(options);

引数

options Tracing.StopOptions (オプション)
- setPath Path (オプション)#
  
  指定されたパスのファイルにトレースをエクスポートします。

戻り値

void #

stopChunk

バージョン v1.15 で追加

tracing.stopChunk

トレースチャンクを停止します。複数のトレースチャンクの詳細については、Tracing.startChunk() を参照してください。

使用法

Tracing.stopChunk();
Tracing.stopChunk(options);

引数

options Tracing.StopChunkOptions (オプション)
- setPath Path (オプション)#
  
  最後の Tracing.startChunk() 呼び出し以降に収集されたトレースを指定されたパスのファイルにエクスポートします。

戻り値

void #

メソッド​

group​

groupEnd​

start​

startChunk​

stop​

stopChunk​

メソッド

group

groupEnd

start

startChunk

stop

stopChunk