メインコンテンツへスキップ

Tracing

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

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

using var playwright = await Playwright.CreateAsync();
var browser = await playwright.Chromium.LaunchAsync();
await using var context = await browser.NewContextAsync();
await context.Tracing.StartAsync(new()
{
  Screenshots = true,
  Snapshots = true
});
var page = await context.NewPageAsync();
await page.GotoAsync("https://playwright.dokyumento.jp");
await context.Tracing.StopAsync(new()
{
  Path = "trace.zip"
});

メソッド​

GroupAsync​

追加バージョン: v1.49 tracing.GroupAsync
注意

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

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

使用法

// All actions between GroupAsync and GroupEndAsync
// will be shown in the trace viewer as a group.
await Page.Context.Tracing.GroupAsync("Open Playwright.dev > API");
await Page.GotoAsync("https://playwright.dokyumento.jp/");
await Page.GetByRole(AriaRole.Link, new() { Name = "API" }).ClickAsync();
await Page.Context.Tracing.GroupEndAsync();

引数

  • name string#

    トレースビューアーに表示されるグループ名。

  • options TracingGroupOptions? (任意)

    • Location Location? (任意)# トレースビューアーに表示されるグループのカスタム位置を指定します。Tracing.GroupAsync()呼び出しの位置がデフォルトです。

戻り値

GroupEndAsync​

追加バージョン: v1.49 tracing.GroupEndAsync

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

使用法

await Tracing.GroupEndAsync();

戻り値

StartAsync​

追加バージョン: v1.12 tracing.StartAsync

トレースを開始します。

使用法

using var playwright = await Playwright.CreateAsync();
var browser = await playwright.Chromium.LaunchAsync();
await using var context = await browser.NewContextAsync();
await context.Tracing.StartAsync(new()
{
  Screenshots = true,
  Snapshots = true
});
var page = await context.NewPageAsync();
await page.GotoAsync("https://playwright.dokyumento.jp");
await context.Tracing.StopAsync(new()
{
  Path = "trace.zip"
});

引数

  • options TracingStartOptions? (任意)

    • Name string? (任意)#

      指定された場合、中間トレースファイルは、BrowserType.LaunchAsync()で指定されたTracesDirディレクトリ内の、指定された名前のプレフィックスを持つファイルに保存されます。最終的なトレースzipファイル名を指定するには、代わりにTracing.StopAsync()にpathオプションを渡す必要があります。

    • Screenshots bool? (任意)#

      トレース中にスクリーンショットをキャプチャするかどうか。スクリーンショットはタイムラインのプレビュー作成に使用されます。

    • Snapshots bool? (任意)#

      このオプションがtrueの場合、トレースは

      • すべてのアクションでDOMスナップショットをキャプチャする
      • ネットワークアクティビティを記録する

    • Sources bool? (任意)追加バージョン: v1.17#

      トレースアクションのソースファイルを含めるかどうか。

    • Title string? (任意)追加バージョン: v1.17#

      トレースビューアーに表示されるトレース名。

戻り値

StartChunkAsync​

追加バージョン: v1.15 tracing.StartChunkAsync

新しいトレースチャンクを開始します。同じBrowserContextで複数のトレースを記録したい場合は、Tracing.StartAsync()を一度使用し、その後Tracing.StartChunkAsync()とTracing.StopChunkAsync()で複数のトレースチャンクを作成します。

使用法

using var playwright = await Playwright.CreateAsync();
var browser = await playwright.Chromium.LaunchAsync();
await using var context = await browser.NewContextAsync();
await context.Tracing.StartAsync(new()
{
  Screenshots = true,
  Snapshots = true
});
var page = await context.NewPageAsync();
await page.GotoAsync("https://playwright.dokyumento.jp");

await context.Tracing.StartChunkAsync();
await page.GetByText("Get Started").ClickAsync();
// Everything between StartChunkAsync and StopChunkAsync will be recorded in the trace.
await context.Tracing.StopChunkAsync(new()
{
  Path = "trace1.zip"
});

await context.Tracing.StartChunkAsync();
await page.GotoAsync("http://example.com");
// Save a second trace file with different actions.
await context.Tracing.StopChunkAsync(new()
{
  Path = "trace2.zip"
});

引数

  • options TracingStartChunkOptions? (任意)

    • Name string? (任意)追加バージョン: v1.32#

      指定された場合、中間トレースファイルは、BrowserType.LaunchAsync()で指定されたTracesDirディレクトリ内の、指定された名前のプレフィックスを持つファイルに保存されます。最終的なトレースzipファイル名を指定するには、代わりにTracing.StopChunkAsync()にpathオプションを渡す必要があります。

    • Title string? (任意)追加バージョン: v1.17#

      トレースビューアーに表示されるトレース名。

戻り値

StopAsync​

追加バージョン: v1.12 tracing.StopAsync

トレースを停止します。

使用法

await Tracing.StopAsync(options);

引数

  • options TracingStopOptions? (任意)

    • Path string? (任意)#

      指定されたパスにトレースをファイルとしてエクスポートします。

戻り値

StopChunkAsync​

追加バージョン: v1.15 tracing.StopChunkAsync

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

使用法

await Tracing.StopChunkAsync(options);

引数

  • options TracingStopChunkOptions? (任意)

    • Path string? (任意)#

      前回のTracing.StartChunkAsync()呼び出し以降に収集されたトレースを指定されたパスにファイルとしてエクスポートします。

戻り値