Skip to main content

Debug Manager

Manage Debug settings and create bounded diagnostic support bundles.

nimbus debug <command>
CommandDescription
listShow current Debug settings
export <path>Export Debug settings to a JSON file
import <path>Import Debug settings from a JSON file
download-bundle <path>Create a Debug support bundle ZIP at a local path on the agent
upload-bundle [--path <path>]Create a Debug support bundle ZIP and upload it to the configured cloud storage

Support-bundle selection options:

  • --from <time>: UTC lower bound in ISO-8601 or a relative value like "1 hour ago". Empty uses the agent default window.
  • --to <time>: UTC upper bound in ISO-8601, now, or a relative value like "5 minutes ago". Empty uses now.
  • --domains <ids>: comma-separated domain ids. Empty includes all support-bundle domains.
  • --limit <n>: structured diagnostic rows per domain. Zero uses the agent default.
  • --service-log-line-limit <n>: raw service-log lines. Zero uses the agent default.
  • --max-mb <n>: maximum bundle size in MB. Zero uses the agent default.

Supported support-bundle domains:

  • agent-structured-logs
  • agent-service-log
  • frontend-telemetry
  • memory-diagnostics
  • agent-lifecycle
  • agent-db-health

Autocomplete and inline help are driven by the DebugManagerService command registration and the support-bundle request parsers. Domain ids are free-form option values, so keep the documented domain list aligned with DebugSupportBundleService when adding new bundle domains.

Examples

# Show current Debug settings
nimbus debug list

# Export/import Debug settings
nimbus debug export /tmp/debug-settings.json
nimbus debug import /tmp/debug-settings.json

# Download a bundle with all domains using agent defaults
nimbus debug download-bundle /tmp/nimbus-debug-bundle.zip

# Download a bundle for the last hour
nimbus debug download-bundle /tmp/nimbus-debug-last-hour.zip --from "1 hour ago"

# Download only frontend telemetry for a specific UTC window
nimbus debug download-bundle /tmp/frontend-debug.zip \
--from 2026-06-16T08:00:00Z \
--to 2026-06-16T09:00:00Z \
--domains frontend-telemetry

# Download the largest bundle currently allowed for the default diagnostics window.
# Retention, enabled diagnostics, per-domain byte caps, row caps, and the hard bundle cap still apply.
nimbus debug download-bundle /tmp/nimbus-debug-bundle-max.zip \
--limit 20000 \
--service-log-line-limit 50000 \
--max-mb 256

# Download the largest bundle currently allowed for a known UTC incident window.
nimbus debug download-bundle /tmp/nimbus-debug-bundle-window.zip \
--from 2026-06-21T13:00:00Z \
--to 2026-06-21T14:00:00Z \
--limit 20000 \
--service-log-line-limit 50000 \
--max-mb 256

# Upload a temporary bundle to cloud and remove the temporary local file
nimbus debug upload-bundle

# Upload and retain a local copy at the requested path
nimbus debug upload-bundle --path /tmp/nimbus-debug-bundle.zip --max-mb 64