Quick Start

This is a "Getting Started" guide for using naarad to analyze performance of a single machine.

1. Start performance data collection

   Naarad comes with naarad_metric_collector.sh script that will let you collect logs on the machine. It takes log directory as an argument.

    bin/naarad_metric_collector.sh log_dir
    

2. Run tests

   Run your performance test. Or wait for something interesting to happen if it's a live server!

3. Stop performance data collection

   To stop data collection kill the naarad_metric_collector.sh process(es).

4. Run naarad

   Run naarad with directory generated by naarad_metric_collector.sh in the input directory from step 1 and give it an output directory where you want naarad report to be saved.

    bin/naarad -i log_dir/sar-results-YYYY-MM-DD -o naarad_output
    

5. View naarad report

   Open summary.html or report.html in naarad's output directory (from step 4 above) to investigate the performance issue.

For more details and config options see Usage section.