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.13.5 (2022-12-02)

0.13.4 (2022-06-30)

0.13.3 (2022-04-28)

0.13.2 (2021-05-07)

• Improve ros2 doctor on Windows. (#631) (#634)
• Add changelog. (#636)
• Contributors: Ivan Santiago Paunovic, mergify[bot]

0.13.1 (2021-04-26)

• Continue to next iteration after exceptions in generate_reports. (#623)
• Contributors: Alberto Soragna

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

File truncated at 100 lines see the full file