Skip to content

Commit cd56c0a

Browse files
committed
docs: mention unsupported configuration
It does not make sense when group_reporting is used for the constituent jobs to have different values for options like unified_rw_reporting, ?lat_percentiles, etc. Mention that configurations with different values for these parameters are unsupported. Signed-off-by: Vincent Fu <[email protected]>
1 parent 9e27103 commit cd56c0a

File tree

2 files changed

+19
-2
lines changed

2 files changed

+19
-2
lines changed

HOWTO.rst

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4128,6 +4128,11 @@ Measurements and reporting
41284128
`job_start`. For these properties, the values for the first job are
41294129
recorded for the group.
41304130

4131+
Also, options like :option:`percentile_list` and
4132+
:option:`unified_rw_reporting` should be consistent among the jobs in a
4133+
reporting group. Having options like these vary across the jobs in a
4134+
reporting group is an unsupported configuration.
4135+
41314136
.. option:: new_group
41324137

41334138
Start a new reporting group. See: :option:`group_reporting`. If not given,
@@ -5391,4 +5396,8 @@ Terse output in client/server mode will differ slightly from what is produced
53915396
when fio is run in stand-alone mode. See the terse output section for details.
53925397

53935398
Also, if one fio invocation runs workloads on multiple servers, fio will
5394-
provide at the end an aggregate summary report for all workloads.
5399+
provide at the end an aggregate summary report for all workloads. This
5400+
aggregate summary report assumes that options affecting reporting like
5401+
:option:`unified_rw_reporting` and :option:`percentile_list` are identical
5402+
across all the jobs summarized. Having different values for these options is an
5403+
unsupported configuration.

fio.1

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3844,6 +3844,10 @@ have a natural group-level equivalent. Examples include \fBkb_base\fR,
38443844
\fBunit_base\fR, \fBsig_figs\fR, \fBthread_number\fR, \fBpid\fR, and
38453845
\fBjob_start\fR. For these properties, the values for the first job are
38463846
recorded for the group.
3847+
.P
3848+
Also, options like \fBpercentile_list\fR and \fBunified_rw_reporting\fR should
3849+
be consistent among the jobs in a reporting group. Having options like these
3850+
vary across the jobs in a reporting group is an unsupported configuration.
38473851
.RE
38483852
.TP
38493853
.BI new_group
@@ -5148,7 +5152,11 @@ Terse output in client/server mode will differ slightly from what is produced
51485152
when fio is run in stand-alone mode. See the terse output section for details.
51495153
.P
51505154
Also, if one fio invocation runs workloads on multiple servers, fio will
5151-
provide at the end an aggregate summary report for all workloads.
5155+
provide at the end an aggregate summary report for all workloads. This
5156+
aggregate summary report assumes that options affecting reporting like
5157+
\fBunified_rw_reporting\fR and \fBpercentile_list\fR are identical across all
5158+
the jobs summarized. Having different values for these options is an
5159+
unsupported configuration.
51525160
.SH AUTHORS
51535161
.B fio
51545162
was written by Jens Axboe <[email protected]>.

0 commit comments

Comments
 (0)