Tracing
Added in: v1.12API for collecting and saving Playwright traces. Playwright traces can be opened in Trace Viewer after Playwright script runs.
INFO
You probably want to enable tracing in your config file instead of using context.tracing.
The context.tracing API captures browser operations and network activity, but it doesn't record test assertions (like expect calls). We recommend enabling tracing through Playwright Test configuration, which includes those assertions and provides a more complete trace for debugging test failures.
Start recording a trace before performing actions. At the end, stop tracing and save it to a file.
browser = await chromium.launch()
context = await browser.new_context()
await context.tracing.start(screenshots=True, snapshots=True)
page = await context.new_page()
await page.goto("https://playwright.dev")
await context.tracing.stop(path = "trace.zip")browser = chromium.launch()
context = browser.new_context()
context.tracing.start(screenshots=True, snapshots=True)
page = context.new_page()
page.goto("https://playwright.dev")
context.tracing.stop(path = "trace.zip")Methods
tracing.group()
Added in: v1.49WARNING
Use test.step instead when available.
Creates a new group within the trace, assigning any subsequent API calls to this group, until tracing.group_end() is called. Groups can be nested and will be visible in the trace viewer.
Usage
# All actions between group and group_end
# will be shown in the trace viewer as a group.
page.context.tracing.group("Open Playwright.dev > API")
page.goto("https://playwright.dev/")
page.get_by_role("link", name="API").click()
page.context.tracing.group_end()# All actions between group and group_end
# will be shown in the trace viewer as a group.
await page.context.tracing.group("Open Playwright.dev > API")
await page.goto("https://playwright.dev/")
await page.get_by_role("link", name="API").click()
await page.context.tracing.group_end()Arguments
Group name shown in the trace viewer.
Specifies a custom location for the group to be shown in the trace viewer. Defaults to the location of the
tracing.group()call.filestringlineint(optional)columnint(optional)
Returns
Disposable
tracing.group_end()
Added in: v1.49Closes the last group created by tracing.group().
tracing.start()
Added in: v1.12Start tracing. Disposing the returned Disposable stops tracing without saving the trace, similarly to calling tracing.stop() without a path.
INFO
You probably want to enable tracing in your config file instead of using Tracing.start.
The context.tracing API captures browser operations and network activity, but it doesn't record test assertions (like expect calls). We recommend enabling tracing through Playwright Test configuration, which includes those assertions and provides a more complete trace for debugging test failures.
Usage
await context.tracing.start(screenshots=True, snapshots=True)
page = await context.new_page()
await page.goto("https://playwright.dev")
await context.tracing.stop(path = "trace.zip")context.tracing.start(screenshots=True, snapshots=True)
page = context.new_page()
page.goto("https://playwright.dev")
context.tracing.stop(path = "trace.zip")Arguments
aria_snapshotsboolean(optional) Added in: v1.63Whether to capture aria snapshot of the page on every action.
liveboolean(optional) Added in: v1.59When enabled, the trace is written to an unarchived file that is updated in real time as actions occur, instead of caching changes and archiving them into a zip file at the end. This is useful for live trace viewing during test execution.
If specified, intermediate trace files are going to be saved into the files with the given name prefix inside the
traces_dirdirectory specified inbrowser_type.launch(). To specify the final trace zip file name, you need to passpathoption totracing.stop()instead.screenshotsboolean(optional)Whether to capture screenshots during tracing. Screenshots are used to build a timeline preview.
screen_snapshotsboolean(optional) Added in: v1.63Whether to capture a screenshot of the page on every action.
Whether to capture DOM snapshot and record network activity on every action.
sourcesboolean(optional) Added in: v1.17Whether to include source files for trace actions.
titlestring(optional) Added in: v1.17Trace name to be shown in the Trace Viewer.
Returns
Disposable
tracing.start_chunk()
Added in: v1.15Start a new trace chunk. Disposing the returned Disposable stops the chunk without saving it, similarly to calling tracing.stop_chunk() without a path. If you'd like to record multiple traces on the same BrowserContext, use tracing.start() once, and then create multiple trace chunks with tracing.start_chunk() and tracing.stop_chunk().
Usage
await context.tracing.start(screenshots=True, snapshots=True)
page = await context.new_page()
await page.goto("https://playwright.dev")
await context.tracing.start_chunk()
await page.get_by_text("Get Started").click()
# Everything between start_chunk and stop_chunk will be recorded in the trace.
await context.tracing.stop_chunk(path = "trace1.zip")
await context.tracing.start_chunk()
await page.goto("http://example.com")
# Save a second trace file with different actions.
await context.tracing.stop_chunk(path = "trace2.zip")context.tracing.start(screenshots=True, snapshots=True)
page = context.new_page()
page.goto("https://playwright.dev")
context.tracing.start_chunk()
page.get_by_text("Get Started").click()
# Everything between start_chunk and stop_chunk will be recorded in the trace.
context.tracing.stop_chunk(path = "trace1.zip")
context.tracing.start_chunk()
page.goto("http://example.com")
# Save a second trace file with different actions.
context.tracing.stop_chunk(path = "trace2.zip")Arguments
namestring(optional) Added in: v1.32If specified, intermediate trace files are going to be saved into the files with the given name prefix inside the
traces_dirdirectory specified inbrowser_type.launch(). To specify the final trace zip file name, you need to passpathoption totracing.stop_chunk()instead.titlestring(optional) Added in: v1.17Trace name to be shown in the Trace Viewer.
Returns
Disposable
tracing.start_har()
Added in: v1.60Start recording a HAR (HTTP Archive) of network activity in this context. The HAR file is written to disk when tracing.stop_har() is called, or when the returned Disposable is disposed.
Only one HAR recording can be active at a time per Tracing instance.
Usage
await context.tracing.start_har("trace.har")
page = await context.new_page()
await page.goto("https://playwright.dev")
await context.tracing.stop_har()context.tracing.start_har("trace.har")
page = context.new_page()
page.goto("https://playwright.dev")
context.tracing.stop_har()Arguments
Path on the filesystem to write the HAR file to. If the file name ends with
.zip, the HAR is saved as a zip archive with response bodies attached as separate files.content"omit" | "embed" | "attach"(optional)Optional setting to control resource content management. If
omitis specified, content is not persisted. Ifattachis specified, resources are persisted as separate files or entries in the ZIP archive. Ifembedis specified, content is stored inline the HAR file as per HAR specification. Defaults toattachfor.zipoutput files and toembedfor all other file extensions.mode"full" | "minimal"(optional)When set to
minimal, only record information necessary for routing from HAR. This omits sizes, timing, page, cookies, security and other types of HAR information that are not used when replaying from HAR. Defaults tofull.url_filterstring | RegExp(optional)A glob or regex pattern to filter requests that are stored in the HAR. Defaults to none.
Returns
Disposable
tracing.stop()
Added in: v1.12Stop tracing.
Arguments
tracing.stop_chunk()
Added in: v1.15Stop the trace chunk. See tracing.start_chunk() for more details about multiple trace chunks.
Arguments
Export trace collected since the last
tracing.start_chunk()call into the file with the given path.
tracing.stop_har()
Added in: v1.60Stop HAR recording and save the HAR file to the path given to tracing.start_har().