xref: /freebsd/sys/contrib/openzfs/man/man1/arcstat.1 (revision fa4d25f5b4573a54eebeb7f254b52153b8d3811e)
1.\"
2.\" This file and its contents are supplied under the terms of the
3.\" Common Development and Distribution License ("CDDL"), version 1.0.
4.\" You may only use this file in accordance with the terms of version
5.\" 1.0 of the CDDL.
6.\"
7.\" A full copy of the text of the CDDL should have accompanied this
8.\" source.  A copy of the CDDL is also available via the Internet at
9.\" http://www.illumos.org/license/CDDL.
10.\"
11.\" Copyright 2014 Adam Stevko.  All rights reserved.
12.\" Copyright (c) 2015 by Delphix. All rights reserved.
13.\" Copyright (c) 2020 by AJ Jordan. All rights reserved.
14.\"
15.Dd May 26, 2021
16.Dt ARCSTAT 1
17.Os
18.
19.Sh NAME
20.Nm arcstat
21.Nd report ZFS ARC and L2ARC statistics
22.Sh SYNOPSIS
23.Nm
24.Op Fl havxp
25.Op Fl f Ar field Ns Op , Ns Ar field Ns …
26.Op Fl o Ar file
27.Op Fl s Ar string
28.Op Ar interval
29.Op Ar count
30.
31.Sh DESCRIPTION
32.Nm
33prints various ZFS ARC and L2ARC statistics in vmstat-like fashion:
34.Bl -tag -compact -offset Ds -width "l2asize"
35.It Sy c
36ARC target size
37.It Sy dh%
38Demand data hit percentage
39.It Sy dm%
40Demand data miss percentage
41.It Sy mfu
42MFU list hits per second
43.It Sy mh%
44Metadata hit percentage
45.It Sy mm%
46Metadata miss percentage
47.It Sy mru
48MRU list hits per second
49.It Sy ph%
50Prefetch hits percentage
51.It Sy pm%
52Prefetch miss percentage
53.It Sy dhit
54Demand data hits per second
55.It Sy dmis
56Demand data misses per second
57.It Sy hit%
58ARC hit percentage
59.It Sy hits
60ARC reads per second
61.It Sy mfug
62MFU ghost list hits per second
63.It Sy mhit
64Metadata hits per second
65.It Sy miss
66ARC misses per second
67.It Sy mmis
68Metadata misses per second
69.It Sy mrug
70MRU ghost list hits per second
71.It Sy phit
72Prefetch hits per second
73.It Sy pmis
74Prefetch misses per second
75.It Sy read
76Total ARC accesses per second
77.It Sy time
78Current time
79.It Sy size
80ARC size
81.It Sy arcsz
82Alias for
83.Sy size
84.It Sy dread
85Demand data accesses per second
86.It Sy eskip
87evict_skip per second
88.It Sy miss%
89ARC miss percentage
90.It Sy mread
91Metadata accesses per second
92.It Sy pread
93Prefetch accesses per second
94.It Sy l2hit%
95L2ARC access hit percentage
96.It Sy l2hits
97L2ARC hits per second
98.It Sy l2miss
99L2ARC misses per second
100.It Sy l2read
101Total L2ARC accesses per second
102.It Sy l2pref
103L2ARC prefetch allocated size per second
104.It Sy l2pref%
105L2ARC prefetch allocated size percentage
106.It Sy l2mfu
107L2ARC MFU allocated size per second
108.It Sy l2mfu%
109L2ARC MFU allocated size percentage
110.It Sy l2mru
111L2ARC MRU allocated size per second
112.It Sy l2mru%
113L2ARC MRU allocated size percentage
114.It Sy l2data
115L2ARC data (buf content) allocated size per second
116.It Sy l2data%
117L2ARC data (buf content) allocated size percentage
118.It Sy l2meta
119L2ARC metadata (buf content) allocated size per second
120.It Sy l2meta%
121L2ARC metadata (buf content) allocated size percentage
122.It Sy l2size
123Size of the L2ARC
124.It Sy mtxmis
125mutex_miss per second
126.It Sy l2bytes
127Bytes read per second from the L2ARC
128.It Sy l2miss%
129L2ARC access miss percentage
130.It Sy l2asize
131Actual (compressed) size of the L2ARC
132.It Sy grow
133ARC grow disabled
134.It Sy need
135ARC reclaim needed
136.It Sy free
137The ARC's idea of how much free memory there is, which includes evictable memory
138in the page cache.
139Since the ARC tries to keep
140.Sy avail
141above zero,
142.Sy avail
143is usually more instructive to observe than
144.Sy free .
145.It Sy avail
146The ARC's idea of how much free memory is available to it, which is a bit less
147than
148.Sy free .
149May temporarily be negative, in which case the ARC will reduce the target size
150.Sy c .
151.El
152.
153.Sh OPTIONS
154.Bl -tag -width "-v"
155.It Fl a
156Print all possible stats.
157.It Fl f
158Display only specific fields.
159See
160.Sx DESCRIPTION
161for supported statistics.
162.It Fl h
163Display help message.
164.It Fl o
165Report statistics to a file instead of the standard output.
166.It Fl p
167Disable auto-scaling of numerical fields (for raw, machine-parsable values).
168.It Fl s
169Display data with a specified separator (default: 2 spaces).
170.It Fl x
171Print extended stats
172.Pq same as Fl f Sy time , Ns Sy mfu , Ns Sy mru , Ns Sy mfug , Ns Sy mrug , Ns Sy eskip , Ns Sy mtxmis , Ns Sy dread , Ns Sy pread , Ns Sy read .
173.It Fl v
174Show field headers and definitions
175.El
176.
177.Sh OPERANDS
178The following operands are supported:
179.Bl -tag -compact -offset Ds -width "interval"
180.It Ar interval
181Specify the sampling interval in seconds.
182.It Ar count
183Display only
184.Ar count
185reports.
186.El
187