@@ -36,37 +36,42 @@ Typical use cases include:
3636
3737## Scraper
3838
39- Scraper is a command-line tool that collects metrics from mactop's HTTP endpoint and stores them in JSON files.
39+ Scraper is a command-line tool that collects metrics from a mactop HTTP endpoint and saves them as JSON files.
4040
41- Assuming you have downloaded the released binary as ` scraper ` , you can run it with the following command:
41+ If you’ve downloaded the released binary and named it scraper, you can run it using the following command:
4242
4343``` bash
4444./scraper --duration 60 --interval 5 --output-dir " ./metrics_data" --mactop-url " http://192.168.1.5:2211"
4545```
4646
47- You can find more details about the command-line options by running :
47+ To see all available command-line options, run :
4848
4949``` bash
5050./scraper --help
5151```
5252
5353## Analyzer
5454
55- Analyzer is a Python script that processes the collected JSON files and generates summaries of the metrics .
55+ Analyzer is a Python script that processes the collected JSON files and generates metric summaries .
5656
57- Before running the analyzer, make sure you have installed the required Python packages. You can do this using ` uv ` :
57+ Before running the analyzer, make sure the required Python packages are installed. We recommend using ` uv ` :
5858
5959``` bash
6060uv sync
6161```
6262
63- Then, you can run the analyzer with the following command :
63+ Then, run the analyzer with:
6464
6565``` bash
6666uv run analyzer.py --input-dir " ./metrics_data"
6767```
6868
69- Then, you can get a report of the collected metrics. You can also get graphs of the metrics by adding ` --plot ` option.
69+ This will generate a summary report of the collected metrics.
70+ To include visualizations, add the ` --plot ` option:
71+
72+ ``` bash
73+ uv run analyzer.py --input-dir " ./metrics_data" --plot
74+ ```
7075
7176
7277# License
0 commit comments