Resolve "Add a logging framework for command line output" (!106) · Merge Requests · dorie / dorie

Resolve "Add a logging framework for command line output"

What does this MR do?

Use loggers for the entire terminal output of DORiE.

Replace config keys verbose with logLevel, taking the same names as defined by spdlog
Rename setup_inifile.hh to setup.hh and add functions:
- Setup::init initializes the MPI helper, the config file, and the base logger
- Setup::debug_hook halts the program for a debugger to hook into the program
Add logger as optional argument to most classes, such that they use a certain logger by default or the one specified by the programmer
Add developer docs on how to use the loggers

Is there something that needs to be double checked?

All DUNE output (other than exceptions) is currently suppressed. One option would be to write a stream buffer, into which the output of functions like PDELab::mark_grid is stored. This storage could then be accessed and displayed via a logger at a certain log level setting.

Can this MR be accepted?

Implemented logging feature
Pipeline passing
Updated README.md with information on Git Submodule
Added entry to CHANGELOG.md

Related issues

Closes #92 (closed)

What does the new output look like?

Log levels on info:

Log levels on debug:

Log levels on trace:

with adaptivity

debug:

trace:

### What does this MR do?
Use loggers for the entire terminal output of DORiE.

* Replace config keys `verbose` with `logLevel`, taking the same names as defined by `spdlog`
* Rename `setup_inifile.hh` to `setup.hh` and add functions:
   - `Setup::init` initializes the MPI helper, the config file, and the base logger
   - `Setup::debug_hook` halts the program for a debugger to hook into the program
* Add logger as optional argument to most classes, such that they use a certain logger by default or the one specified by the programmer
* Add developer docs on how to use the loggers

### Is there something that needs to be double checked?

All DUNE output (other than exceptions) is currently suppressed. One option would be to write a stream buffer, into which the output of functions like `PDELab::mark_grid` is stored. This storage could then be accessed and displayed via a logger at a certain log level setting.

### Can this MR be accepted?
- [x] Implemented logging feature
- [x] Pipeline passing
- [x] Updated `README.md` with information on Git Submodule
- [x] Added entry to `CHANGELOG.md`

### Related issues

Closes #92

### What does the new output look like?

Log levels on `info`:

![Screen_Shot_2018-10-26_at_15.03.23](/uploads/8ade2c366fa31031a35945eeb37a033f/Screen_Shot_2018-10-26_at_15.03.23.png)

Log levels on `debug`:

![Screen_Shot_2018-10-26_at_15.37.26](/uploads/8c06e46d72c4f455ea951cbfcc43d73f/Screen_Shot_2018-10-26_at_15.37.26.png)

Log levels on `trace`:

![Screen_Shot_2018-10-26_at_15.39.52](/uploads/afd6ce004af0af4e0891c83b4c7540b3/Screen_Shot_2018-10-26_at_15.39.52.png)

#### with adaptivity

`debug`:

![Screen_Shot_2018-10-26_at_15.42.33](/uploads/41631cd16e83bfa3a2e354a747ac4d4b/Screen_Shot_2018-10-26_at_15.42.33.png)

`trace`:

![Screen_Shot_2018-10-26_at_15.43.12](/uploads/c93a07617ee632ecbec3ada485e3b9b8/Screen_Shot_2018-10-26_at_15.43.12.png)

Edited Nov 02, 2018 by Lukas Riedel