Reduce noisy log messages from @rule params
#10658
Merged
Conversation
This file contains 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
Eric-Arellano
approved these changes
Aug 19, 2020
src/rust/engine/src/nodes.rs
Outdated
| @@ -1248,7 +1248,11 @@ impl Display for NodeKey { | |||
| &NodeKey::Scandir(ref s) => write!(f, "Scandir({})", (s.0).0.display()), | |||
| &NodeKey::Select(ref s) => write!(f, "{}", s.product), | |||
| &NodeKey::Task(ref task) => { | |||
| write!(f, "@rule {}({})", task.task.display_info.name, task.params) | |||
| //TODO cf. https://github.com/pantsbuild/pants/issues/7907 , we probably | |||
There was a problem hiding this comment.
Nit: The convention is TODO(#7907). Would be good to fix so that people can find it via Grep.
There was a problem hiding this comment.
Also I think each comment is supposed to have a single space between the // and the message.
src/rust/engine/src/nodes.rs
Outdated
| //want to include some kind of representation of the Params of an @rule when | ||
| //we stringify the @rule. But we need to make sure we don't naively dump | ||
| //the string representation of a Key, which could get gigantic. | ||
| write!(f, "@rule {}", task.task.display_info.name) |
There was a problem hiding this comment.
Maybe @rule(my_rule_name), rather than @rule my_rule_name. This would fit with the repr for the other node types a bit better.
[ci skip-build-wheels]
[ci skip-build-wheels]
gshuflin
force-pushed
the
fix-noisy-messages
branch
from
4a6160a to
596122e
Compare
Eric-Arellano
approved these changes
Aug 19, 2020
|
Does #10665 mean that this could be reverted or cleaned up? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Problem
cf. #10518 , it's possible for pants to emit extremely large log messages whenever it prints a long containing the string representation of large Python types. In the above issue, the large Python types are
FieldSetsubclasses (which can include lots of e.g. file path names) in their Python__str__representation. These types appear as theparamsfield on aTask, and are part of the RustDisplayrepresentation of aTask, which is part of the log message when a node is invalidated because of a file system change, and might more generally show up in any pants log message.Solution
A quick fix for the above problem is to simply remove the
Paramsfrom theDisplayimplementation of an@rule's task, and only include the name of the Python function corresponding to the rule. cf. #7907 , we probably want to eventually implement a more sophisticated way of deciding what Python type information we do and do not need to include in useful pants logs from Rust.