-
-
Notifications
You must be signed in to change notification settings - Fork 646
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
stats: add output format option to save Pants stats as JSON #20579
Merged
AlexTereshenkov
merged 2 commits into
pantsbuild:main
from
AlexTereshenkov:python/output-stats-to-json
Apr 6, 2024
Merged
stats: add output format option to save Pants stats as JSON #20579
AlexTereshenkov
merged 2 commits into
pantsbuild:main
from
AlexTereshenkov:python/output-stats-to-json
Apr 6, 2024
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
2110030
to
6a24a36
Compare
Example invocation of multiple commands writing to the same file that is preserved between invocations:
Output file
|
huonw
reviewed
Mar 25, 2024
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.
Thanks for this!
6a24a36
to
d853ca0
Compare
huonw
approved these changes
Apr 6, 2024
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.
Cool!
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.
With the current implementation, when stats output is shown, it's always in plain text which makes parsing the stats really hard. For instance, it may be useful to track the cache hit rate for every Pants invocation to make sure it's being used effectively.
To make parsing the stats easy, it's now possible to export stats as JSON Lines objects. The amount and type of information is identical to what's being produced for plain text output, only the output format differs.
A few implementation details worth sharing:
As a follow-up, I'll refactor the code responsible for production of the stats so that the logic is defined in a single place (e.g. getting all the data in JSON format and then dumping it into plain text, if user asks to do so).