Skip to content

Commit 5c7e437

Browse files
authored
docs: clarify diagnostic exports and their separate controls (#30942)
1 parent 948f6b5 commit 5c7e437

1 file changed

Lines changed: 34 additions & 9 deletions

File tree

‎docs/user/telemetry.md‎

Lines changed: 34 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,23 +9,32 @@ permission mode, turn and request results, duration, release channel, and token
99
available. Child-agent token counts are reported separately from the main agent's. Model names
1010
are sent only when they appear in a provider's public model list.
1111

12-
Events do not include prompts, responses, file contents, authentication tokens, conversation IDs,
12+
Product events do not include prompts, responses, file contents, authentication tokens, conversation IDs,
1313
raw provider events, or child-agent output.
1414

15-
T3 Code also sends relay connection traces to Axiom to diagnose T3 Connect connectivity.
15+
## Relay connection diagnostics
1616

17-
To disable product events and relay tracing, set `T3CODE_TELEMETRY_ENABLED=false` in the server's
18-
environment before starting it. Relay tracing also stops when `T3CODE_OTEL_SDK_DISABLED` or
19-
`OTEL_SDK_DISABLED` turns OpenTelemetry export off. The web app in a browser, including one the
20-
`t3` CLI opens, does not read these variables.
17+
T3 Code sends relay connection traces to Axiom to diagnose T3 Connect connectivity. These are
18+
separate from product events. Depending on the client version, traces can include connection
19+
timings, environment identifiers and the connected machine's name. Failed spans can include error
20+
messages and stack traces; error text can quote a value the app was handling.
2121

22-
An administrator can turn product events and relay tracing off for every user on a machine with
23-
a [managed policy](./managed-policy.md#other-capabilities).
22+
To disable product events and relay tracing from the server, set
23+
`T3CODE_TELEMETRY_ENABLED=false` in its environment before starting it. Relay tracing also stops
24+
when `T3CODE_OTEL_SDK_DISABLED` or `OTEL_SDK_DISABLED` turns OpenTelemetry export off.
25+
26+
An administrator can turn product events and relay tracing off in the server and desktop app with
27+
a [managed policy](./managed-policy.md#other-capabilities). This does not control traces sent by
28+
separate browser or mobile clients.
2429

2530
The desktop app reads `T3CODE_TELEMETRY_ENABLED` from your shell profile (for example `~/.zshrc`) on macOS and
2631
Linux, so export it there and restart the app. On Windows, set it as a user environment variable.
2732

28-
## Mobile app crash reports
33+
The web app in a browser, including one the `t3` CLI opens, does not read these environment
34+
variables. When its build has relay tracing configured, it sends its own connection traces even
35+
if the server has opted out. The browser app has no relay tracing toggle.
36+
37+
## Mobile app diagnostics
2938

3039
When the iOS or Android app crashes or hits an error, it sends a report to T3 Code: the error
3140
message, the stack trace, the app version, and the device model and OS version. Each launch also
@@ -35,6 +44,22 @@ but an error message can quote a value the app was handling.
3544

3645
To stop sending them, turn off **Send crash reports** in **Settings > About T3 Code > Diagnostics**.
3746

47+
The mobile app also sends relay connection traces when its build has tracing configured. These
48+
carry an identifier for the current app session. **Send crash reports** does not control these
49+
traces, and the mobile app has no separate relay tracing toggle. Server environment variables and
50+
managed policy do not disable mobile tracing.
51+
52+
## Agent activity for mobile notifications
53+
54+
When **Publish agent activity** is enabled on a host, it sends project and thread titles, model
55+
names, activity status, and environment and thread identifiers to the T3 Connect relay for
56+
[mobile notifications and live activities](./mobile-notifications.md). This is separate from
57+
product events and relay diagnostics. The telemetry opt-out does not disable it.
58+
59+
To stop publishing, turn off **Publish agent activity** under **Settings > Sharing & access** on
60+
the host. Turning off notifications on a phone controls that phone's alerts, not the host's
61+
publishing setting.
62+
3863
## Export diagnostics to your own receiver
3964

4065
To send traces, metrics, or logs to an OpenTelemetry receiver, open

0 commit comments

Comments
 (0)