search

ros2 / design

Design documentation for ROS 2.0 effort
http://design.ros2.org/
Apache License 2.0
224 stars 193 forks source link

Added initial version of logging.md file. #315

Open mlanting opened 3 years ago

mlanting commented 3 years ago

This PR is intended to address https://github.com/ros2/design/issues/314 and facilitate discussion around what we want the user experience to look like.

This is a work in progress as I'm still trying to understand some areas of the launch system so I can more completely and accurately describe the status quo, but I want to get something pushed out for people to start commenting on and providing suggestions or corrections.

mlanting commented 3 years ago

I added a new section at the beginning trying to break the issue down into a set of discrete interactions we want the logging system to support so we can then describe how each of those interactions should work. There's still plenty of detail to add, but I want to push out the "list of supported interactions" idea and my initial stab at breaking things down so others can weigh in.

esteve commented 2 years ago

@clalancette @christophebedard @mlanting what would be needed to continue with this document? Is there anything I can help with?

clalancette commented 2 years ago

@clalancette @christophebedard @mlanting what would be needed to continue with this document? Is there anything I can help with?

So we kind of went in a different direction here (which makes this document outdated, though not necessarily obsolete).

In particular, what we did is:

  1. Add end-user documentation to the documentation via https://github.com/ros2/ros2_documentation/pull/3025
  2. Do some performance work on the logging via https://github.com/ros2/rcutils/pull/367, https://github.com/ros2/rcutils/pull/369, https://github.com/ros2/rcutils/pull/370, https://github.com/ros2/rcutils/pull/372, https://github.com/ros2/rcutils/pull/374, and https://github.com/ros2/rcutils/pull/381
  3. Did some additional thinking about where we want the design to go in the future in https://github.com/ros2/rcl_logging/issues/92

With all of that said, I think where we want this document to go is to be documentation about the current design of logging, along with a future section where we lay out in more detail how we would accomplish https://github.com/ros2/rcl_logging/issues/92 . That way someone could pick it up and understand the current design, and then if they were motivated could implement the new design.