Correcting the Logging Macros

Oct 13, 2025 by talynt.org 43 views

System Information

This article is written with the intention of providing a detailed explanation of the issue with the logging macros RMW_CONNEXT_LOG_INFO and RMW_CONNEXT_LOG_INFO_A in the log.hpp file. The system information is as follows:

Operating System (OS): Ubuntu 24.04
ROS (Robot Operating System) version and installation type: rolling/source
RTI Connext DDS version and installation type: Pro 7.3.0
RMW (ROS Middleware) version or commit hash: rolling

Bug Description

The issue at hand is related to the definition of the macros RMW_CONNEXT_LOG_INFO and RMW_CONNEXT_LOG_INFO_A in the log.hpp file. These macros are currently defined using the RCUTILS_LOG_DEBUG_NAMED macro, which is incorrect. The correct macro to use in this case is RCUTILS_LOG_INFO_NAMED.

The use of the wrong macro can lead to incorrect logging levels being applied to the messages, which can result in unexpected behavior or errors in the system. This issue is being addressed as part of a pull request on the ROS 2 repository.

Expected Behavior

The expected behavior in this case is that the macros RMW_CONNEXT_LOG_INFO and RMW_CONNEXT_LOG_INFO_A should be defined using the correct macro, RCUTILS_LOG_INFO_NAMED. This will ensure that the logging levels are applied correctly, and the system will behave as expected.

How to Reproduce

To reproduce this issue, you can follow these steps:

Clone the ROS 2 repository using the following command: git clone https://github.com/ros2/ros2.git
Navigate to the rmw_connextdds package using the following command: cd ros2/rmw_connextdds
Open the log.hpp file in a text editor or IDE.
Search for the definitions of the macros RMW_CONNEXT_LOG_INFO and RMW_CONNEXT_LOG_INFO_A.
Observe that the macros are defined using the RCUTILS_LOG_DEBUG_NAMED macro.

Workarounds

There are no known workarounds for this issue, as it is a fundamental problem with the definition of the macros. However, the issue is being addressed as part of a pull request, and a fix will be available soon.

Additional Context

The issue with the logging macros is a critical one, as it can affect the behavior of the system and lead to errors or unexpected behavior. The correct definition of the macros is essential to ensure that the system behaves as expected.

Correcting the Logging Macros

To correct the logging macros, you can use the following code:

#define RMW_CONNEXT_LOG_INFO(...) \
  RCUTILS_LOG_INFO_NAMED(__VA_ARGS__, "rmw_connextdds")

#define RMW_CONNEXT_LOG_INFO_A(name, ...) \
  RCUTILS_LOG_INFO_NAMED(__VA_ARGS__, name)

This code defines the macros RMW_CONNEXT_LOG_INFO and RMW_CONNEXT_LOG_INFO_A using the correct macro, RCUTILS_LOG_INFO_NAMED. This will ensure that the logging levels are applied correctly, and the system will behave as expected.

Conclusion

In conclusion, the issue with the logging macros RMW_CONNEXT_LOG_INFO and RMW_CONNEXT_LOG_INFO_A in the log.hpp file is a critical one that can affect the behavior of the system. The correct definition of the macros is essential to ensure that the system behaves as expected. The issue is being addressed as part of a pull request, and a fix will be available soon.

Q&A: Use Correct Logging Macro to Define RMW_CONNEXT_LOG_INFO and RMW_CONNEXT_LOG_INFO_A

Q: What is the issue with the logging macros RMW_CONNEXT_LOG_INFO and RMW_CONNEXT_LOG_INFO_A?

A: The issue is that the macros are currently defined using the RCUTILS_LOG_DEBUG_NAMED macro, which is incorrect. The correct macro to use in this case is RCUTILS_LOG_INFO_NAMED.

Q: What is the expected behavior of the logging macros?

A: The expected behavior is that the macros RMW_CONNEXT_LOG_INFO and RMW_CONNEXT_LOG_INFO_A should be defined using the correct macro, RCUTILS_LOG_INFO_NAMED. This will ensure that the logging levels are applied correctly, and the system will behave as expected.

Q: How can I reproduce the issue?

A: To reproduce the issue, you can follow these steps:

Clone the ROS 2 repository using the following command: git clone https://github.com/ros2/ros2.git
Navigate to the rmw_connextdds package using the following command: cd ros2/rmw_connextdds
Open the log.hpp file in a text editor or IDE.
Search for the definitions of the macros RMW_CONNEXT_LOG_INFO and RMW_CONNEXT_LOG_INFO_A.
Observe that the macros are defined using the RCUTILS_LOG_DEBUG_NAMED macro.

Q: Are there any workarounds for this issue?

A: There are no known workarounds for this issue, as it is a fundamental problem with the definition of the macros. However, the issue is being addressed as part of a pull request, and a fix will be available soon.

Q: What is the correct definition of the macros RMW_CONNEXT_LOG_INFO and RMW_CONNEXT_LOG_INFO_A?

A: The correct definition of the macros is as follows:

#define RMW_CONNEXT_LOG_INFO(...) \
  RCUTILS_LOG_INFO_NAMED(__VA_ARGS__, "rmw_connextdds")

#define RMW_CONNEXT_LOG_INFO_A(name, ...) \
  RCUTILS_LOG_INFO_NAMED(__VA_ARGS__, name)

Q: Why is it important to use the correct logging macro?

A: It is essential to use the correct logging macro to ensure that the logging levels are applied correctly, and the system will behave as expected. Using the wrong macro can lead to incorrect logging levels being applied, which can result in unexpected behavior or errors in the system.

Q: Where can I find more information about this issue?

A: You can find more information about this issue on the ROS 2 repository, specifically in the pull request that addresses this issue.

Q: Is this issue specific to the ROS 2 repository?

A: No, this issue is not specific to the ROS 2 repository. It is a general issue that can affect any system that uses the RMW middleware.

Q: How can I contribute to the resolution of this issue?

A: You can contribute to the resolution of this issue by reviewing the pull request, providing feedback, and testing the fix. You can also report any issues you encounter while testing the fix.

Conclusion

In conclusion, the issue with the logging macros RMW_CONNEXT_LOG_INFO and RMW_CONNEXT_LOG_INFO_A is a critical one that can affect the behavior of the system. The correct definition of the macros is essential to ensure that the system behaves as expected. We hope that this Q&A article has provided you with the information you need to understand the issue and its resolution.