Create docs page Reference/Logging

[DFriend01]

Purpose

Logging can mean the difference between knowing exactly what is happening in an application and having no idea what is going on. Creating good logs in our software, particularly with ROS, will be essential to debugging our application and providing context for each ROS node. The purpose of this new page is to provide guidance for some best practices when logging with ROS.

Page Tree

nav:
  ...
  - Reference:
    - Robot Operating System:
      - Logging:
        - Logging Best Practices: logging_best_practices.md
        - Logging with ROS: logging_with_ros.md

Topics

Logging Best Practices

This page will contain information on the best practices for logging information in general (not necessarily with ROS). It will cover topics like logging levels, what metadata to include to help with finding information and parsing, logging in a human-readable and a machine-readable (easy to parse) way, diagnostic information, and other topics of the like.

Logging with ROS

This page will contain information on the best practices when logging with ROS. This will cover more specific information like logging static vs dynamic information, how often to log information and how much to log such that the user is not overwhelmed, and logging in the presence of multiple nodes and real time information. It will also quickly cover the logging tool that ROS provides.

Resources

Logging Best Practices

• https://levelup.gitconnected.com/9-logging-best-practices-da9457e33305
• https://www.dataset.com/blog/the-10-commandments-of-logging/
• https://medium.com/everything-full-stack/logging-best-practices-e26d0a3e2697

Logging with ROS

• https://jokane.net/agitr/agitr-letter-log.pdf

Logging Libraries

• https://docs.ros.org/en/humble/Tutorials/Demos/Logging-and-logger-configuration.html#logging
• https://docs.python.org/3/library/logging.html

[patrick-5546]

We should probably talk about these as well. From PATH June 8 meetings notes.

[patrick-5546]

In Python, ROS just builds on the Python logger: https://www.logicmonitor.com/blog/python-logging-levels-explained#logging-levels

[patrick-5546]

From https://ubcsailbot.atlassian.net/wiki/spaces/prjt22/pages/1936949250/2023W2+Software-Wide+Meeting+Notes