create_event_files_from_txn_logs

The create_event_files_from_txn_logs script reads MATRIXX Engine transaction log files and creates an output file containing events from a given Global Transaction Counter (GTC) range. Use the -k option to recover events from Streamed Event Files (SEFs). The output filename is built to conform to the output format.

Syntax

CAUTION: When running this script, unless the transaction log file is located in the current directory (the default), you must specify the correct directory containing the transaction log file (specified by the -l [directory path] or --txn-log-directory [directory path] argument). Otherwise, the script fails.
create_event_files_from_txn_logs starting_GTC ending_GTC  [ -a ] [ -b id ] [ -c id ] [ -d ] [ -e id ] [ -f format ] [ -g file_path ][ -h ] [ i instance_id ] [ -k ] [ -l directory_path ]  [ -m ] [ -o directory_path ] [ -p ] [ -r GTC_range_size ] [ -s size ] [ -t ] [ -x compression_level ]

Options

starting_GTC
The lowest GTC to create an event file for. Typically, this is the lowest GTC from an error message listing GTCs that have not been converted to event files. That is, it is the first GTC that you know needs to be recovered.
ending_GTC
The highest GTC to recover. Typically, this is lowest GTC from the next (good) SEF file. That is, it is the highest GTC that you know has not been converted to an event file.
-a, --allow-invalid-gtc

A switch to generate MATRIXX Event Files (MEFs) from events marked as invalid in generated event files. This includes events missing GTCs. This is most useful for debugging. The default value is off.

-b, --blade-id id
The MATRIXX Engine pod ID. The default value is 1.
-c, --cluster-id id
The MATRIXX Engine cluster ID. The default value is 1.
-d, --debug
Debug flag. The default value is off. If this option is specified, extra messages are printed to aid in debugging.
-e, --engine-id id
The engine to collect data for. The default value is the engine the script is run on or the first engine.
-f, --output-format format
The output format. The default value is SEF. The options are:
  • MEF — MEF format.
  • MEFv2_CMDC — MEFv2 compact MDC format.
  • MEFv2_EXML — MEFv2 element XML format.
  • SEF — (Default) SEF format.
-g, --config-file file_path
The location of the output file. The default value is ./mtx_config.xml.
-h, --help
Help about options for this script.
-i, --instance_id id
The instance of the MATRIXX service for which to convert transaction logs to event files. The default value is 1.
-k, --use-sef-as-input
An option to recover MEFs from SEF files instead of from transaction logs.
Note: Do not use this option with the -p option. The -k option takes precedence over -p.
-l, --txn-log-directory directory_path
The name of the top-level directory containing the transaction logs subdirectory. It must be the directory that has the same structure as the shared directory. This is necessary because the script looks for transaction logs from all txnlogs/blade_x_x_x directories under the parent directory. The default value is the current directory ".".
CAUTION: When running this script, unless the transaction log file is located in the current directory (the default), you must specify the correct directory containing the transaction log file. This file is specified by the -l [directory path] or --txn-log-directory [directory path] argument. Otherwise, the script fails.
-m, --memory-debug
On option to turn on memory-debug mode and trace MtxBug gets and releases.
-o, --output-directory directory_path
The target directory for the output file. The default value is the current directory ".".
-p
An option to recover MEFs from late SEF files.
Note: Do not use this option with the -k option. The -k option takes precedence over -p.
-r, --range GTC_range_size
An option to specify the size of each recovered file. The default value is 0, which represents a single output file.
-t, --trace
An option to turn on trace logging. The default value is off.
-x, --compression-level [ 0 | 6 ]
An option to set the compression level to 0 or 6. The default value is 6.