Skip to content

Latest commit

 

History

History
48 lines (33 loc) · 3 KB

Logging.md

File metadata and controls

48 lines (33 loc) · 3 KB
Raw

Logging

CORC relies on spdlog for all logging purpose. Two loggers are available:

Generic debug and information messages

This log is organised in several level of priorities: TRACE < DEBUG < INFO < WARN < ERROR < CRITICAL which are used in the following cases:

  • TRACE: reserved for CAN level information
  • DEBUG: any execution information relevant for debug purpose only
  • INFO: general execution information
  • WARN: general unexpected execution information (little use)
  • ERROR: any error not directly leading to termination
  • CRITICAL: error leading to termination

This log will produce outputs both on console (cout) and within a rotating log file (logs/CORC.log).

When compiling your application you can select the desired logging level in the CMakeLists.txt by setting CORC_LOGGING_LEVEL to one of the above value: keeping set(CORC_LOGGING_LEVEL INFO) (recommended level) will produce only INFO, WARN, ERROR and CRITICAL outputs for example.

To use this logger in your code, use one of the dedicated function depending on the desired level:

spdlog::trace("Trace log {}", my_value);
...
spdlog::critical("Critical error log {} => {}", my_critical_value, my_other_critical_value);

These functions are accessible at any point in CORC.

Note: Use this log wisely to not break the realtimness of the execution. It is also recommended to run CORC with a log level > INFO when trace and debug information are not required. For state logging, please prefere the dedicated logger described below.

State machine execution logging

This log allows you to record the states of the robot, sensors or any other application specific information at every iteration in a dedicated file. The logger is accessible in the state machine and should be initialised as follows within the MyCustomStateMachine::init()

    logHelper.initLogger("test_logger", "logs/logexample.csv", LogFormat::CSV, true);
    logHelper.add(robot_->getPosition(), "JointPositions");
    logHelper.add(robot_->getVelocity(), "JointVelocities");
    logHelper.add(robot_->getTorque(), "JointTorques");

This example will log the robot joint positions, velocities and torques in logs/logexample.csv at every loop execution.

The logger support any basic types and Eigen vectors. References to values to log should all be registered (using logHelper.add()) before starting the logger (at the start of the StateMachine) and these references should be valid during the entire StateMachine execution.

Additionnaly, custom logger can be created on the model of logHelper at any point of execution. In this case, the custom logger should be started using its startLogger() method and properly closed using endLog() method. Registered data to the custom logger would then be recorded at each call of the recordLogData() method between the start and end.

Note: implementation examples of the logHelper are available in all the demo StateMachines in apps folder.