Skip to content

Commit 8fefde3

Browse files
committed
docs(telemetry): voice pass on guides
1 parent 70f5a82 commit 8fefde3

3 files changed

Lines changed: 12 additions & 12 deletions

File tree

apps/website/content/docs/telemetry/guides/browser.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Browser Telemetry
22

3-
Browser telemetry is opt-in. If your Angular app never calls `provideThreadplaneTelemetry()`, the service has no enabled config and `capture()` returns without sending.
3+
Browser telemetry is opt-in. If your Angular app never calls `provideThreadplaneTelemetry()`, the service has no enabled config and `capture()` returns without sending anything.
44

55
## Configure
66

@@ -32,7 +32,7 @@ The endpoint receives:
3232
}
3333
```
3434

35-
The browser distinct ID is generated per service instance. The source does not write it to storage.
35+
The browser distinct ID is generated per service instance. The source never writes it to storage.
3636

3737
## Prefer a sink for app-owned analytics
3838

@@ -47,7 +47,7 @@ provideThreadplaneTelemetry({
4747
});
4848
```
4949

50-
When `sink` is present, the service does not use `endpoint` or PostHog.
50+
When `sink` is present, the service skips `endpoint` and PostHog entirely.
5151

5252
## Sampling
5353

@@ -89,4 +89,4 @@ telemetry.captureStreamErrored({ transport: 'langgraph', provider: 'openai', mod
8989

9090
Browser capture is wrapped in a `try/catch`. A sink error, fetch failure, or dynamic import failure is swallowed.
9191

92-
That keeps telemetry from becoming part of your application control flow.
92+
That keeps telemetry out of your application's control flow.

apps/website/content/docs/telemetry/guides/node.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Node Telemetry
22

3-
Node telemetry lives under `@threadplane/telemetry/node`. It is intended for package lifecycle hooks and server-side adapters.
3+
Node telemetry lives under `@threadplane/telemetry/node`. It's built for package lifecycle hooks and server-side adapters.
44

55
```ts
66
import {
@@ -23,7 +23,7 @@ import { disableTelemetry } from '@threadplane/telemetry/node';
2323
disableTelemetry();
2424
```
2525

26-
This sets an in-process flag. It does not mutate environment variables.
26+
This sets an in-process flag. It doesn't mutate environment variables.
2727

2828
## Capture runtime lifecycle
2929

@@ -70,7 +70,7 @@ await captureStreamErrored({
7070
});
7171
```
7272

73-
`captureStreamErrored()` records an error class. It does not send the full error object.
73+
`captureStreamErrored()` records an error class. It doesn't send the full error object.
7474

7575
## Ingest and sampling
7676

@@ -104,4 +104,4 @@ type CaptureResult =
104104
| { sent: false; reason: 'disabled' | 'sampled' | 'failed' };
105105
```
106106

107-
Use the result in tests or diagnostics. Do not make application correctness depend on telemetry delivery.
107+
Use the result in tests or diagnostics. Don't make application correctness depend on telemetry delivery.

apps/website/content/docs/telemetry/guides/privacy-and-opt-out.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Privacy and Opt-Out
22

3-
The telemetry source has two different privacy postures.
3+
The telemetry source has two distinct privacy postures.
44

55
Browser telemetry is off unless the app opts in. Node telemetry can send from package lifecycle hooks or server adapters unless the environment or process disables it.
66

@@ -46,15 +46,15 @@ provideThreadplaneTelemetry({ enabled: true, sink });
4646

4747
With `enabled: false` or no provider, browser capture no-ops.
4848

49-
The browser service sends only when application code or framework browser code calls its capture methods. It does not install a global listener.
49+
The browser service sends only when application code or framework browser code calls its capture methods. It never installs a global listener.
5050

5151
## Anonymous IDs
5252

5353
Node uses `anon_<uuid>` from `node:crypto` and caches it for the current process.
5454

5555
Browser endpoint delivery uses `browser:<uuid>` when `crypto.randomUUID()` is available, with a `Math.random()` fallback. The value is kept in the service instance.
5656

57-
The source does not persist either ID across process restarts or browser sessions.
57+
The source never persists either ID across process restarts or browser sessions.
5858

5959
## Data minimization from source
6060

@@ -64,7 +64,7 @@ Runtime lifecycle helpers send transport/provider/model style metadata. Stream e
6464

6565
The source strips `apiKey` in the Node runtime adapter before sending.
6666

67-
There is no source path that sends prompts, completions, message content, tool call arguments, tool call outputs, or environment variable dumps.
67+
No source path sends prompts, completions, message content, tool call arguments, tool call outputs, or environment variable dumps.
6868

6969
## Custom ingest
7070

0 commit comments

Comments
 (0)