https://github.com/mathworks/adaptive-logging-utility

Logging and environment utilities for MATLAB coding
https://github.com/mathworks/adaptive-logging-utility

dtap log4j logging

Last synced: 3 months ago
JSON representation

Logging and environment utilities for MATLAB coding

• Host: GitHub
• URL: https://github.com/mathworks/adaptive-logging-utility
• Owner: mathworks
• License: other
• Created: 2020-11-23T21:18:55.000Z (about 4 years ago)
• Default Branch: develop
• Last Pushed: 2024-06-05T20:56:09.000Z (8 months ago)
• Last Synced: 2024-06-05T22:38:58.181Z (8 months ago)
• Topics: dtap, log4j, logging
• Language: MATLAB
• Homepage:
• Size: 164 KB
• Stars: 5
• Watchers: 4
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: license.txt
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# Adaptive-Logging-Utility

Logging and environment utilities for MATLAB coding

[![Open in MATLAB Online](https://www.mathworks.com/images/responsive/global/open-in-matlab-online.svg)](https://matlab.mathworks.com/open/github/v1?repo=mathworks/Adaptive-Logging-Utility)

NEEDS:

1. I want to be able to choose the amount of information displayed in the MATLAB Command Window during the execution of a MATLAB software.

2. This logging level should automatically adjust depending on whether the code is being developed or used in production.

3. I want to easily debug any error in my code.

4. I want to automatically disable some time-consuming defensive programming commands in production mode, once they've been validated in a test phase.

5. I want to allow the end user to switch to a defensive mode where more errors are detected during the execution.

SOLUTION:

- A log level is defined that follows the Log4j log levels: OFF/FATAL/ERROR/WARN/INFO/DEBUG/TRACE

  Reference: https://en.wikipedia.org/wiki/Log4j

- A environment mode is defined that follows the Development, Testing, Acceptance and Production (DTAP) standard with the 4 following environment modes: DEV/TEST/UAT/PROD

  Reference: https://en.wikipedia.org/wiki/Development,_testing,_acceptance_and_production

- The log level is automatically adjusted according to the environment mode.

  Examples:

  

  If the log level is WARN, then all FATAL, ERROR and WARN messages are enabled.

  

  In UAT mode, the minimal log level is WARN. So the log level cannot be set to OFF, FATAL or ERROR.

  

  In PROD mode, only WARN and INFO message can be displayed.

- In DEV mode, any error pauses the execution and switches MATLAB to debug mode.

- The FATAL message includes a logical expression whose execution is skipped in PROD mode.

EXAMPLE:

>> example

USER GUIDE:

The +devel package must be located in the package of the developed tool.

For example, +myTool/+devel

The Devel interface class must be updated so that myTool is replaced by the actual tool package name.