-
Notifications
You must be signed in to change notification settings - Fork 4
Logging and Reporting
[Back to the overview of Concepts] (https://github.com/iks-github/MOGLiCodeCreator/wiki/Concepts)
MOGLiCC differentiates between logging for technical information and reporting for domain specific information as advised in the [Clean Coding Cosmos] (http://www.iks-gmbh.com/assets/downloads/iks-CleanCodingCosmos-Teil-1-4-OBJEKTspektrum3.pdf).
Technical information such as exceptions are written to log files. Each plugin writes into its own log file which is accessible via the MOGLiInfrastructure (see [Building Block View - Level 2] (https://github.com/iks-github/MOGLiCodeCreator/wiki/Building-Block-View)) provided by the core (the plugin container). The most important log file, however, belongs to the core and is named '_MOGLiCC.log'. All log files are located in the log subdirectory of the current workspace.
Each plugin writes a protocol with domain specific information about what it has done during the last execution. This information is collected from each plugin by the core and is combined to the generator report file for generator plugins and to the provider report file for provider plugins.
In addition, a short report exists for a quick overview about the most important information from all of the plugins about the last execution. It sums up the overall generation result. Finally, an error report file is created, if an error state has been detected. The error report helps to quickly find and fix the problem occurred.
The detailed generator report and provider report as well as the short report is stored in the report subdirectory of the current workspace. The error report - only created in an error case - is written in the MOGLiCC application root directory where the MOGLiCC start scripts are located.
[Back to the overview of Concepts] (https://github.com/iks-github/MOGLiCodeCreator/wiki/Concepts)