first pass at example without screenshots #57
Conversation
EXAMPLE.md
Outdated
| For the purpose of this example we will be collecting data on two systems. The first system will be an x86-based C6i system and the second one will be an AWS Graviton C7g instance. To collect performance data in 1 second time intervals for 10 seconds on the C6i instances, run the following command: | ||
|
|
||
| ``` | ||
| ./aperf-v0.1.4-alpha-aarch64/aperf-collector -i 1 -p 10 -r c6i_performance_run_1 |
There was a problem hiding this comment.
Words say this is what to do on the x86 instance, but is running the aarch64 binary ;)
EXAMPLE.md
Outdated
| ./aperf-v0.1.4-alpha-aarch64/aperf-collector -i 1 -p 10 -r c6i_performance_run_1 | ||
| ``` | ||
|
|
||
| To collect performance data in 1 second time intervals for 10 seconds on the C7gf instances, run the following command (not the `run_name` parameter has changed. This allows us to easily differentiate between two performance runs. |
EXAMPLE.md
Outdated
| ``` | ||
|
|
||
| ## Visualizing The Results | ||
| To visualize the results you'll need access to a Linux desktop environment with a web browser installed. If you don't have access to a Linux desktop environment, [AWS Workspaces](https://aws.amazon.com/workspaces/) can be used to spin up a Linux desktop enviornment quickly and easily. |
There was a problem hiding this comment.
Probably want to lighten this up a bit so no-one thinks a linux machine with a GUI is required, but that the visualizer can be run on a different machine (but you'll have to do something like an ssh tunnel from a machine with any OS and a browser)
There was a problem hiding this comment.
Isn't the only supported environment the visualizer runs on right now Linux? Or are you saying run the visualizer on the linux machine you ran the perf data on, and then ssh tunnel and point your browser at it?
There was a problem hiding this comment.
You could run it on any linux machine, not just the one where you collected the data, and then use (just as one example) an SSH tunnel such that you can use a browser on your Mac/Windows laptop.
EXAMPLE.md
Outdated
| ``` | ||
|
|
||
| ## Comparing Two Performance Run Results | ||
| To visualize and compare the results of two different performance runs, use the following command. APerf will automatically highlight variances between the two performance runs. This can be useful for comparing differences between systems. |
There was a problem hiding this comment.
It will hopefully, soon, highlight differences. It doesn't do that currently.
EXAMPLE.md
Outdated
| ./aperf-v0.1.4-alpha-aarch64/aperf-visualizer -p 8080 --run-directory c7g_performance_run_1 | ||
| ``` | ||
|
|
||
| Once `aperf-visualizer` is up and running, simply point any web browser to the IP address of the machine running `aperf-visualizer`. |
There was a problem hiding this comment.
I believe it only binds to 127.0.0.1, it doesn't listen for remote connections.
Issue #, if available:
Description of changes:
This is a first pass at creating a step-by-step example. I will update later with step-by-step screenshots after I get data from @janaknat for visualization.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.