updating README #55
updating README #55
Conversation
README.md
Outdated
|
|
||
| `aperf-collector` only supports running on Linux. | ||
|
|
||
| `aperf-visualizer` supports Mac and Linux. |
There was a problem hiding this comment.
We don't support Mac, yet.
README.md
Outdated
|
|
||
| To visualize the data using `aperf-visualizer` download the directory created by `aperf-collector` and load the data with `aperf-visualizer`. | ||
|
|
||
| **WARNING** |
There was a problem hiding this comment.
We could say 'KNOWN LIMITATION'?
README.md
Outdated
|
|
||
| **aperf-collector** | ||
| 1. Download the `aperf-collector` binary. | ||
| 2. By default `aperf-collector` will collect data for 10 seconds. Configure options are shown below. |
There was a problem hiding this comment.
Point # 2 can be removed.
README.md
Outdated
|
|
||
| `-p, --period` period (how long you want the data collection to run, default is 10s) | ||
|
|
||
| `-r, --run-name` run name (name of the run for organization purposes, creates directory of the same name, default of APerf_timestamp) |
There was a problem hiding this comment.
This is aperf_[timestamp]. Here timestamp is the time at which the command was run.
README.md
Outdated
| ## Why does APerf exist? | ||
| Performance issues in applications are investigated by recreating them locally and collecting data/metrics using monitoring tools like sysstat, perf, sysctl, ebpf, etc... or by running these tools remotely. Installing and executing various performance monitoring tools is a manual process and prone to errors. Even with the [Graviton Performance Runbook](https://github.com/aws/aws-graviton-getting-started/blob/main/perfrunbook/graviton_perfrunbook.md), understanding the output of these tools requires deep domain specific knowledge. | ||
|
|
||
| The aim of APerf is to enable anyone to collect performance data in their enviornment while providing tools to analyze and visualize application performance. APerf will enable faster troubleshooting by analyzing and highlighting deviations in performance between two application environments automatically. |
There was a problem hiding this comment.
s/will enable/will eventually, hopefully, enable/ ;)
There was a problem hiding this comment.
changed to "hopefully" just to keep it succint
README.md
Outdated
|
|
||
| ## Building from source | ||
| ``` | ||
| cargo build | ||
| cargo test | ||
| cargo run |
There was a problem hiding this comment.
Still needs a parameter of what to run, could be a meta-parameter here instead of one of the specific two values ..... or just remove this line since the section is about building not running :)
There was a problem hiding this comment.
removed the run command for now.
README.md
Outdated
|
|
||
| **WARNING** | ||
|
|
||
| The default configuration of 10ms for `/sys/devices/cpu/perf_event_mux_interval_ms ` is known to cause serious performance overhead for systems with large core counts. We recommend setting this value to 100ms by doing the following: |
There was a problem hiding this comment.
Extra space there after perf_event_mux_interval_ms
README.md
Outdated
|
|
||
| `aperf-collector` only supports running on Linux. | ||
|
|
||
| `aperf-visualizer` supports Mac. |
There was a problem hiding this comment.
We only support Linux for the 'aperf-visualizer' also.
|
I remember you were planning to include a few screenshots in the README. Is that not the case anymore? |
|
That will come later in the EXAMPLE.MD doc I'm working on, but this gets us a good starting point for now. |
Issue #, if available:
Description of changes:
Updating the README to be more useful.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.