datastax-labs / sperf

Datastax Enterprise and Apache Cassandra diagnostic tooling from DataStax
https://datastax-toolkit.github.io/sperf/
Apache License 2.0
17 stars 14 forks source link

Add date/time formatting examples to help screens #51

Closed BrandonBordeaux closed 4 years ago

BrandonBordeaux commented 4 years ago

For the features where you can specify -st and -et` options for start and end date/time, the related help screens need formatting examples. For example:

$ sperf core statuslogger -h
usage: sperf core statuslogger [-h] [-r [REPORTER]] [-s [STAGES]]
                               [-st [START]] [-et [END]]
                               [-dl DEBUG_LOG_PREFIX] [-sl SYSTEM_LOG_PREFIX]
                               [-f FILES] [-d DIAG_DIR]

optional arguments:
  -h, --help            show this help message and exit
  -r [REPORTER], --reporter [REPORTER]
                        report to run, either summary or histogram (default summary)
  -s [STAGES], --stages [STAGES]
                        csv list of stage prefixes to collect, or 'all' (default: all)
  -st [START], --start [START]
                        start date/time to begin parsing (format: YYYY-MM-DD hh:mm:ss,sss)  <--
  -et [END], --end [END]
                        end date/time to stop parsing (format: YYYY-MM-DD hh:mm:ss,sss)  <--
  -dl DEBUG_LOG_PREFIX, --debug_log_prefix DEBUG_LOG_PREFIX
                        if debug.log in the diag tarball has an oddball name, can still look based on this prefix (default "debug.log")
  -sl SYSTEM_LOG_PREFIX, --system_log_prefix SYSTEM_LOG_PREFIX
                        if system.log in the diag tarball has an oddball name, can still look based on this prefix (default "system.log")
  -f FILES, --files FILES
                        comma separated file list to compare. Alternative to --diagdir
  -d DIAG_DIR, --diagdir DIAG_DIR
                        where the diag tarball directory is exported, should be where the nodes folder is located (default ".")
rsds143 commented 4 years ago

good request, need someone to help with this or it'll be a bit before I can get to it.