Skip to content

Commit 97fef60

Browse files
Guopeng Zhanghtejun
authored andcommitted
Docs/admin-guide/cgroup-v2: note blkcg_debug_stats gates io.latency stats
The io.stat section says that enabling the io.latency controller exposes the depth, avg_lat and win stats in addition to the normal ones. However, these io.latency-specific stats are debug stats and are only emitted when the blkcg_debug_stats module parameter is enabled, which is disabled by default. Make this explicit so users do not expect these fields to appear in io.stat by default, and qualify the usage text that suggests using avg_lat to pick an io.latency target. Signed-off-by: Guopeng Zhang <zhangguopeng@kylinos.cn> Signed-off-by: Tejun Heo <tj@kernel.org>
1 parent 451a746 commit 97fef60

1 file changed

Lines changed: 8 additions & 5 deletions

File tree

Documentation/admin-guide/cgroup-v2.rst

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2257,10 +2257,11 @@ groups D and F will influence each other. Group G will influence nobody::
22572257
So the ideal way to configure this is to set io.latency in groups A, B, and C.
22582258
Generally you do not want to set a value lower than the latency your device
22592259
supports. Experiment to find the value that works best for your workload.
2260-
Start at higher than the expected latency for your device and watch the
2261-
avg_lat value in io.stat for your workload group to get an idea of the
2262-
latency you see during normal operation. Use the avg_lat value as a basis for
2263-
your real setting, setting at 10-15% higher than the value in io.stat.
2260+
Start at higher than the expected latency for your device and, with
2261+
blkcg_debug_stats enabled, watch the avg_lat value in io.stat for your
2262+
workload group to get an idea of the latency you see during normal operation.
2263+
Use the avg_lat value as a basis for your real setting, setting at 10-15%
2264+
higher than the value in io.stat.
22642265

22652266
How IO Latency Throttling Works
22662267
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -2298,7 +2299,9 @@ IO Latency Interface Files
22982299

22992300
io.stat
23002301
If the controller is enabled you will see extra stats in io.stat in
2301-
addition to the normal ones.
2302+
addition to the normal ones. These debug stats are only emitted when
2303+
the blkcg_debug_stats module parameter is enabled (it is disabled by
2304+
default).
23022305

23032306
depth
23042307
This is the current queue depth for the group.

0 commit comments

Comments
 (0)