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 (オプション)#
  
  指定された場合、中間トレースファイルは、BrowserType.launch()で指定されたsetTracesDirディレクトリ内の、指定された名前のプレフィックスを持つファイルに保存されます。最終的なトレース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#
  
  指定された場合、中間トレースファイルは、BrowserType.launch()で指定されたsetTracesDirディレクトリ内の、指定された名前のプレフィックスを持つファイルに保存されます。最終的なトレース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