puppeteer/docs/api/puppeteer.tracing.md
jrandolf f07ad2c661
fix: update documentation on configuring puppeteer ()
This PR updates the docs regarding configuring puppeteer. In addition,
some changes have been made to the documentation generator to show
default values on the documentation site.

Also fixes: https://github.com/puppeteer/puppeteer/pull/9144
2022-10-24 09:07:05 +02:00

35 lines
1.1 KiB
Markdown

---
sidebar_label: Tracing
---
# Tracing class
The Tracing class exposes the tracing audit interface.
#### Signature:
```typescript
export declare class Tracing
```
## Remarks
You can use `tracing.start` and `tracing.stop` to create a trace file which can be opened in Chrome DevTools or [timeline viewer](https://chromedevtools.github.io/timeline-viewer/).
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `Tracing` class.
## Example
```ts
await page.tracing.start({path: 'trace.json'});
await page.goto('https://www.google.com');
await page.tracing.stop();
```
## Methods
| Method | Modifiers | Description |
| ---------------------------------------------- | --------- | --------------------------------------------------------- |
| [start(options)](./puppeteer.tracing.start.md) | | Starts a trace for the current page. |
| [stop()](./puppeteer.tracing.stop.md) | | Stops a trace started with the <code>start</code> method. |