| 1 |
.TH fslatency-nd 8 "2015-01-30" "USER COMMANDS" |
| 2 |
.SH NAME |
| 3 |
fslatency-nd \- Measure file system sync read and write latency distribution. Uses Linux SystemTap (non-debuginfo). |
| 4 |
.SH SYNOPSIS |
| 5 |
.B fslatency-nd.stp |
| 6 |
[interval [count]] |
| 7 |
.SH DESCRIPTION |
| 8 |
fslatency-nd.stp dynamically traces two common file system functions: |
| 9 |
do_sync_read() and do_sync_write(), and reports a histogram distribution of |
| 10 |
latency. Many, but not all, file systems and |
| 11 |
workloads use these functions. Tracing their time provides one view of |
| 12 |
suffered file system latency. |
| 13 |
|
| 14 |
Other file system requests not covered by these functions and this tool include: |
| 15 |
asynchronous I/O, directory operations, and file handle operations. |
| 16 |
.SH REQUIREMENTS |
| 17 |
SystemTap. |
| 18 |
.SH OPTIONS |
| 19 |
.TP |
| 20 |
interval |
| 21 |
Interval for reports, in seconds. |
| 22 |
.TP |
| 23 |
count |
| 24 |
Number of reports to output. |
| 25 |
.SH EXAMPLES |
| 26 |
.TP |
| 27 |
Measure (most) file system synchronous read and write latency, and show a distribution histogram on Ctrl-C: |
| 28 |
# |
| 29 |
.B fslatency-nd.stp |
| 30 |
.TP |
| 31 |
Measure (most) file system synchronous read and write latency, and show a report every second, five times: |
| 32 |
# |
| 33 |
.B fslatency-nd.stp 1 5 |
| 34 |
.SH FIELDS |
| 35 |
.TP |
| 36 |
value |
| 37 |
The minimum value, in nanoseconds, for this histogram bucket. Read this value |
| 38 |
as "I/O latency was at least xxx". |
| 39 |
.TP |
| 40 |
count |
| 41 |
How many reads/writes fell into this latency range. |
| 42 |
.SH OVERHEAD |
| 43 |
The overheads are measurable, as file system requests can be very frequent, and |
| 44 |
the small overhead of tracing each (eg, 4 microseconds per call) can begin to |
| 45 |
add up. Best case, it won't be noticeable. Worst case, the application may run |
| 46 |
2x slower. |
| 47 |
.SH SOURCE |
| 48 |
This is from the SystemTap lwtools collection. |
| 49 |
.IP |
| 50 |
https://github.com/brendangregg/systemtap-lwtools |
| 51 |
.PP |
| 52 |
Also look under the examples directory for a text file containing example |
| 53 |
usage, output, and commentary for this tool. |
| 54 |
.SH OS |
| 55 |
Linux |
| 56 |
.SH STABILITY |
| 57 |
Unstable - in development. |
| 58 |
.SH AUTHOR |
| 59 |
Brendan Gregg |
| 60 |
.SH SEE ALSO |
| 61 |
iostat(1), fsslower-nd.stp(8), biolatency-nd.stp(8) |