Tracing

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

注

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

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

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

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? (オプション)#

    • File string

    • Line int? (オプション)

    • Column int? (オプション)

    トレースビューアでグループを表示するカスタムロケーションを指定します。Tracing.GroupAsync()呼び出しのロケーションにデフォルト設定されます。

戻り値

• void#

---

GroupEndAsync

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

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

使用法

await Tracing.GroupEndAsync();

戻り値

• void#

---

StartAsync

追加日: v1.12 tracing.StartAsync

トレースを開始します。

注

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

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

使用法

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#

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

戻り値

• void#

---

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#

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

戻り値

• void#

---

StopAsync

追加日: v1.12 tracing.StopAsync

トレースを停止します。

使用法

await Tracing.StopAsync(options);

引数

• options TracingStopOptions? (オプション)

  • Path string? (オプション)#

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

戻り値

• void#

---

StopChunkAsync

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

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

使用法

await Tracing.StopChunkAsync(options);

引数

• options TracingStopChunkOptions? (オプション)

  • Path string? (オプション)#

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

戻り値

• void#