Skip to main content

Module diagnostics

Module diagnostics 

Source
Expand description

Exports a support-friendly diagnostics bundle with sensitive local data redacted for privacy.

Copies recent log files, state snapshots, and environment summaries into a temporary directory. API keys, URLs, and filesystem paths are scrubbed before the bundle is presented to the user for attachment to issue reports.

Structsยง

RedactedConfigExport ๐Ÿ”’
Safe, fully redacted structural copy of Config for user privacy.
RedactedQueueEvent ๐Ÿ”’
Redacted view of a transfer event to avoid exposing private filenames.
RedactedRetryExport ๐Ÿ”’
Quantitative summaries of files waiting to be retried.
RedactedStateExport ๐Ÿ”’
Redacted snapshot of persistent app context status.
RedactedSyncIndexExport ๐Ÿ”’
Redacted metrics from the local synced database index.

Functionsยง

build_config_export ๐Ÿ”’
Populate redacted configuration statistics from live config values.
build_retry_export ๐Ÿ”’
Summarize items in the retry log without revealing their names.
build_state_export ๐Ÿ”’
Map live state values into redacted serialization format.
build_summary ๐Ÿ”’
Format system environment and configuration state as plain text.
build_sync_index_export ๐Ÿ”’
Summarize database index composition to avoid detailing private folder contents.
cache_path ๐Ÿ”’
Resolve a named file within the system cache root.
export_bundle
Primary entrypoint to create and export a redacted diagnostics zip/bundle folder.
export_bundle_with_paths ๐Ÿ”’
Helper that generates redactions by specifying explicit caches and data roots for testing.
redact_path_hint ๐Ÿ”’
Redact the absolute directory path, preserving only the trailing filename segment.
write_json_pretty ๐Ÿ”’
Helper to write formatted, indented JSON structures to disk.