Skip to main content

appliance-cli debug dump

Create a (compressed) snapshot of the tail of journald logs.

Synopsis​

Create a (compressed) snapshot of the tail of journald logs.

When using --use-journalctl, you can specify time ranges with --since and --until options. These options accept various time formats:

  • Absolute timestamps: "YYYY-MM-DD HH:MM:SS" (e.g., "2024-01-15 14:30:00")
  • Keywords: "yesterday", "today", "tomorrow", "now"
  • Relative times: "-1h" (1 hour ago), "+30m" (30 minutes from now)

For more details on time specifications, see:

appliance-cli debug dump [flags]

Examples​

  # Create a debug dump using the appliance API
  appliance-cli debug dump --output journal.export.zst --context host1.site1.org

  # Create a debug dump for the last hour using journalctl directly
  appliance-cli debug dump --use-journalctl --output journal.export.zst

  # Create a debug dump for a specific time range (absolute timestamps in UTC time)
  appliance-cli debug dump --use-journalctl --since "2024-01-15 14:00:00Z" --until "2024-01-15 15:00:00Z" --output journal.export.zst

  # Create a debug dump from yesterday until now
  appliance-cli debug dump --use-journalctl --since yesterday --output journal.export.zst

  # Create a debug dump for the last 2 hours
  appliance-cli debug dump --use-journalctl --since "-2h" --output journal.export.zst

  # Create a debug dump from 30 minutes ago until 5 minutes ago
  appliance-cli debug dump --use-journalctl --since "-30m" --until "-5m" --output journal.export.zst

Options​

      --context string    Select the appliance context
      --duration string   Length of the debug dump in terms of time duration. (default "1h")
  -h, --help              help for dump
      --insecure          Disable SSL verification
  -o, --output string     Location where the debug dump file is written to. (default "journal.export.zst")
      --since string      Only valid in conjunction with --use-journalctl. Will be passed through to journalctl (see journalctl(1)). If specified, no log messages contained in the output will have a timestamp older than the given threshold.
      --until string      Only valid in conjunction with --use-journalctl. Will be passed through to journalctl (see journalctl(1)). If specified, no log messages contained in the output will have a timestamp newer than the given threshold.
      --use-journalctl    Call out to journalctl directly to create the dump.

SEE ALSO​