ros_comm: cpp_common | message_filters | perf_roscpp | rosbag | rosbagmigration | rosconsole | roscore_migration_rules | roscpp | roscpp_serialization | roscpp_traits | rosgraph | rosgraph_msgs | roslaunch | roslisp | rosmaster | rosmsg | rosnode | rosout | rosparam | rospy | rosservice | rostest | rostime | rostopic | roswtf | std_msgs | std_srvs | topic_tools | xmlrpcpp
Package Summary
System-wide logging mechanism for messages sent to the /rosout topic.
- Author: Josh Faust/jfaust@willowgarage.com
- License: BSD
- Repository: ros_comm
- Source: svn https://code.ros.org/svn/ros/stacks/ros_comm/tags/electric/tools/rosout
Contents
Overview
rosout is the name of the console log reporting mechanism in ROS. It can be thought as comprising several components:
The `rosout` node for subscribing, logging, and republishing the messages.
The /rosout topic
The /rosout_agg topic for subscribing to an aggregated feed
roslib/Log message type, which defines standard fields as well as verbosity levels.
client APIs to facilitate easy use of the rosout reporting mechanism
GUI tools, like rxconsole, for viewing the console log messages.
The rosout package only provides the rosout node.
Client APIs
Individual client APIs provide different ways of broadcasting to rosout:
roscpp uses rosconsole, which is described in the roscpp logging overview.
rospy's implementation is detailed in the rospy logging overview.
Verbosity Levels
Please see Verbosity Level Best Practices.
ROS API/Nodes
The /rosout node is part of roscore and has preferential startup order.
rosout
rosout subscribes to the standard /rosout topic, records these messages in a textual log file, and rebroadcasts the messages on /rosout_agg.Subscribed Topics
/rosout (roslib/Log)- Standard ROS topic for publishing logging messages.
Published Topics
/rosout_agg (roslib/Log)- Aggregated feed of messages published to /rosout.
/rosout
ROS client libraries are required to publish console logging messages to the /rosout topic as a standard interface.
/rosout_agg
/rosout_agg is an aggregated feed for subscribing to console logging messages. This aggregated topic is offered as a performance improvement: instead of connecting to individual ROS nodes to receive their console messages, the aggregated message feed can instead be received directly from the rosout node.
Roadmap/Stability
No future development on rosout is currently planned.