Aias00 opened a new issue, #7936:
URL: https://github.com/apache/shenyu/issues/7936

   ## Goal
   Give operators a small, shareable diagnostic bundle for a selected gateway 
and time window so support investigations begin with consistent 
runtime/configuration context.
   
   ## Existing capabilities and boundary
   #7720 and PR #7878 link Admin to deployed metrics/log/trace backends. Reuse 
those links and runtime observations; this proposal exports a bounded support 
artifact rather than building another telemetry backend. Reuse #7718/#7719 
observations when available, preserving unknown/unsupported states.
   
   ## MVP
   - Add an authenticated, instance-scoped collection operation returning a 
manifest and an archive with build/plugin versions, effective non-secret 
configuration summaries/digests, sync connection/application state, observation 
timestamps and bounded connection/pool counters.
   - Include optional bounded thread information only when requested and 
authorized. Do not collect heap dumps, full traffic bodies or 
environment-variable dumps by default.
   - Run collectors with independent time/size budgets, cancellation and 
concurrency limits. Partial collection returns a useful bundle whose manifest 
identifies failed, stale, unsupported and truncated sections.
   - Apply a shared allowlist/redaction policy before archiving. Cover plugin 
configuration, URLs/query strings, headers, credentials, tokens and 
thread/error text; raw payload/config logging must not bypass it.
   - Define local download/temp-file cleanup and optional Admin coordination. 
Live gateway data must come through an authenticated supported management 
surface; Admin cannot claim to read a disconnected instance.
   
   ## Acceptance criteria
   - [ ] A fixture with seeded secrets in representative HTTP/AI/MCP and sync 
settings produces an archive with no seeded secrets or raw business bodies.
   - [ ] Total archive size, section size, collection duration and simultaneous 
jobs are bounded. Failed collectors do not hang other sections or gateway 
requests.
   - [ ] Namespace/instance permissions are enforced, collections are 
auditable, and archive names/entries cannot introduce traversal or arbitrary 
local-file reads.
   - [ ] Manifest records source instance/boot identity, software versions and 
per-section observation time; it does not imply an atomic cross-component 
snapshot.
   - [ ] Tests cover disconnected/legacy instances, cancellation, redaction 
failures, partial output, expiry and temporary-file cleanup.
   - [ ] Export/import documentation explains the format version and 
limitations; measure CPU/memory and request-latency impact with collection 
enabled.
   
   Related: #7720, PR #7878, #7718 and #7719. No default collection of 
high-volume logs/spans or new long-term telemetry storage.
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to