Update documentation on new terse format and add version number
authorJens Axboe <jaxboe@fusionio.com>
Wed, 30 Jun 2010 13:22:21 +0000 (15:22 +0200)
committerJens Axboe <jaxboe@fusionio.com>
Wed, 30 Jun 2010 13:22:21 +0000 (15:22 +0200)
Signed-off-by: Jens Axboe <jaxboe@fusionio.com>
HOWTO
fio.1
stat.c

diff --git a/HOWTO b/HOWTO
index b284c42..bd5bebf 100644 (file)
--- a/HOWTO
+++ b/HOWTO
@@ -1214,23 +1214,28 @@ For scripted usage where you typically want to generate tables or graphs
 of the results, fio can output the results in a semicolon separated format.
 The format is one long line of values, such as:
 
-client1;0;0;1906777;1090804;1790;0;0;0.000000;0.000000;0;0;0.000000;0.000000;929380;1152890;25.510151%;1078276.333333;128948.113404;0;0;0;0;0;0.000000;0.000000;0;0;0.000000;0.000000;0;0;0.000000%;0.000000;0.000000;100.000000%;0.000000%;324;100.0%;0.0%;0.0%;0.0%;0.0%;0.0%;0.0%;100.0%;0.0%;0.0%;0.0%;0.0%;0.0%
+2; client1;0;0;1906777;1090804;1790;0;0;0.000000;0.000000;0;0;0.000000;0.000000;929380;1152890;25.510151%;1078276.333333;128948.113404;0;0;0;0;0;0.000000;0.000000;0;0;0.000000;0.000000;0;0;0.000000%;0.000000;0.000000;100.000000%;0.000000%;324;100.0%;0.0%;0.0%;0.0%;0.0%;0.0%;0.0%;100.0%;0.0%;0.0%;0.0%;0.0%;0.0%
 ;0.0%;0.0%;0.0%;0.0%;0.0%
 
-To enable terse output, use the --minimal command line option.
+To enable terse output, use the --minimal command line option. The first
+value is the version of the terse output format. If the output has to
+be changed for some reason, this number will be incremented by 1 to
+signify that change.
 
 Split up, the format is as follows:
 
-       jobname, groupid, error
+       version, jobname, groupid, error
        READ status:
                KB IO, bandwidth (KB/sec), runtime (msec)
                Submission latency: min, max, mean, deviation
                Completion latency: min, max, mean, deviation
+               Total latency: min, max, mean, deviation
                Bw: min, max, aggregate percentage of total, mean, deviation
        WRITE status:
                KB IO, bandwidth (KB/sec), runtime (msec)
                Submission latency: min, max, mean, deviation
                Completion latency: min, max, mean, deviation
+               Total latency: min, max, mean, deviation
                Bw: 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
diff --git a/fio.1 b/fio.1
index 190da4f..77773a0 100644 (file)
--- a/fio.1
+++ b/fio.1
@@ -951,10 +951,13 @@ Disk utilization.
 .PD
 .SH TERSE OUTPUT
 If the \fB\-\-minimal\fR option is given, the results will be printed in a
-semicolon-delimited format suitable for scripted use.  The fields are:
+semicolon-delimited format suitable for scripted use.  Note that the first
+number in the line is the version number. If the output has to be changed
+for some reason, this number will be incremented by 1 to signify that
+change.  The fields are:
 .P
 .RS
-.B jobname, groupid, error
+.B version, jobname, groupid, error
 .P
 Read status:
 .RS
@@ -968,6 +971,10 @@ Completion latency:
 .RS
 .B min, max, mean, standard deviation
 .RE
+Total latency:
+.RS
+.B min, max, mean, standard deviation
+.RE
 Bandwidth:
 .RS
 .B min, max, aggregate percentage of total, mean, standard deviation
@@ -986,6 +993,10 @@ Completion latency:
 .RS
 .B min, max, mean, standard deviation
 .RE
+Total latency:
+.RS
+.B min, max, mean, standard deviation
+.RE
 Bandwidth:
 .RS
 .B min, max, aggregate percentage of total, mean, standard deviation
diff --git a/stat.c b/stat.c
index a79c7ef..8a0fab0 100644 (file)
--- a/stat.c
+++ b/stat.c
@@ -401,6 +401,7 @@ static void show_ddir_status_terse(struct thread_stat *ts,
                log_info(";%lu;%lu;%f%%;%f;%f", 0UL, 0UL, 0.0, 0.0, 0.0);
 }
 
+#define FIO_TERSE_VERSION      "2"
 
 static void show_thread_status_terse(struct thread_stat *ts,
                                     struct group_run_stats *rs)
@@ -411,7 +412,8 @@ static void show_thread_status_terse(struct thread_stat *ts,
        double usr_cpu, sys_cpu;
        int i;
 
-       log_info("%s;%d;%d", ts->name, ts->groupid, ts->error);
+       log_info("%s;%s;%d;%d", FIO_TERSE_VERSION, ts->name, ts->groupid,
+                               ts->error);
 
        show_ddir_status_terse(ts, rs, 0);
        show_ddir_status_terse(ts, rs, 1);