[GH-ISSUE #5485] [Feature] Generate a redacted diagnostic report for support requests #3339

Open
opened 2026-10-31 00:39:19 +00:00 by bsakaguchi · 0 comments
Owner

Originally created by @jayykernel on GitHub (Oct 20, 2026).
Original GitHub issue: https://github.com/morluto/rea/issues/5485

Problem

When a setup or provider issue occurs, a useful report may require REA's version, Node/platform details, relevant readiness results, and selected provider versions. Collecting that context manually can lead to incomplete reports or accidental sharing of unrelated local details.

This differs from auditing an exported Evidence bundle for target secrets: the proposed report is about installation and diagnostic context, not target analysis content.

Proposed change

Add an opt-in command that generates a support report from version information and scoped readiness/doctor checks. Redact or omit sensitive values by default and show the report before it is written or copied.

Acceptance criteria

  • The report records the REA/runtime/platform versions and only the explicitly requested readiness checks.
  • Credentials, tokens, target paths, usernames, and arbitrary environment variables are excluded by default.
  • The command does not open targets or run an analysis provider unless a specific check explicitly requires it and the user approves.
  • The report includes a schema/version marker and can be saved as JSON.
  • Tests assert that representative secret-like values and private paths are not serialized.

This is a support-usability proposal, not a claim that current diagnostics leak secrets.

Originally created by @jayykernel on GitHub (Oct 20, 2026). Original GitHub issue: https://github.com/morluto/rea/issues/5485 ### Problem When a setup or provider issue occurs, a useful report may require REA's version, Node/platform details, relevant readiness results, and selected provider versions. Collecting that context manually can lead to incomplete reports or accidental sharing of unrelated local details. This differs from auditing an exported Evidence bundle for target secrets: the proposed report is about installation and diagnostic context, not target analysis content. ### Proposed change Add an opt-in command that generates a support report from version information and scoped readiness/doctor checks. Redact or omit sensitive values by default and show the report before it is written or copied. ### Acceptance criteria - The report records the REA/runtime/platform versions and only the explicitly requested readiness checks. - Credentials, tokens, target paths, usernames, and arbitrary environment variables are excluded by default. - The command does not open targets or run an analysis provider unless a specific check explicitly requires it and the user approves. - The report includes a schema/version marker and can be saved as JSON. - Tests assert that representative secret-like values and private paths are not serialized. This is a support-usability proposal, not a claim that current diagnostics leak secrets.
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
morluto/rea#3339
No description provided.