Skip to content

feat(diagnostics): add sanitized configuration snapshot for troubleshooting (#695) - #743

Open
ravendevhub wants to merge 1 commit into
Core-Foundry:mainfrom
ravendevhub:feat/config-diagnostic-snapshot-695
Open

feat(diagnostics): add sanitized configuration snapshot for troubleshooting (#695)#743
ravendevhub wants to merge 1 commit into
Core-Foundry:mainfrom
ravendevhub:feat/config-diagnostic-snapshot-695

Conversation

@ravendevhub

Copy link
Copy Markdown

Summary

Resolves #695 by introducing a diagnostic configuration snapshot utility (listener/src/utils/config-snapshot.ts) enabling operators to inspect runtime environment settings, network parameters, contract configurations, and feature toggles while strictly redacting all secret keys, tokens, and credentials.

Changes

  1. Diagnostic Snapshot Generator (listener/src/utils/config-snapshot.ts):
    • Generates structured JSON representations of system environment, Stellar network RPCs, and feature flags.
    • Strictly redacts secret keys (S...), Discord webhook tokens, and API credentials.
  2. Automated Unit Tests (listener/src/utils/config-snapshot.test.ts):
    • Validates that serialization never leaks sensitive keys.
  3. Documentation (docs/CONFIGURATION_DIAGNOSTIC_SNAPSHOT.md):
    • Outlines schema structure and operational guarantees.

Acceptance Criteria

  • A diagnostic configuration representation is available.
  • Secrets are redacted.
  • Runtime network and feature settings are visible.
  • Sensitive values are never returned.

…ooting (Core-Foundry#695)

- Create createDiagnosticSnapshot generating security-hardened runtime metadata
- Ensure runtime network, contract bindings, and feature toggles are visible
- Guarantee zero secret key or webhook token leakage with strict redaction
- Add unit test in config-snapshot.test.ts and docs in docs/CONFIGURATION_DIAGNOSTIC_SNAPSHOT.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add Configuration Snapshot for Diagnostics

1 participant