Create a diagnostic snapshot

Create a diagnostic snapshotΒΆ

Fuel enables you to generate a diagnostic snapshot of your OpenStack environment to simplify troubleshooting. The diagnostic snapshot feature is available right after the Fuel Master node installs.

Fuel uses timmy, a diagnostic utility for OpenStack environments, to generate diagnostic snapshots through the Fuel web UI or CLI.

To create a diagnostic snapshot using the Fuel web UI:

  1. Log in to the Fuel web UI.
  2. Navigate to Support > Download Diagnostic Snapshot.
  3. Click Generate Diagnostic Snapshot.

By default, Fuel generates a diagnostic snapshot of all OpenStack nodes with log files updated in the last 3 days creating a .tar tarball with archives inside that becomes available for downloading once the generation of a snapshot completes successfully.

To create a diagnostic snapshot using the Fuel Master CLI:

  1. Log in to the Fuel Master CLI.

  2. Use the timmy command to create a snapshot:

    timmy
    

    The timmy command initiates the snapshot creation of all OpenStack nodes without log collection and according to default configuration.

    You can specify additional options for the timmy command.

    Examples:

    • Create a diagnostic snapshot according to default configuration but with log collection for a definite period of time in days:

      timmy --logs --days <NUM>
      

      Note

      If not specified, timmy collects log files updated in the last 30 days.

    • Run timmy on a particular OpenStack node:

      timmy --env <ENV_ID> --id <NODE_ID>
      
    • Run timmy on a particular node role:

      timmy --role <ROLE_NAME>
      
    • Specify a custom filename for the snapshot archive:

      timmy --dest-file <FILE_NAME>
      

      If log files are collected, they will be placed in the specified folder but as separate archives.

      Note

      By default, timmy creates a general.tar.gz snapshot and stores it in /tmp/timmy/archives.

Creative Commons Attribution 3.0 License

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.

Contents