Skip to content

Commit

Permalink
Fix up arcstat(1) to match our version
Browse files Browse the repository at this point in the history
Turns out the illumos manpage, which is what this originates from, was
written for the original Perl version of the utility which is not the
version in the OpenZFS tree. *That* version originates from a Python
rewrite that was done for FreeNAS. So fix up the manpage to match what
we actually ship (and fix a few typos in the process).

Reviewed-by: Richard Laager <rlaager@wiktel.com>
Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Signed-off-by: AJ Jordan <alex@strugee.net>
Closes openzfs#10288
  • Loading branch information
strugee authored and behlendorf committed May 11, 2020
1 parent ac806a2 commit 5a04b17
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 19 deletions.
2 changes: 1 addition & 1 deletion man/man1/Makefile.am
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
dist_man_MANS = zhack.1 ztest.1 raidz_test.1 zvol_wait.1
dist_man_MANS = zhack.1 ztest.1 raidz_test.1 zvol_wait.1 arcstat.1
EXTRA_DIST = cstyle.1

install-data-local:
Expand Down
63 changes: 45 additions & 18 deletions man/man1/arcstat.1
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@
.\"
.\" Copyright 2014 Adam Stevko. All rights reserved.
.\" Copyright (c) 2015 by Delphix. All rights reserved.
.\" Copyright (c) 2020 by AJ Jordan. All rights reserved.
.\"
.TH ARCSTAT 1M "Feb 4, 2014"
.TH ARCSTAT 1 "May 7, 2020"
.SH NAME
arcstat \- report ZFS ARC and L2ARC statistics
.SH SYNOPSIS
.LP
.nf
\fBarcstat\fR [\fB-hvxr\fR] [\fB-f field[,field]...\fR] [\fB-o file\fR] [\fB-s string\fR]
[\fBinterval\fR [\fBcount\fR]]
\fBarcstat\fR [\fB-hvx\fR] [\fB-f field[,field]...\fR] [\fB-o file\fR] [\fB-s string\fR] [\fBinterval\fR [\fBcount\fR]]
.fi

.SH DESCRIPTION
Expand All @@ -36,12 +36,12 @@ The \fBarcstat\fR command reports the following information:

.\"
.sp
.ne 1
.ne 1
.na
\fBc \fR
.ad
.RS 14n
ARC Target Size
ARC target size
.RE

.sp
Expand All @@ -50,7 +50,7 @@ ARC Target Size
\fBdh% \fR
.ad
.RS 14n
Demand Data hit percentage
Demand data hit percentage
.RE

.sp
Expand All @@ -59,7 +59,7 @@ Demand Data hit percentage
\fBdm% \fR
.ad
.RS 14n
Demand Data miss percentage
Demand data miss percentage
.RE

.sp
Expand All @@ -68,7 +68,7 @@ Demand Data miss percentage
\fBmfu \fR
.ad
.RS 14n
MFU List hits per second
MFU list hits per second
.RE

.sp
Expand All @@ -95,7 +95,7 @@ Metadata miss percentage
\fBmru \fR
.ad
.RS 14n
MRU List hits per second
MRU list hits per second
.RE

.sp
Expand All @@ -122,7 +122,7 @@ Prefetch miss percentage
\fBdhit \fR
.ad
.RS 14n
Demand Data hits per second
Demand data hits per second
.RE

.sp
Expand All @@ -131,7 +131,7 @@ Demand Data hits per second
\fBdmis \fR
.ad
.RS 14n
Demand Data misses per second
Demand data misses per second
.RE

.sp
Expand All @@ -140,7 +140,7 @@ Demand Data misses per second
\fBhit% \fR
.ad
.RS 14n
ARC Hit percentage
ARC hit percentage
.RE

.sp
Expand All @@ -158,7 +158,7 @@ ARC reads per second
\fBmfug \fR
.ad
.RS 14n
MFU Ghost List hits per second
MFU ghost list hits per second
.RE

.sp
Expand Down Expand Up @@ -194,7 +194,7 @@ Metadata misses per second
\fBmrug \fR
.ad
.RS 14n
MRU Ghost List hits per second
MRU ghost list hits per second
.RE

.sp
Expand Down Expand Up @@ -239,7 +239,7 @@ Time
\fBarcsz \fR
.ad
.RS 14n
ARC Size
ARC size
.RE

.sp
Expand Down Expand Up @@ -347,7 +347,7 @@ mutex_miss per second
\fBl2bytes \fR
.ad
.RS 14n
bytes read per second from the L2ARC
Bytes read per second from the L2ARC
.RE

.sp
Expand All @@ -367,6 +367,33 @@ L2ARC access miss percentage
.RS 14n
Actual (compressed) size of the L2ARC
.RE

.sp
.ne 2
.na
\fBgrow \fR
.ad
.RS 14n
ARC grow disabled
.RE

.sp
.ne 2
.na
\fBneed \fR
.ad
.RS 14n
ARC reclaim needed
.RE

.sp
.ne 2
.na
\fBfree \fR
.ad
.RS 14n
ARC free memory
.RE
.\"

.SH OPTIONS
Expand Down Expand Up @@ -413,7 +440,6 @@ Display data with a specified separator (default: 2 spaces).
.ne 2
.na
\fB\fB-x\fR\fR

.ad
.RS 12n
Print extended stats (same as -f time,mfu,mru,mfug,mrug,eskip,mtxmis,dread,pread,read).
Expand Down Expand Up @@ -451,5 +477,6 @@ Specify the sampling interval in seconds.

.SH AUTHORS
.LP
arcstat was originally written by Neelakanth Nadgir and supported only ZFS ARC statistics.
arcstat was originally written in Perl by Neelakanth Nadgir and supported only ZFS ARC statistics.
Mike Harsch updated it to support L2ARC statistics.
John Hixson ported it to Python for FreeNAS over some beer, after which many individuals from the OpenZFS community continued to maintain and improve it.

0 comments on commit 5a04b17

Please sign in to comment.