Collect Log Files

If a server is no longer available or a critical issue occurred during processing, run the gather_logs.py script to collect MATRIXX files that can contain information relevant to the issue.

About this task

The gather_logs.py script collects all files in MTX_CONF_DIR, MTX_CUSTOM_DIR, and MTX_LOG_DIR (except the transaction_log files), and the output from the display_mtx_version.py script. It stores them in the specified ZIP file or specified directory. For more information about running gather_logs.py, see the discussion about gather_logs.py.

For more information about the MATRIXX environment variables, see the discussion about installation directories, navigation shortcuts, and environment variables in MATRIXX Installation and Upgrade.

Procedure

Run a run_cmd command, for example:
Server: 
run_cmd_on_blade.py -e engineId -b bladeId "gather_logs.py -o output_format -l label"

Where:

  • engineId — The ID of the MATRIXX Engine containing the target server or cluster. if not specified, the local cluster is used.
  • bladeId — The ID of the target server.
  • label — A string added to the output format that can be used to identify the content.
  • output_format — Is how the gathered files are stored: dir (directory) or zip (ZIP file). If the format is:
    • dir, the files are written to a directory in the user's home directory with the name mtx_logs_label_YYYY_mm_dd_hh_mm_ss.
    • zip, the files are stored in a ZIP file named mtx_logs_label_YYYY_mm_dd_hh_mm_ss.zip in the ~/home/user/mtx_logs_label directory.
    • If not specified, a zip file is created.

For more details, see the discussion about run_cmd_on_blade.py.

If you ran the script on a server, the output is saved to the user's home directory on that server.