ros2doctor

This folder contains the source code for ros2doctor. It is one of the ROS 2 command line interface tools included with a standard install of any ROS 2 distro. ros2doctor is similar to roswtf from ROS 1. It will examine your ROS 2 setup, such as distribution, platform, network interface, etc., and look for potential issues in a running ROS 2 system.

Usage

Run ros2 doctor or ros2 wtf(alias) to conduct checks.

Run ros2 doctor -h/--help to print all available command arguments.

Run ros2 doctor -r/--report to see report of all checked items.

Run ros2 doctor -rf/--report-fail to see report of failed checks only.

Run ros2 doctor -iw/--include-warnings to include warnings as failed checks. -iw and -rf can be used in combination.

Add New Checks

To add your own checks or information to report, use Python entry points to add modules to setup.py. See example below:

    entry_points={
        'ros2doctor.checks': [
            'PlatformCheck = ros2doctor.api.platform:PlatformCheck',
            'NetworkCheck = ros2doctor.api.network:NetworkCheck',
        ],
        'ros2doctor.report': [
            'PlatformReport = ros2doctor.api.platform:PlatformReport',
            'NetworkReport = ros2doctor.api.network:NetworkReport',
        ],
    }

Changelog for package ros2doctor

0.32.0 (2024-04-16)

• Remove references to https://index.ros.org (#897)
• Contributors: Chris Lalancette

0.31.2 (2024-03-27)

0.31.1 (2024-02-07)

0.31.0 (2024-01-24)

0.30.1 (2023-12-26)

0.30.0 (2023-11-06)

• (ros2doctor) fix PackageCheck (#860)
  • (ros2doctor)(package) improve result string generation
• Contributors: Matthijs van der Burgh

0.29.1 (2023-10-04)

0.29.0 (2023-08-21)

0.28.0 (2023-07-11)

0.27.0 (2023-06-07)

0.26.1 (2023-05-11)

• Shutdown ros2doctor hello when ctrl-c is received (#826)
• Contributors: Michael Carroll

0.26.0 (2023-04-28)

0.25.0 (2023-04-18)

• Make all of the dependencies in pure Python packages exec_depend. (#823)
• Contributors: Chris Lalancette

0.24.1 (2023-04-12)

0.24.0 (2023-04-11)

• Enable document generation using rosdoc2 (#811)
  • Fix warnings for ros2component, ros2doctor, ros2interface, and ros2node
• Contributors: Yadu

0.23.0 (2023-03-02)

0.22.0 (2023-02-14)

• [rolling] Update maintainers - 2022-11-07 (#776)
• Contributors: Audrow Nash

0.21.0 (2022-11-02)

0.20.0 (2022-09-13)

0.19.0 (2022-04-29)

0.18.3 (2022-04-08)

• Fix importlib_metadata warning on Python 3.10. (#706)
• Contributors: Chris Lalancette

0.18.2 (2022-03-30)

• Add timeout to kill hanging tests (#701)
• Contributors: Audrow Nash

0.18.1 (2022-03-28)

0.18.0 (2022-03-01)

0.17.1 (2022-01-25)

0.17.0 (2022-01-25)

• Switch ros2 doctor to using psutil for network checks. (#687)
• Contributors: Chris Lalancette

0.16.1 (2022-01-14)

0.16.0 (2022-01-14)

• Depend on launch packages instead of ros_testing to avoid circular dependency (#685)
• Contributors: Shane Loretz

0.15.0 (2021-11-18)

• Update maintainers to Aditya Pande, Audrow Nash, and Michael Jeronimo (#673)
• Updated maintainers (#670)
• Add changelogs (#635)
• Improve ros2 doctor on Windows. (#631)
• Contributors: Aditya Pande, Audrow Nash, Ivan Santiago Paunovic

0.14.0 (2021-04-26)

• Add QoS compatibility check and report. (#621)
• Continue to next iteration after exceptions in generate_reports. (#623)
• Contributors: Alberto Soragna, Audrow Nash

0.13.0 (2021-04-06)

0.12.0 (2021-03-02)

• Remove maintainer. (#597)
• Add Audrow as a maintainer. (#591)
• Contributors: Audrow Nash, Claire Wang

0.11.0 (2021-01-25)

• Support Python 3.8-provided importlib.metadata. (#585)
• Contributors: Scott K Logan

0.10.1 (2020-12-08)

0.10.0 (2020-11-02)

• Update maintainers. (#568)
• Remove pkg_resources from ros2doctor. (#537)
• Make ros2doctor depend on ros_environment and fix platform.py bug on error. (#538)
• Refactor ros2doctor hello verb. (#521)
• Contributors: Chris Lalancette, Claire Wang, Michel Hidalgo

0.9.5 (2020-06-01)

0.9.4 (2020-05-26)

• Ensure ros2doctor ROS nodes have valid names. (#513)
• Contributors: Michel Hidalgo

0.9.3 (2020-05-13)

0.9.2 (2020-05-08)

0.9.1 (2020-05-06)

0.9.0 (2020-04-29)

• Make sure to add ros2doctor verbs to the extension points. (#495)
• [ros2doctor] Only report topic warnings if publisher or subscription count is zero. (#472) Before the tool was generating many false positives as it is a valid configuration to have an unequal number of publishers and subscriptions on a given topic. This change makes it so we only provide a warning if one of the counts is zero and the other is not. Although this is still a legitimate configuration, it seems more likely to be a problem and worth reporting.
• More verbose test_flake8 error messages (same as ros2/launch_ros#135)
• Prefix ros2doctor node names with \'ros2doctor_\'. (#451) This fixes an error when the hostname starts with an illegal character for a node name (e.g. a number).
• [ros2doctor] Handle non-metapackages in rosdistro check. (#452) Otherwise, we get a KeyError and get warnings about not being able to find versions for certain packages.
• [ros2doctor] Improve doctor_warn() . (#445)
  • Decouple warning/error msg from result to show traceback
  • Update print statement to use f-string
  • Remove None return and add error catching
  • Specify stacklevel; add doctor_error
• Multimachine communication. (#432)
  • Add verb call
  • Add verb entry point
  • Put executor.spin in its own thread
  • Update args
  • Add missing whitespace
  • Add summary table doc string
  • Fix exception ignore traceback
  • Fix mixed up sub/receive dicts
  • Reapply changes
  • Add option and verbose name, enforce node name uniqueness, add context lock. prefix variables, add infinite loop
  • Change verb naem
  • Add single host test case
  • Add rclpy dependency
  • Correct typo, remove stderr from test
  • Restart daemon to resolve CI runtime error
  • Replace ready_fn with ReadyToTest()
• [ros2doctor] Check for deprecated packages. (#388)
  • Check local package versions against rosdistro
• Revert \"simplify helper function\" This reverts commit 2c1768d1f464aa6e8d7f4cb162a5e36647036a43.
• Simplify helper function
• Update network check to fix missing flags on Windows . (#404)
  • Add no flags scenario
• Contributors: Chris Lalancette, Claire Wang, Dirk Thomas, Jacob Perron, claireyywang

0.8.6 (2019-11-19)

0.8.5 (2019-11-14)

• 0.8.5
• Contributors: Shane Loretz

0.8.4 (2019-11-13)

• 0.8.4
• Update headline to capital letters. (#383)
• Contributors: Claire Wang, Michael Carroll

0.8.3 (2019-10-23)

• 0.8.3

• Update failed modules message. (#380) * Update failed modules message The message previously said, for example ` Failed modules are network[ Which is confusing when there\'s only one module Changing to: ]{.title-ref}Failed modules: network` Which works if there\'s one or more failed modules

  • Remove double space

• Fix AttributeError. (#370)

• Add new args. (#354)

• Contributors: Claire Wang, Marya Belanger, Shane Loretz

0.8.2 (2019-10-08)

• 0.8.2
• Contributors: Dirk Thomas

0.8.1 (2019-10-04)

• 0.8.1
• Ros2doctor: add topic check. (#341)
  • Add topic check&report
  • Add topic check&report
  • Add topic test, tbc
  • Add topic report unit test
  • Correct docstring
• Contributors: Claire Wang, Michael Carroll

0.8.0 (2019-09-26)

• Install resource marker file for packages. (#339)
• Ros2doctor: add [--include-warning]{.title-ref} arg. (#338)
  • Add include-warning arg
  • Rm whitespace
  • Update arg usage
  • Simplify error/warning mechanism
  • Simplify run_checks param
• Add warning and error handling for [ifcfg]{.title-ref} import on Windows and OSX. (#332)
  • Add error handling for ifcfg and check/report type
  • Modify check/report warning msgs
  • Fix code format
  • Fix grammar
  • Fix var refed before declared exception
  • Remove type check
  • Update network check/report rtypes
  • Move report if/else block
  • Remove report inits
• Add RMW name to report . (#335)
  • Add rmw library info
  • Add middleware name
  • Add entry point
• Make network check case-insensitive. (#334)
  • Make network check case-insensitive
  • Update case insensitive function call
• Install package manifest. (#330)
• Update README entry point examples. (#329)
• Update report feature with new argument, add temp fix for ifcfg module . (#324)
  • Add network checks and report
  • Network shenanigens
  • Network shenanigens
  • Network shenanigens
  • Add network check and report
  • Update code format
  • Revised code format
  • Added rosdep key ifcfg-pip
  • Revise code
  • Working on report format
  • Improving report
  • Update platform report format
  • Update network report format
  • Add format print
  • Add --report_failed feature
  • Improving report format
  • Temp fix ifcfg import module
  • Update build dep
  • Fix flake8
  • Fix flake8
  • Add abc and Report class
  • Implement ABC for each check and report and udpate format print
  • Update ifcfg import error, fix code format
  • Add newlines
  • Update warning msgs
  • Fix code format
  • Update report of failed checks
  • Update run_check
  • Udpate generate_report
  • Add sphinx style docstring and type annotations
  • Add context manager for custom warning msg
  • Fixed flakey issues
  • Update Check and Report class error handling
  • Fix report refed before assigned mistake
  • Add failed entry point name
  • Remove pass from try/except
  • Add error handling for check/report
  • Change ValueError to Exception
• Removing ifcfg_vendor. (#323)

• Add network configuration check and report to ros2doctor. (#319)

  • Add network checks and report
  • Network shenanigens
  • Network shenanigens
  • Network shenanigens
  • Add network check and report
  • Update code format
  • Revised code format

  * Add ifcfg-pip rosdep key waiting for rosdistro PR approval https://github.com/ros/rosdistro/pull/22071 - Added rosdep key ifcfg-pip - Revise code

• Add ros2doctor README. (#318)

  • Add README
  • Update sentence to new line

  * Update grammer Co-Authored-By: Marya Belanger <marya@openrobotics.org> * Update grammer Co-Authored-By: Marya Belanger <marya@openrobotics.org> * Update grammer Co-Authored-By: Marya Belanger <marya@openrobotics.org> * Update grammar Co-Authored-By: Marya Belanger <marya@openrobotics.org>

• Add distribution check and report feature to [ros2 doctor]{.title-ref} command . (#311)

  • Created ros2debug package
  • Created setup verb, need revision
  • Added simple setup check
  • Added simple setup check, need testing
  • Added four standard tests
  • Add new line to end of file
  • Corrected code format
  • Update debug api Signed-off by: Claire Wang clairewang@openrobotics.org
  • Update code format
  • Added rosdistro
  • Fixed style and added rosdistro
  • Fixed code style
  • Corrected code style
  • Added network interface print command
  • Leave out network verb, change cmd name to doctor, add alias wtf
  • Remove network.py
  • Add version, rosdistro, platformdist, fallback checks, fallback checks
  • Add wtf alias, separate checks and report
  • Remove duplicates, correct grammer
  • Add entrypoints for checks and report, output failed checks
  • Corrected code format
  • Reformat report, correct typo

• Contributors: Claire Wang, Dirk Thomas

0.7.4 (2019-05-29)

0.7.3 (2019-05-20)

0.7.2 (2019-05-08)

0.7.1 (2019-04-17)

0.7.0 (2019-04-14)

0.6.3 (2019-02-08)

0.6.2 (2018-12-12)

0.6.1 (2018-12-06)

0.6.0 (2018-11-19)

0.5.4 (2018-08-20)

0.5.3 (2018-07-17)

0.5.2 (2018-06-28)

0.5.1 (2018-06-27 12:27)

0.5.0 (2018-06-27 12:17)

0.4.0 (2017-12-08)