Tracing

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

注

おそらくcontext.tracingを使用する代わりに、設定ファイルでトレースを有効にすることをお勧めします。

context.tracing APIはブラウザの操作とネットワークアクティビティをキャプチャしますが、テストアサーション（expect呼び出しなど）は記録しません。Playwright Testの設定を通じてトレースを有効にすることをお勧めします。これにより、これらのアサーションが含まれ、テストの失敗をデバッグするためのより完全なトレースが提供されます。

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

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

トレースを開始します。

注

Tracing.startを使用する代わりに、設定ファイルでトレースを有効にすることをお勧めします。

context.tracing APIはブラウザの操作とネットワークアクティビティをキャプチャしますが、テストアサーション（expect呼び出しなど）は記録しません。Playwright Testの設定を通じてトレースを有効にすることをお勧めします。これにより、これらのアサーションが含まれ、テストの失敗をデバッグするためのより完全なトレースが提供されます。

使用法

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#