Skip to content

add explanation of rcl_logging_implementation. #6166

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
fujitatomoya wants to merge 5 commits into
base: rolling
Choose a base branch
from
Open

add explanation of rcl_logging_implementation. #6166

fujitatomoya wants to merge 5 commits into from
+141 −1

Conversation

@fujitatomoya
Copy link
Collaborator

@fujitatomoya fujitatomoya commented Jan 18, 2026

Description

Part of ros2/rcl#1178

Did you use Generative AI?

Yes, Claude Sonnet 4.0

Additional Information

@fujitatomoya fujitatomoya requested a review from Copilot January 18, 2026 01:58
@fujitatomoya fujitatomoya self-assigned this Jan 18, 2026
@fujitatomoya fujitatomoya mentioned this pull request Jan 18, 2026
Open
4 tasks
@fujitatomoya fujitatomoya requested a review from Yadunund January 18, 2026 01:59
Copilot AI reviewed Jan 18, 2026
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds comprehensive documentation for the rcl_logging_implementation abstraction layer in ROS 2's logging subsystem. The documentation explains how ROS 2 supports both dynamic loading and static linking of logging backends, similar to the rmw_implementation pattern used for middleware selection.

Changes:

  • Added documentation for the RCL_LOGGING_IMPLEMENTATION environment variable in the environment variables section
  • Updated the logging subsystem design description to clarify the two linking modes (dynamic and static)
  • Added a new comprehensive section explaining rcl_logging_implementation, including runtime dynamic loading vs static linking, environment variable configuration, implementation details, and use cases

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@github-actions
Copy link

github-actions bot commented Jan 18, 2026 •
edited
Loading

HTML artifacts: https://github.com/ros2/ros2_documentation/actions/runs/21469045833/artifacts/5299617388.

To view the resulting site:

  1. Click on the above link to download the artifacts archive
  2. Extract it
  3. Open html-artifacts-6166/index.html in your favorite browser

peci1
peci1 suggested changes Jan 18, 2026
View reviewed changes
Copy link
Contributor

@peci1 peci1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The proposed docs change looks good! However, I think it's also needed to change the diagram showing the library relations and add rcl_logging_implementation to it (and maybe also the two default logging libraries).

@fujitatomoya
Copy link
Collaborator Author

fujitatomoya commented Jan 18, 2026

@peci1 ah yeah, right. i will replace that into the correct stack diagram. thanks 👍

@fujitatomoya fujitatomoya mentioned this pull request Jan 19, 2026
Merged
@fujitatomoya
Copy link
Collaborator Author

fujitatomoya commented Jan 19, 2026

@Yadunund @Barry-Xu-2018 workflow is green, can you review this?

Barry-Xu-2018
Barry-Xu-2018 approved these changes Jan 19, 2026
View reviewed changes
Copy link
Contributor

@Barry-Xu-2018 Barry-Xu-2018 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

ahcorde
ahcorde requested changes Jan 20, 2026
View reviewed changes
@fujitatomoya fujitatomoya requested a review from ahcorde January 20, 2026 22:52
@fujitatomoya
Copy link
Collaborator Author

fujitatomoya commented Jan 22, 2026

@Mergifyio rebase

@fujitatomoya
Copy link
Collaborator Author

fujitatomoya commented Jan 22, 2026

@ahcorde can we merge this?

@mergify
Copy link
Contributor

mergify bot commented Jan 22, 2026

rebase

✅ Branch has been successfully rebased

@fujitatomoya fujitatomoya force-pushed the fujitatomoya/rcl_logging_implementation branch from cba87fd to a34485a Compare January 22, 2026 23:43
@fujitatomoya
Copy link
Collaborator Author

fujitatomoya commented Jan 26, 2026

@ahcorde friendly ping.

@fujitatomoya
Copy link
Collaborator Author

fujitatomoya commented Jan 29, 2026

@Mergifyio rebase

@mergify
Copy link
Contributor

mergify bot commented Jan 29, 2026

rebase

✅ Branch has been successfully rebased

@fujitatomoya
add explanation of rcl_logging_implementation.
1055bcb 
Signed-off-by: Tomoya.Fujita <Tomoya.Fujita@sony.com>
@fujitatomoya
address Copilot review comments.
964f924 
Signed-off-by: Tomoya.Fujita <Tomoya.Fujita@sony.com>
@fujitatomoya
wrong sectionize format.
84c3742 
Signed-off-by: Tomoya Fujita <Tomoya.Fujita@sony.com>
@fujitatomoya
update rcl logging related diagrams.
afa17ea 
Signed-off-by: Tomoya Fujita <Tomoya.Fujita@sony.com>
@fujitatomoya
add platform specific tabs.
ff97a00 
Signed-off-by: Tomoya Fujita <Tomoya.Fujita@sony.com>
@fujitatomoya fujitatomoya force-pushed the fujitatomoya/rcl_logging_implementation branch from a34485a to ff97a00 Compare January 29, 2026 07:10
@fujitatomoya fujitatomoya enabled auto-merge (squash) January 29, 2026 07:10
@fujitatomoya
Copy link
Collaborator Author

fujitatomoya commented Jan 29, 2026

this closes ros2/rcl#1178

@fujitatomoya
Copy link
Collaborator Author

fujitatomoya commented Jan 29, 2026

@Yadunund @ahcorde please have a look at this change. all the implementation has been merged, and index/release has been completed too. (means next sync, rcl_logging_implementation will be deployed and enabled) the rest is only this documentation support.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@Barry-Xu-2018 Barry-Xu-2018 Barry-Xu-2018 approved these changes

@Yadunund Yadunund Awaiting requested review from Yadunund

@ahcorde ahcorde Awaiting requested review from ahcorde

+1 more reviewer

@peci1 peci1 peci1 requested changes

Reviewers whose approvals may not affect merge requirements

Requested changes must be addressed to merge this pull request.

Assignees

@fujitatomoya fujitatomoya

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@fujitatomoya @peci1 @ahcorde @Barry-Xu-2018