playwright/docs/src/api/class-tracing.md

73 lines
1.7 KiB
Markdown
Raw Normal View History

# class: Tracing
Tracing object for collecting test traces that can be opened using
Playwright CLI.
## async method: Tracing.export
Export trace into the file with the given name. Should be called after the
tracing has stopped.
### param: Tracing.export.path
- `path` <[path]>
File to save the trace into.
## async method: Tracing.start
Start tracing.
```js
await context.tracing.start({ name: 'trace', screenshots: true, snapshots: true });
const page = await context.newPage();
await page.goto('https://playwright.dev');
await context.tracing.stop();
await context.tracing.export('trace.zip');
```
```java
context.tracing.start(page, new Tracing.StartOptions()
.setName("trace")
.setScreenshots(true)
.setSnapshots(true);
Page page = context.newPage();
page.goto('https://playwright.dev');
context.tracing.stop();
context.tracing.export(Paths.get("trace.zip")))
```
```python async
await context.tracing.start(name="trace" screenshots=True snapshots=True)
await page.goto("https://playwright.dev")
await context.tracing.stop()
await context.tracing.export("trace.zip")
```
```python sync
context.tracing.start(name="trace" screenshots=True snapshots=True)
page.goto("https://playwright.dev")
context.tracing.stop()
context.tracing.export("trace.zip")
```
### option: Tracing.start.name
- `name` <[string]>
If specified, the trace is going to be saved into the file with the
given name.
### option: Tracing.start.screenshots
- `screenshots` <[boolean]>
Whether to capture screenshots during tracing. Screenshots are used to build
a timeline preview.
### option: Tracing.start.snapshots
- `snapshots` <[boolean]>
Whether to capture DOM snapshot on every action.
## async method: Tracing.stop
Stop tracing.