Skip to content

docs: clarify diagnostic exports and their separate controls - #30942

Open
Mr-Neutr0n wants to merge 1 commit into
pingdotgg:mainfrom
Mr-Neutr0n:docs/diagnostic-export-controls
Open

Mr-Neutr0n wants to merge 1 commit into
pingdotgg:mainfrom
Mr-Neutr0n:docs/diagnostic-export-controls

Conversation

@Mr-Neutr0n

@Mr-Neutr0n Mr-Neutr0n commented Nov 4, 2026 •

Copy link
Copy Markdown

The telemetry guide describes a server opt-out and a mobile crash-report switch, but those controls do not stop the independent browser/mobile relay exporters or host activity publishing. Readers cannot tell which data flow a control actually governs.

Clarify the separate relay diagnostic payload and controls, mobile tracing versus crash reports, and activity publishing for notifications. Link the existing notification guide and explain how to stop host publishing. This documents existing behavior and introduces no setting or collection change.

Related: #27077 and #27424 propose product-analytics controls. This PR focuses on the independent diagnostic and notification paths; it does not implement their settings or rewrite the analytics identity policy. #30940 separately removes the explicit machine-label attribute from future relay connection spans, while already-shipped clients can still send it.

Validation:

  • Cross-checked against the browser tracing resolver, mobile tracing and crash-report layers, relay error serialization, activity payload, and host publishing control.
  • vp run check:changed passes the documentation formatting check. No executable files changed.
  • git diff --check passes.

Model: GPT-6.1 Sol. Harness: Codex in T3 Code.

@github-actions github-actions Bot added vouch:unvouched PR author is not yet trusted in the VOUCHED list. size:M 30-99 changed lines (additions + deletions). labels Nov 4, 2026
@macroscopeapp

macroscopeapp Bot commented Nov 4, 2026

Copy link
Copy Markdown
Contributor

Approvability

Verdict: Approved at 4ebe4ba

Macroscope's review found this PR approvable — This documentation update distinguishes product telemetry, relay diagnostics, and notification activity publishing, including their separate opt-out controls. It changes no runtime behavior or product defaults.

You can add or adjust custom eligibility rules. Learn more.

@coderabbitai

coderabbitai Bot commented Nov 4, 2026 •

Copy link
Copy Markdown
Contributor

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The telemetry guide now distinguishes product events from relay diagnostics, documents server, browser, and mobile tracing controls, and describes host-published agent activity data and its controls.

Changes: Telemetry documentation

Layer / File(s) Summary
Product events and relay tracing
docs/user/telemetry.md
The guide clarifies which data product events omit, describes relay diagnostic contents, and documents tracing behavior and controls for server, browser, and mobile clients.
Agent activity publishing
docs/user/telemetry.md
The guide describes the data sent for mobile notifications and live activities, how to stop host publishing, and the effect of phone notification settings.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Suggested reviewers: juliusmarminge, gabrielelpidio, macroscopeapp

Merge Risk: Minimal · up to 4ebe4

The documentation-only change is ready to merge.

Pre-merge checks: Passed 3 · Failed 1

Failed Failed checks: 1 warning

Check name Status Explanation Resolution
Description check Warning The description states the problem (telemetry guide implies server opt-out and mobile crash-report switch cover data flows they do not govern), and the change (clarify relay diagnostic payload and con… Add a Scope and approval section that links the triaged issue or the maintainer-approved discussion (with the approval comment). If no prior issue exists, explain why this docs-only clarification qualifies for an exemption. Use the template…
Passed Passed checks: 3 passed
Check name Status Explanation
Title check Passed The title clearly and concisely describes the main documentation change: clarifying diagnostic exports and their separate controls.
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Description check

Explanation

The description states the problem (telemetry guide implies server opt-out and mobile crash-report switch cover data flows they do not govern), and the change (clarify relay diagnostic payload and controls, separate mobile tracing from crash reports, document activity publishing and how to stop it). It states the change introduces no setting or collection change, lists related issues, and gives validation steps (cross-checks, check:changed docs formatting pass, git diff --check pass) and a model/harness attribution. The template's Problem and Change headings are not used as headings, and the template's Scope and approval section is absent: there is no linked triaged issue or maintainer approval for the docs direction, and no explanation of why the change qualifies without one. Verification is partly satisfied, since it reports checks run, but it reports only formatting checks and does not describe observed results for the changed behavior, and it does not state what could not be checked. The description is substantive and mostly complete on content, but the approval/scope requirement is unaddressed.

Resolution

Add a Scope and approval section that links the triaged issue or the maintainer-approved discussion (with the approval comment). If no prior issue exists, explain why this docs-only clarification qualifies for an exemption. Use the template headings (Problem, Change, Scope and approval, Verification). In Verification, state what the cross-checks showed for the changed documentation and note anything not checked. The model and harness attribution is already present and can stay at the end.

Finishing Touches
Generate unit tests (beta)
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Recent review info
Run configuration
Commits

Reviewing files that changed from the base of the PR and between 9e85538 and 4ebe4ba.

Files selected for processing: 1
  • docs/user/telemetry.md

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 7 remain after this review.

@Mr-Neutr0n

Copy link
Copy Markdown
Author

Thanks for keeping the docs open to contributions. Hope this makes the different telemetry controls a little easier to understand.

@Mr-Neutr0n

Copy link
Copy Markdown
Author

Added the attribution to the PR description to match the repository convention. Model: GPT-6.1 Sol. Harness: Codex in T3 Code.

@maria-rcks

Copy link
Copy Markdown
Collaborator

Note

Written by gpt-6.1-sol on behalf of Maria

Verified in a real dev environment

  • Reproduced the main behavior in an isolated github/main worktree and ran a real Codex gpt-6.1-sol turn through the web client. The provider returned diagnostic verification ready.
  • Checked the PR head 4ebe4ba8cd1efab2c23be3d663778db9acef4288 in an isolated dev server. The same real Codex turn returned successfully.
  • Opened Maintenance > Diagnostics > OpenTelemetry export and used a real local OTLP receiver. Test requests for traces, metrics, and logs returned Connected and the receiver recorded empty exports at /v1/traces, /v1/metrics, and /v1/logs.
  • The PR is documentation-only, and the documented independent controls match the running source paths. No executable behavior changed.

main diagnostics

pr otlp export

Not verified

  • Mobile crash-report and relay tracing behavior, desktop-only managed policy behavior, and authenticated T3 Connect activity publishing require native clients or cloud relay credentials unavailable on this Linux VM.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size:M 30-99 changed lines (additions + deletions). vouch:unvouched PR author is not yet trusted in the VOUCHED list.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants