[Browser Rendering] Add session recording docs#29284
[Browser Rendering] Add session recording docs#29284omarmosid wants to merge 2 commits intoproductionfrom
Conversation
omarmosid
requested review from
a team,
ToriLindsay,
celso,
kathayl and
mchenco
as code owners
|
This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:
|
|
Preview URL: https://76b67db5.preview.developers.cloudflare.com Files with changes (up to 15) |
|
CI run failed: build logs |
|
|
||
| ## Enable session recording | ||
|
|
||
| Pass `recording: true` to `puppeteer.launch()` or `playwright.launch()`: |
There was a problem hiding this comment.
@omarmosid will this session recordings work for CDP? if so we should include
| The recording is finalized when the browser session closes — whether you call `browser.close()` explicitly, the session reaches its idle timeout, or the Worker terminates for any other reason. The recording is not available until after the session ends. | ||
| ::: | ||
|
|
||
| ## View recordings |
There was a problem hiding this comment.
will need to change to Runs instead of Logs
for the dash link, check with Visal to confirm if its just
| -H "Authorization: Bearer <API_TOKEN>" | ||
| ``` | ||
|
|
||
| A successful response returns the following fields: |
There was a problem hiding this comment.
i think typically we don't have a table showing response fields. typically its an example response in a code block
| | `endTime` | string | ISO timestamp when the recording ended. | | ||
| | `events` | object | rrweb events keyed by target ID. | | ||
|
|
||
| ## Replay a recording locally |
There was a problem hiding this comment.
dumb q - why might someone want to replay locally? bc they dont want to use our dash? does that mean they need to have downloaded the recording file?
|
|
||
| ## Limits | ||
|
|
||
| - Recording is opt-in. It is not enabled by default. |
There was a problem hiding this comment.
we should mention it's opt-in in the intro!
6 participants
Summary
src/content/docs/browser-rendering/features/session-recording.mdx, a new how-to page documenting the session recording feature for Browser Renderingrecording: trueonlaunch()(Puppeteer and Playwright), viewing recordings in the dashboard, retrieving recordings via the API, replaying locally with rrweb-player, platform limits, and rrweb-specific limitationsWhat's new
## Enable session recording—launch()code examples for Puppeteer and Playwright, with a note that recordings are finalized on session close## View recordings— dashboard link to Browser Rendering > Logs## Retrieve a recording via API—GET /recording/:sessionIdcurl example and response field table## Replay a recording locally— collapsible note on rrweb-player compatibility## Limits— opt-in,launch()only, 2-hour max## rrweb limitations— canvas, cross-origin iframes, video/audio, WebGL, masked input fields, large pages