Skip to content

Commit 57b96eb

Browse files
Sayan-cursoragent
andcommitted
Address persona review: link data-handling, add event example
- Link the data-sensitivity section to Security and the DPA for encryption, retention, and processing rather than restating them. - Clarify that browser-activity categories produce far more events than operational ones, and that captured events are replayable via stream resume (not a separate query API). - Add a sample event envelope and document the 1 MB truncation behavior on the streaming page so pipeline builders know what to expect. - Reword "three shapes" to "three ways to configure it". Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent d936e2a commit 57b96eb

3 files changed

Lines changed: 18 additions & 4 deletions

File tree

browsers/telemetry/categories.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ For the full payload schema of any event type, see the [Stream telemetry events]
99

1010
## Browser activity
1111

12-
These categories report what's happening in the page. Capturing any of them attaches a Chrome DevTools Protocol (CDP) collector to the session, so enable only the ones you need. None are in the default set.
12+
These categories report what's happening in the page. Capturing any of them attaches a Chrome DevTools Protocol (CDP) collector to the session and produces far more events than the operational categories, so enable only the ones you need. None are in the default set.
1313

1414
| Category | Captures | Event types |
1515
| --- | --- | --- |
@@ -51,7 +51,7 @@ Telemetry is off by default, and the [default set](#operational) carries operati
5151
| `screenshot` | A full rendered image of the page - the broadest exposure, capturing anything visible on screen. |
5252
| `control`, `connection`, `system`, `captcha`, `monitor` | Session metadata only (control calls, connection and health events). No page content. |
5353

54-
Captured events are stored and retrievable through the API, so this sensitivity applies to the data at rest, not just the live stream. Treat captured telemetry - and anywhere you forward or store it - with the same care as the underlying content.
54+
Captured events are persisted and can be replayed by [resuming the stream](/browsers/telemetry/streaming#resuming-after-a-disconnect), so this sensitivity applies to the data at rest, not just the live stream. Treat captured telemetry - and anywhere you forward or store it - with the same care as the underlying content. For how Kernel encrypts, retains, and processes data overall, see [Security](/security) and the [Data Processing Addendum](/dpa).
5555

5656
Some exposure is reduced for you automatically: input into sensitive fields such as passwords is suppressed (`interaction_key` isn't emitted for them, and `interaction_click` omits the element text). Beyond that, because selection is opt-in, the most effective control is to capture only the categories you need - enable `network`, `console`, `page`, `interaction`, or `screenshot` deliberately, and prefer the operational categories when you only need session health.
5757

browsers/telemetry/overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Selection is **opt-in**. A session captures a category only if you explicitly tu
1313

1414
## Enabling telemetry
1515

16-
You configure telemetry when you [create a browser](/introduction/create) (and can change it later on update). There are exactly three shapes.
16+
You configure telemetry when you [create a browser](/introduction/create) (and can change it later on update). There are three ways to configure it.
1717

1818
### Enable the default set
1919

browsers/telemetry/streaming.mdx

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,21 @@ title: "Stream Telemetry"
33
description: "Consume a session's live telemetry stream from the SDK, CLI, or raw SSE"
44
---
55

6-
Once a session has telemetry [enabled](/browsers/telemetry/overview), you can stream its events in real time. The stream stays open until the session terminates, and each event is wrapped in an envelope with a monotonic `seq` number you can use to reconnect without gaps.
6+
Once a session has telemetry [enabled](/browsers/telemetry/overview), you can stream its events in real time. The stream stays open until the session terminates, and each event is wrapped in an envelope with a monotonic `seq` number you can use to reconnect without gaps:
7+
8+
```json
9+
{
10+
"seq": 42,
11+
"event": {
12+
"ts": 1746123456789000,
13+
"type": "network_response",
14+
"category": "network",
15+
"data": { "method": "GET", "url": "https://example.com/api", "status": 200 }
16+
}
17+
}
18+
```
19+
20+
The `data` payload differs per event type; see the [API reference](https://kernel.sh/docs/api-reference/browser-telemetry/stream-telemetry-events-via-sse) for each type's schema. An event whose payload exceeds 1 MB is dropped and the envelope is flagged `truncated: true`.
721

822
## Via SDK
923

0 commit comments

Comments
 (0)