User Tools

Site Tools


code:open-source:hse-logger:overview

01 Overview

An OOP based logging system inspired by the Phython logging module.

It supports a simple API composed of five VIs (DEBUG.vi, INFO.vi, WARNING.vi, ERROR.vi and CRITICAL.vi) which can be just dropped on the block diagram and have only one required terminal, the log message. This simplicity makes it very easy to use them often and encourages the developer to log everything that could be of interest for monitoring the software.

The HSE Logger library is composed of interacting classes that make it easy to extend or modify the logger. A detailed description of the API can be found under API Reference.

We use the hse-logger in our DQMH-based applications for anything that has to do with the execution of the application. We use it to collect debug data. The logger is not used for data or events that are of interest to the user, and we do not use it for application data (like reports, exports, …).

Log Levels

Taken from https://docs.python.org/3/howto/logging.html#logging-basic-tutorial

Level When it’s used
DEBUG Detailed information, typically of interest only when diagnosing problems.
INFO Confirmation that things are working as expected.
WARNING An indication that something unexpected happened, or indicative of some problem in the near future (e.g. ‘disk space low’). The software is still working as expected.
ERROR Due to a more serious problem, the software has not been able to perform some function.
CRITICAL A serious error, indicating that the program itself may be unable to continue running.

Don't know where to start?
Look at our How to!

code/open-source/hse-logger/overview.txt · Last modified: 2024/03/05 09:13 by manuel.sebald