#19 Implement a Logging System with Configurable Log Levels

[Anonymous]

Originally created by: rifkybujana

Implement a Logging System with Configurable Log Levels

Description:
We need to create a logging system that allows for different levels of log visibility: show all logs, only show errors, and show warnings only. The logging level should be configurable using flags that can be passed as parameters when building the project with CMake.

Tasks:

1. Design the logging system:
2. Implement a logging system that supports different log levels:
   • Info: General information messages.
   • Warning: Potential issues that are not necessarily errors.
   • Error: Serious issues that could cause malfunctions.

3. Each log message should be timestamped and include the log level for easy identification.

4. Add CMake options for setting log level:

5. Add CMake options to control the logging level at build time:
   • LOG_LEVEL_ALL: Show all logs (Info, Warning, Error).
   • LOG_LEVEL_WARNING: Show only warnings and errors.
   • LOG_LEVEL_ERROR: Show only errors.

6. Set up default logging level if no flag is provided (e.g., LOG_LEVEL_ALL).

7. Modify the logging system to filter logs based on the specified level:

8. Implement filtering logic so that only logs matching the specified level are shown.

9. Ensure the logging system respects the selected log level and does not output messages below the configured threshold.

10. Configure CMake to accept log level flags as build parameters:

11. Modify the CMake configuration to allow setting the log level using flags like -DLOG_LEVEL_ALL, -DLOG_LEVEL_WARNING, or -DLOG_LEVEL_ERROR.

12. Pass the chosen log level as a preprocessor definition to the compiler.

13. Testing:

14. Test each log level configuration to ensure only the appropriate messages are displayed:
    • Test with LOG_LEVEL_ALL to verify that all messages (Info, Warning, Error) are shown.
    • Test with LOG_LEVEL_WARNING to confirm only warnings and errors appear.
    • Test with LOG_LEVEL_ERROR to ensure only error messages are displayed.

15. Test the CMake build process to ensure the flags work as intended and the logging level is correctly set at compile time.

16. Update documentation:

17. Document the logging system and the available log levels.
18. Update the CMake build instructions to include examples of how to set the log level using CMake flags.

Acceptance Criteria:

• The logging system supports three log levels: Info, Warning, and Error.
• CMake can be used to set the log level during the build process via flags.
• The system correctly filters log messages based on the configured log level.
• Documentation is updated with usage instructions for the logging system and build configuration.

Additional Context:

• The logging system should be lightweight and not introduce significant performance overhead.
• The default log level should be configurable in the CMake file to allow flexibility in different build configurations (e.g., Debug vs. Release).

[Anonymous]

• assigned_to: rifkybujana

[Anonymous]

Originally posted by: rifkybujana

Adding UI to these would be cool.

small popup window on the bottom right, containing messages for

• logs
• warnings
• errors
• process loading

[Anonymous]

Originally posted by: rifkybujana

https://github.com/patrickcjk/imgui-notify