CustomPMU: Update README documentation #243
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
wash-amzn
approved these changes
Feb 11, 2025
| @@ -1,6 +1,6 @@ | |||
| # APerf | |||
| ## What is APerf? | |||
| A CLI tool to gather many pieces of performance data in one go. APerf includes a recorder and a reporter sub tool. The recorder gathers performance metrics, stores them in a set of local files that can then be analyzed via the reporter sub tool. | |||
| A CLI tool to gather many pieces of performance data in one go. APerf includes a recorder, reporter and custom-pmu sub tools. The recorder gathers performance metrics, stores them in a set of local files that can then be analyzed via the reporter sub tool. The custom-pmu sub-tool can be used to create custom PMU configs which can configure the events an aperf recorder collects. | |||
Comment on lines
+77
to
+82
| **aperf custom-pmu** | ||
| 1. Download the `aperf` binary. | ||
| 2. Start `aperf custom-pmu`: | ||
| ``` | ||
| ./aperf custom-pmu | ||
| ``` |
There was a problem hiding this comment.
This doesn't provide much information IMO
lrbison
reviewed
Feb 14, 2025
|
|
||
| `-p, --pmu-file` Name of the file for the custom PMU configuration | ||
|
|
||
| `--verify` Verify the supplied PMU file |
There was a problem hiding this comment.
maybe be a little more specific here: "Verify the supplied PMU file can be parsed. Availability or functionality of the counters are not verified"
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.
Update the README with the documentation for the custom-pmu subtool. Also update
aperf recordwith the new--pmu-configflag.By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.