[HDDS-2690] Improve the command usage of audit parser tool

• Type: Improvement
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 0.4.0
• Fix Version/s: 0.5.0
• Component/s: Tools
• Labels: pull-request-available
• Target Version/s: 0.5.0
• Assignee: Yi-Sheng Lien
• Reporter: Yiqun Lin
• Created: 07/Dec/19 15:59
• Updated: 24/Feb/20 20:55
• Resolved: 06/Jan/20 14:45

Description

I did the test for ozone-0.4, but found audit parser tool is not so friendly to use for user. I input -h option to get help usage, then only this few messages:

Usage: ozone auditparser [-hV] [--verbose] [-D=<String=String>]... <database>
                         [COMMAND]
Shell parser for Ozone Audit Logs
      <database>   Existing or new .db file
      --verbose    More verbose output. Show the stack trace of the errors.
  -D, --set=<String=String>

  -h, --help       Show this help message and exit.
  -V, --version    Print version information and exit.
Commands:
  load, l      Load ozone audit log files
  template, t  Execute template query
  query, q     Execute custom query

Although it shows me 3 options we can use, but I still not know the complete command to execute, like how to load audit to db, which available template I can use?

Then I have to get detailed usage from tool doc then come back to execute command, it's not effective to use. It will be better to add some necessary usage (table structure, available templates, ...)info in command usage.

Issue Links

• relates to: HDDS-393 Audit Parser tool for processing ozone audit logs
• links to: GitHub Pull Request #396