-
Notifications
You must be signed in to change notification settings - Fork 190
Add verb for setting a node's log level #1060
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.
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
Open
nnarain
wants to merge
5
commits into
ros2:rolling
Choose a base branch
from
nnarain:feat-log-level-cli
base: rolling
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| from ros2cli.node.strategy import add_arguments | ||
|
|
||
| from ros2node.verb import VerbExtension | ||
| from ros2node.api import call_log_level_set, LEVEL_STR_TO_ENUM | ||
| from ros2cli.node.direct import DirectNode | ||
|
|
||
|
|
||
| class LogVerb(VerbExtension): | ||
| """Set the log level of a node""" | ||
| def add_arguments(self, parser, cli_name): | ||
| add_arguments(parser) | ||
|
|
||
| parser.add_argument('node_name', help='The name of the node') | ||
| parser.add_argument('-l', '--logger-name', help='The logger name, if it is different from the node name') | ||
| parser.add_argument('level', choices=LEVEL_STR_TO_ENUM.keys(), help='Log level') | ||
|
|
||
| def main(self, *, args): | ||
| with DirectNode(args) as node: | ||
| if args.logger_name is None: | ||
| args.logger_name = args.node_name.lstrip('/') | ||
| # Call the service to set the log level | ||
| call_log_level_set(node, args.logger_name, args.level) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just a comment about this part specifically:
As Tomoya said, the node will not have this service if its
enable_logger_servicenode option isn't set totrue: https://docs.ros.org/en/rolling/Tutorials/Demos/Logging-and-logger-configuration.html#logger-level-configuration-externally. It isfalseby default: https://github.com/ros2/rclcpp/blob/84c6fb1cfc945521680a0e1fccf5b32237acbcc3/rclcpp/include/rclcpp/node_options.hpp#L452Instead of just throwing an error with a generic
f'Service {service_name} not ready'message, it should let the user know that the service may not exist if the node doesn't have theenable_logger_serviceoption enabled. This way the user knows exactly what to change in their code. Something like:There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ah! I missed this from your earlier comment:
Then yes, definitely!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated log line
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this should explicitly mention the "'enable_logger_service' node option" not just "Are the logging services enabled?"
Users probably have no idea how to enable logging services. It's much more useful to tell them exactly what needs to change: enable the
enable_logger_servicenode option