swri_console

master	dashing-devel

swri_console is an alternative to rqt_console for viewing the ROS console output. swri_console was written to scale well to large systems with heavy console output. It stays responsive under fire and allows users to quickly find information to track down problems.

Installation

The master branch compiles and runs on ROS Kinetic and Melodic; the dashing-devel branch compiles and runs on ROS 2 Dashing and Eloquent.

To install a binary release:

sudo apt install ros-${ROSDISTRO}-swri-console

Usage

ROS 1:

rosrun swri_console swri_console

ROS 2:

ros2 run swri_console swri_console

Features

• High performance; swri_console handles receiving thousands of logs per second and storing millions in memory while staying responsive
• Ctrl or shift-click to quickly select which nodes you want to monitor
• Hide or show log messages based on substring matches, or, if you need more power, regular expressions
• Hide, show, and colorize log messages based on severity
• Save and load log messages to text files
• Save and load log messages directly from the /rosout topic in a bag file
  • Not supported in ROS 2 yet
• Right-click on nodes to dynamically set their logger levels
  • Not supported in ROS 2 yet

Changelog for package swri_console

1.1.1 (2023-04-04)

• feat: human readable time formatting (#57) Adds option to make the date and time easier to read for humans
• Added options to be displayed in each log line: logger name and function name. (#38) Co-authored-by: Rasmus Skovgaard Andersen <Rasmus.Andersen@marel.com>
• Switching to GitHub actions (#47)
• Merge pull request #40 from cellumation/master Enable closing via Ctrl-C from a terminal
• Merge pull request #39 from jarvisschultz/rosout_agg_bag_support Add ability to read either [/rosout]{.title-ref} or [/rosout_agg]{.title-ref} from bag files
• Do not use the ros signal handlers. Thus, it is now possible to close the swri_console via Ctrl-C from the console
• Add ability to read either [/rosout]{.title-ref} or [/rosout_agg]{.title-ref} from bag files Prefer [/rosout]{.title-ref} if it exists, if not, fall back to [/rosout_agg]{.title-ref}. Also, if no log messages are found in a bag emit a warning to indicate to user the reason why log messages did not change. Tested this with bag files containing only [/rosout]{.title-ref}, only [/rosout_agg]{.title-ref}, both [/rosout]{.title-ref} and [/rosout_agg]{.title-ref}, and neither [/rosout]{.title-ref} nor [/rosout_agg]{.title-ref}.
• Update documentation Add some feature bullet points and point out ROS 2 support
• Update package maintainers (#29)
• Contributors: Alexis Tsogias, David Anthony, Jarvis Schultz, Mart Moerdijk, Matthew, P. J. Reed

1.1.0 (2018-05-11)

• Added simple rosout_agg_recorder (#15)
• Change logger levels from within swri_console (#20)
• Load ROS logs and directories of ROS logs
• Fix compiler warnings found with Clang
• Add search bar
• Contributors: Edward Venator, P. J. Reed, Phil Westhart, Victor Murray, elliotjo, jgassaway

1.0.0 (2017-04-01)

• Add kinetic and lunar and simplify CI
  • Remove cruft from CI configuration
  • Add ROS kinetic to CI configuration
  • Add ROS lunar to CI configuration
  • Remove shadow-fixed builds from CI configuration. Since this repository has very few catkin dependencies, there\'s no reason to build for both shadow-fixed and released.
• Fix compiler warnings
• Contributors: Edward Venator, P. J. Reed, elliotjo

0.2.0 (2016-10-23)

• Port to Qt5 #16
• Contributors: Edward Venator, P. J. Reed

0.1.0 (2016-05-28)

• Remove settings_keys.h from qt4_wrap_cpp to suppress warning There are no QT-wrappable classes in this header, so the QT build emits a warning that it\'s doing nothing on the file. Since it\'s doing nothing, we might as well remove the file from the wrapper macro.
• Adding support for Travis CI This is based on the script provided by ros-industrial at: https://github.com/ros-industrial/industrial_ci
• Fix for issue #12; \"Copy Extended\" was only copying blank lines.
• Add option to alternate row colors for stronger line distinction. This uses the QAbstractItemView\'s alternatingRowColors property to alternate the background color of each line in the log list. You can disable the alternating colors by right clicking on the log, and your preference should be persistent between sessions.
• Fix incorrect target in CMakeLists.txt
• Select all nodes when user hits Ctrl+A in the node list. Closes #6.
• Sync behavior between saving to bags and text files. This closes #10 by using the same behavior when saving to text and bag files. Both now save the same messages that are in the user\'s current view. Partly because this lets the user save subsets or everything by deliberately selecting everything, and partly because it was a lot easier to change the save to bag behavior than vice versa.
• Handle log messages with multiple lines correctly. This fixes the console to handle log messages with multiple lines correctly. We\'re going to be using a little bit more memory now, but it shouldn\'t be a major issue and performance still seems great. Closes #8.
• Closes Issue #04 - Subscribe to rosout_agg instead of rosout. I spent an hour adding an option to subscribe to either /rosout or /rosout_agg thinking that we would still need to listen to /rosout when playing back a bag file that only had /rosout recorded. But it turns out that the republisher catches those and puts them on /rosout_agg anyways. I reverted the changes and just changed RosThread to subscribe to /rosout_agg.
• Fix issue 05 - Node list not clearing out properly. The root cause of this problem was that the message count in the log database was not being cleared out. I\'ve refactored the structure a little bit to make the dependencies a little cleaner. The log database doesn\'t know about the NodeListModel anymore (though the model now knows about the database). This puts things more in line with the log database just being the main source of information, and the node list model and log database proxy being different views onto the database.
• Merge pull request #7 from pjreed/user_settings User settings
• Saving user settings for issue #2.
• Fixing a typo that prevented the Fatal-level message from printing.
• Adds license headers to all code.
• Adding screenshot for github front page.
• Adding console_generator.py script to generate fake messages.
• Create README.md
• Add url package file.
• Update package metadata.
  • Adds maintainer and author name
  • Sets license to BSD
  • Adds a more verbose description
• Remove unused dependency on qt_build, which is gone in Jade.
• Fix catkin lint
• Add extended copy option. This is an extended version of the copy command that also copies extra information like the node name, source file, source line, etc to the clipboard.
• Change default warning color to orange. Yellow-on-white is particularly hard for my eyes to read, especially out on a vehicle in daylight.
• Add the ability to write logs to txt or bag files.
• Fixing an issue with the \"install\" target.
• Fixing issues found by cppcheck.
• Adding the ability to colorize logs.
• Adding a menu open to read bag files directly.
• Setting default appropriate default values for some member variables.
• Adding a visual cue to the \"Select All\" menu option.
• Adding the ability to multi-select & copy logs.
• Cleaning up some catkin_lint issues and adding comments.
• Fixing issue with master disconnect/reconnect. After merging in ros_thread, I noticed that the console no longer reconnected properly when if the ros core is shutdown and restarted. I think this was due to using ros::Rate to limit the main RosThread loop. I removed this in favor of QThread::msleep so that the loop is independent of ROS. Also removed the added ros::NodeHandle member and initial startRos call that I\'m guessing was added to allow ros::Rate to run without an exception. Using QThread::msleep might be be preferrable anyways so that the console continues to read messages immediately even if we\'re running simulations with the ROS clock turned waaaay down.
• Minor formatting.
• Fix bug in ordering from processing older messages. The old message processing had a small bug where each chunk of messages ended up in reversed order. For example if you had an ordering like: ABCDEF and change the filtering, they might be reordered as CBAFED This was a small bug that is fixed by correctly building the early messages queue in the proper reversed order.
• Adding buttons for clearing the node & log lists.
• Adding comments; cleaning up code; reducing the update rate slightly.
• Moving ROS processing into a separate thread from the GUI.
• Adding regexp support to the include/exclude filters.
• Set window title with node names.
• Support to change fonts.
• Fixing node list selection model.
• Trying to get better layout sizes.
• Make substring filters case insensitive.
• Change include filter behavior. This changes the include filter to pass messages that contain at least one of the substrings instead of all substrings.
• Adding support for exlude/include filters.
• Adding relative/absolute times to output lines.
• Automatically toggle auto-scrolling based on slider position.
• Adding initial version. Basic functionality, but stays snappy with large logs so far.
• Contributors: Ed Venator, Elliot Johnson, P. J. Reed