HOWTO: emphasize units in --minimal mode: latency in usec, bw in KB/s

[fio.git] / HOWTO

diff --git a/HOWTO b/HOWTO
index e4614ea8675a0c8b2f958ad8c2d6b04e12181939..73e82653f5e1c8315a2987a1c96e4458162a4507 100644 (file)
--- a/HOWTO
+++ b/HOWTO
@@ -310,7 +310,7 @@ rw=str              Type of io pattern. Accepted values are:
                        write           Sequential writes
                        randwrite       Random writes
                        randread        Random reads
                        write           Sequential writes
                        randwrite       Random writes
                        randread        Random reads

-                       rw              Sequential mixed reads and writes
+                       rw,readwrite    Sequential mixed reads and writes

                        randrw          Random mixed reads and writes
 
                For the mixed io types, the default is to split them 50/50.
                        randrw          Random mixed reads and writes
 
                For the mixed io types, the default is to split them 50/50.


@@ -1339,13 +1339,17 @@ I               Thread initialized, waiting.
        F       Running, currently waiting for fsync()
        V       Running, doing verification of written data.
 E              Thread exited, not reaped by main thread yet.
        F       Running, currently waiting for fsync()
        V       Running, doing verification of written data.
 E              Thread exited, not reaped by main thread yet.

-_              Thread reaped.
+_              Thread reaped, or
+X              Thread reaped, exited with an error.
+K              Thread reaped, exited due to signal.

 
 The other values are fairly self explanatory - number of threads
 currently running and doing io, rate of io since last check (read speed
 listed first, then write speed), and the estimated completion percentage
 and time for the running group. It's impossible to estimate runtime of
 
 The other values are fairly self explanatory - number of threads
 currently running and doing io, rate of io since last check (read speed
 listed first, then write speed), and the estimated completion percentage
 and time for the running group. It's impossible to estimate runtime of

-the following groups (if any).
+the following groups (if any). Note that the string is displayed in order,
+so it's possible to tell which of the jobs are currently doing what. The
+first character is the first job defined in the job file, and so forth.

 
 When fio is done (or interrupted by ctrl-c), it will show the data for
 each thread, group of threads, and disks in that order. For each data
 
 When fio is done (or interrupted by ctrl-c), it will show the data for
 each thread, group of threads, and disks in that order. For each data


@@ -1378,7 +1382,8 @@ runt=             The runtime of that thread
                latency, since queue/complete is one operation there. This
                value can be in milliseconds or microseconds, fio will choose
                the most appropriate base and print that. In the example
                latency, since queue/complete is one operation there. This
                value can be in milliseconds or microseconds, fio will choose
                the most appropriate base and print that. In the example

-               above, milliseconds is the best scale.
+               above, milliseconds is the best scale. Note: in --minimal mode
+               latencies are always expressed in microseconds.

        clat=   Completion latency. Same names as slat, this denotes the
                time from submission to completion of the io pieces. For
                sync io, clat will usually be equal (or very close) to 0,
        clat=   Completion latency. Same names as slat, this denotes the
                time from submission to completion of the io pieces. For
                sync io, clat will usually be equal (or very close) to 0,


@@ -1466,18 +1471,18 @@ Split up, the format is as follows:
        terse version, fio version, jobname, groupid, error
        READ status:
                Total IO (KB), bandwidth (KB/sec), IOPS, runtime (msec)
        terse version, fio version, jobname, groupid, error
        READ status:
                Total IO (KB), bandwidth (KB/sec), IOPS, runtime (msec)

-               Submission latency: min, max, mean, deviation
-               Completion latency: min, max, mean, deviation
+               Submission latency: min, max, mean, deviation (usec)
+               Completion latency: min, max, mean, deviation (usec)

                Completion latency percentiles: 20 fields (see below)
                Completion latency percentiles: 20 fields (see below)

-               Total latency: min, max, mean, deviation
-               Bw: min, max, aggregate percentage of total, mean, deviation
+               Total latency: min, max, mean, deviation (usec)
+               Bw (KB/s): min, max, aggregate percentage of total, mean, deviation

        WRITE status:
                Total IO (KB), bandwidth (KB/sec), IOPS, runtime (msec)
        WRITE status:
                Total IO (KB), bandwidth (KB/sec), IOPS, runtime (msec)

-               Submission latency: min, max, mean, deviation
-               Completion latency: min, max, mean, deviation
+               Submission latency: min, max, mean, deviation (usec)
+               Completion latency: min, max, mean, deviation (usec)

                Completion latency percentiles: 20 fields (see below)
                Completion latency percentiles: 20 fields (see below)

-               Total latency: min, max, mean, deviation
-               Bw: min, max, aggregate percentage of total, mean, deviation
+               Total latency: min, max, mean, deviation (usec)
+               Bw (KB/s): min, max, aggregate percentage of total, mean, deviation

        CPU usage: user, system, context switches, major faults, minor faults
        IO depths: <=1, 2, 4, 8, 16, 32, >=64
        IO latencies microseconds: <=2, 4, 10, 20, 50, 100, 250, 500, 750, 1000
        CPU usage: user, system, context switches, major faults, minor faults
        IO depths: <=1, 2, 4, 8, 16, 32, >=64
        IO latencies microseconds: <=2, 4, 10, 20, 50, 100, 250, 500, 750, 1000