pmgperf.adoc: improve layout, add example

diff --git a/pmgperf.adoc b/pmgperf.adoc
index 6503102112f36d94ea563933cda6d6f55f36db9a..f135992b5a73eb08ac7d77c45cec3a9abf87eb86 100644 (file)
--- a/pmgperf.adoc
+++ b/pmgperf.adoc
@@ -25,31 +25,46 @@ Proxmox Simple Performance Benchmark
 :pmg-toplevel:
 endif::manvolnum[]
 
-This tool tries to gather some CPU/Hardisk performance data on the
-hardisk (mounted at 'path').
+The command line tool `pmgperf` tries to gather some general
+performance data. This is mostly useful for debugging and to identify
+performance bottlenecks. It computes the following metrics:
 
-* CPU BOGOMIPS: bogomips sum of all CPUs
+[horizontal]
+CPU BOGOMIPS:: bogomips sum of all CPUs
 
-* REGEX/SECOND: regular expressions per second (perl performance
-  test), should be above 300000
+REGEX/SECOND:: regular expressions per second (perl performance
+  test), should be above 1000000.
 
-* HD SIZE: harddisk size
+HD SIZE:: harddisk size
 
-* BUFFERED READS: simple HD read test. Modern HDs should reach at
-least 40 MB/sec
+BUFFERED READS:: simple HD read test. Modern HDs should reach at
+least 100 MB/sec
 
-* AVERAGE SEEK TIME: tests average seek time. Fast SCSI HDs reach
+AVERAGE SEEK TIME:: tests average seek time. Fast SCSI HDs reach
 values < 8 milliseconds. Common IDE/SATA disks get values from 15 to
 20 ms. SSD seek times should be below 1ms.
 
-* FSYNCS/SECOND: value should be greater than 200 (you should enable
+FSYNCS/SECOND:: value should be greater than 200 (you should enable
 'write back' cache mode on you RAID controller - needs a battery
 backed cache (BBWC)).
 
-* DNS EXT: average time to resolve an external DNS name
+DNS EXT:: average time to resolve an external DNS name
 
-* DNS INT: average time to resolve a local DNS name
+DNS INT:: average time to resolve a local DNS name
 
+Here is an example output generated by the tool:
+
+----
+# pmgperf
+CPU BOGOMIPS:      16759.60
+REGEX/SECOND:      1186304
+HD SIZE:           60.78 GB (/dev/sda1)
+BUFFERED READS:    209.84 MB/sec
+AVERAGE SEEK TIME: 1.24 ms
+FSYNCS/SECOND:     2198.79
+DNS EXT:           35.69 ms
+DNS INT:           1.41 ms (yourdomain.tld)
+----
 
 ifdef::manvolnum[]
 include::pmg-copyright.adoc[]