Verbose Simulation Output #295
Conversation
By default, the simulation output was already verbose by printing logs for each node to separate files and printing simulation output to a file. This change makes verbose no longer default and adds an option to do verbose logging output.
| @@ -26,6 +26,7 @@ import ( | |||
| var ( | |||
| simulationFile = flag.StringP("simulation-file", "f", "./simulation_plan.json", "file path to read simulation config from") | |||
| outputDirectory = flag.StringP("output-directory", "o", "./simulation_plan_logs", "directory path to output log files") | |||
| verbose = flag.BoolP("verbose", "v", false, "make output verbose (prints logs to output directory)") | |||
There was a problem hiding this comment.
What about having 2 flags here:
- log level (info/debug/warn/error/none)
- log output (, "." for outputDirectory or none for CLI)
- i.e. to have the output directory as a base dir
There was a problem hiding this comment.
Adding level adds a good bit of scope because then one would need to decide what to log at each level. I think for now, to keep it simple, it should just be verbose (development logs) and not verbose (CI output).
The default directory is ./simulation_plan_logs right now to make sure the output does not get included in git commits. This directory is included in .gitignore to help developers keep commits clean of any accidents. We could change it to the base directory, but then we need to update .gitignore as well.
There was a problem hiding this comment.
Our development logs are too informative so it might be hard to read, could have been better to have at least the level to let developers run with info or warn to get minimal output.
Regarding the the output, if we only enable to print logs to file system, it would be hard to understand issues in CI.
By printing to stdout we able to run anywhere while still being able to read the logs
By default, the simulation output was already verbose by printing logs for each node to separate files and printing simulation output to a file.
This change makes verbose no longer default and adds an option to do verbose logging output.