Reports
Both the Web and CLI interfaces generate reports. By default, the reports are generated in the $HOME/.hms-mirror/reports directory with the timestamp as the 'name' of the report. The report is directory of several files that include configurations, conversions, and job 'yaml' files of what was done. Each database has their own reports. The database name prefixes the report file name for the various reports.
From the CLI, you'll need to download the report directory to your local machine and use a 'Markdown' viewer to read it easily.
The Web interface has built in report viewing capabilities and makes it much easier to review the reports.
Output Directory
You can control where the reports are generated by using the -o <directory>
option. Default behavior is to use the $HOME/.hms-mirror/reports
directory. If you specify a different directory, the reports will be generated in the specific directory. If you use the -o <dir>
option with the Web Interface, the reports will be in that 'base directory' with a subdirectory of the timestamp of the report.
For the CLI, the report will be placed in the directory. If the directory exists, the report will be placed in an increment of that directory to avoid overwriting an existing report. EG: /my/report -> /my/report_1
Options
There are several views for the reports that include a detailed view of the process, workbooks for 'distcp', scripts for 'distcp' , job 'yaml' files, the configuration used to run the job, etc.
You have options to view all these reports within the Web Interface. You can further 'download' a zip file of the report contents and view them locally.
To keep things organized, there is an 'archive' option that will move the reports to an 'archive' directory. This is useful to help keep the reports directory clean and organized. If you need to view those reports again, you can always move them back to the reports directory. Although, that process is manual.