zpool/zfs: allow --json wherever -j is allowed
[zfs.git] / man / man1 / arcstat.1
blob019a8270204a2551035a407ca0e3537ef1d345f3
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 December 23, 2022
16 .Dt ARCSTAT 1
17 .Os
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
31 .Sh DESCRIPTION
32 .Nm
33 prints various ZFS ARC and L2ARC statistics in vmstat-like fashion:
34 .Bl -tag -compact -offset Ds -width "l2asize"
35 .It Sy c
36 ARC target size
37 .It Sy dh%
38 Demand hit percentage
39 .It Sy di%
40 Demand I/O hit percentage
41 .It Sy dm%
42 Demand miss percentage
43 .It Sy ddh%
44 Demand data hit percentage
45 .It Sy ddi%
46 Demand data I/O hit percentage
47 .It Sy ddm%
48 Demand data miss percentage
49 .It Sy dmh%
50 Demand metadata hit percentage
51 .It Sy dmi%
52 Demand metadata I/O hit percentage
53 .It Sy dmm%
54 Demand metadata miss percentage
55 .It Sy mfu
56 MFU list hits per second
57 .It Sy mh%
58 Metadata hit percentage
59 .It Sy mi%
60 Metadata I/O hit percentage
61 .It Sy mm%
62 Metadata miss percentage
63 .It Sy mru
64 MRU list hits per second
65 .It Sy ph%
66 Prefetch hits percentage
67 .It Sy pi%
68 Prefetch I/O hits percentage
69 .It Sy pm%
70 Prefetch miss percentage
71 .It Sy pdh%
72 Prefetch data hits percentage
73 .It Sy pdi%
74 Prefetch data I/O hits percentage
75 .It Sy pdm%
76 Prefetch data miss percentage
77 .It Sy pmh%
78 Prefetch metadata hits percentage
79 .It Sy pmi%
80 Prefetch metadata I/O hits percentage
81 .It Sy pmm%
82 Prefetch metadata miss percentage
83 .It Sy dhit
84 Demand hits per second
85 .It Sy dioh
86 Demand I/O hits per second
87 .It Sy dmis
88 Demand misses per second
89 .It Sy ddhit
90 Demand data hits per second
91 .It Sy ddioh
92 Demand data I/O hits per second
93 .It Sy ddmis
94 Demand data misses per second
95 .It Sy dmhit
96 Demand metadata hits per second
97 .It Sy dmioh
98 Demand metadata I/O hits per second
99 .It Sy dmmis
100 Demand metadata misses per second
101 .It Sy hit%
102 ARC hit percentage
103 .It Sy hits
104 ARC hits per second
105 .It Sy ioh%
106 ARC I/O hits percentage
107 .It Sy iohs
108 ARC I/O hits per second
109 .It Sy mfug
110 MFU ghost list hits per second
111 .It Sy mhit
112 Metadata hits per second
113 .It Sy mioh
114 Metadata I/O hits per second
115 .It Sy miss
116 ARC misses per second
117 .It Sy mmis
118 Metadata misses per second
119 .It Sy mrug
120 MRU ghost list hits per second
121 .It Sy phit
122 Prefetch hits per second
123 .It Sy pioh
124 Prefetch I/O hits per second
125 .It Sy pmis
126 Prefetch misses per second
127 .It Sy pdhit
128 Prefetch data hits per second
129 .It Sy pdioh
130 Prefetch data I/O hits per second
131 .It Sy pdmis
132 Prefetch data misses per second
133 .It Sy pmhit
134 Prefetch metadata hits per second
135 .It Sy pmioh
136 Prefetch metadata I/O hits per second
137 .It Sy pmmis
138 Prefetch metadata misses per second
139 .It Sy read
140 Total ARC accesses per second
141 .It Sy time
142 Current time
143 .It Sy size
144 ARC size
145 .It Sy arcsz
146 Alias for
147 .Sy size
148 .It Sy unc
149 Uncached list hits per second
150 .It Sy dread
151 Demand accesses per second
152 .It Sy ddread
153 Demand data accesses per second
154 .It Sy dmread
155 Demand metadata accesses per second
156 .It Sy eskip
157 evict_skip per second
158 .It Sy miss%
159 ARC miss percentage
160 .It Sy mread
161 Metadata accesses per second
162 .It Sy pread
163 Prefetch accesses per second
164 .It Sy pdread
165 Prefetch data accesses per second
166 .It Sy pmread
167 Prefetch metadata accesses per second
168 .It Sy l2hit%
169 L2ARC access hit percentage
170 .It Sy l2hits
171 L2ARC hits per second
172 .It Sy l2miss
173 L2ARC misses per second
174 .It Sy l2read
175 Total L2ARC accesses per second
176 .It Sy l2pref
177 L2ARC prefetch allocated size per second
178 .It Sy l2pref%
179 L2ARC prefetch allocated size percentage
180 .It Sy l2mfu
181 L2ARC MFU allocated size per second
182 .It Sy l2mfu%
183 L2ARC MFU allocated size percentage
184 .It Sy l2mru
185 L2ARC MRU allocated size per second
186 .It Sy l2mru%
187 L2ARC MRU allocated size percentage
188 .It Sy l2data
189 L2ARC data (buf content) allocated size per second
190 .It Sy l2data%
191 L2ARC data (buf content) allocated size percentage
192 .It Sy l2meta
193 L2ARC metadata (buf content) allocated size per second
194 .It Sy l2meta%
195 L2ARC metadata (buf content) allocated size percentage
196 .It Sy l2size
197 Size of the L2ARC
198 .It Sy mtxmis
199 mutex_miss per second
200 .It Sy l2bytes
201 Bytes read per second from the L2ARC
202 .It Sy l2wbytes
203 Bytes written per second to the L2ARC
204 .It Sy l2miss%
205 L2ARC access miss percentage
206 .It Sy l2asize
207 Actual (compressed) size of the L2ARC
208 .It Sy cmpsz
209 Compressed size
210 .It Sy cmpsz%
211 Compressed size percentage
212 .It Sy ovhsz
213 Overhead size
214 .It Sy ovhsz%
215 Overhead size percentage
216 .It Sy bonsz
217 Bonus size
218 .It Sy bonsz%
219 Bonus size percentage
220 .It Sy dnosz
221 Dnode size
222 .It Sy dnosz%
223 Dnode size percentage
224 .It Sy dbusz
225 Dbuf size
226 .It Sy dbusz%
227 Dbuf size percentage
228 .It Sy hdrsz
229 Header size
230 .It Sy hdrsz%
231 Header size percentage
232 .It Sy l2hsz
233 L2 header size
234 .It Sy l2hsz%
235 L2 header size percentage
236 .It Sy abdsz
237 ABD chunk waste size
238 .It Sy abdsz%
239 ABD chunk waste size percentage
240 .It Sy datatg
241 ARC data target
242 .It Sy datatg%
243 ARC data target percentage
244 .It Sy datasz
245 ARC data size
246 .It Sy datasz%
247 ARC data size percentage
248 .It Sy metatg
249 ARC metadata target
250 .It Sy metatg%
251 ARC metadata target percentage
252 .It Sy metasz
253 ARC metadata size
254 .It Sy metasz%
255 ARC metadata size percentage
256 .It Sy anosz
257 Anonymous size
258 .It Sy anosz%
259 Anonymous size percentage
260 .It Sy anoda
261 Anonymous data size
262 .It Sy anoda%
263 Anonymous data size percentage
264 .It Sy anome
265 Anonymous metadata size
266 .It Sy anome%
267 Anonymous metadata size percentage
268 .It Sy anoed
269 Anonymous evictable data size
270 .It Sy anoed%
271 Anonymous evictable data size percentage
272 .It Sy anoem
273 Anonymous evictable metadata size
274 .It Sy anoem%
275 Anonymous evictable metadata size percentage
276 .It Sy mfutg
277 MFU target
278 .It Sy mfutg%
279 MFU target percentage
280 .It Sy mfudt
281 MFU data target
282 .It Sy mfudt%
283 MFU data target percentage
284 .It Sy mfumt
285 MFU metadata target
286 .It Sy mfumt%
287 MFU metadata target percentage
288 .It Sy mfusz
289 MFU size
290 .It Sy mfusz%
291 MFU size percentage
292 .It Sy mfuda
293 MFU data size
294 .It Sy mfuda%
295 MFU data size percentage
296 .It Sy mfume
297 MFU metadata size
298 .It Sy mfume%
299 MFU metadata size percentage
300 .It Sy mfued
301 MFU evictable data size
302 .It Sy mfued%
303 MFU evictable data size percentage
304 .It Sy mfuem
305 MFU evictable metadata size
306 .It Sy mfuem%
307 MFU evictable metadata size percentage
308 .It Sy mfugsz
309 MFU ghost size
310 .It Sy mfugd
311 MFU ghost data size
312 .It Sy mfugm
313 MFU ghost metadata size
314 .It Sy mrutg
315 MRU target
316 .It Sy mrutg%
317 MRU target percentage
318 .It Sy mrudt
319 MRU data target
320 .It Sy mrudt%
321 MRU data target percentage
322 .It Sy mrumt
323 MRU metadata target
324 .It Sy mrumt%
325 MRU metadata target percentage
326 .It Sy mrusz
327 MRU size
328 .It Sy mrusz%
329 MRU size percentage
330 .It Sy mruda
331 MRU data size
332 .It Sy mruda%
333 MRU data size percentage
334 .It Sy mrume
335 MRU metadata size
336 .It Sy mrume%
337 MRU metadata size percentage
338 .It Sy mrued
339 MRU evictable data size
340 .It Sy mrued%
341 MRU evictable data size percentage
342 .It Sy mruem
343 MRU evictable metadata size
344 .It Sy mruem%
345 MRU evictable metadata size percentage
346 .It Sy mrugsz
347 MRU ghost size
348 .It Sy mrugd
349 MRU ghost data size
350 .It Sy mrugm
351 MRU ghost metadata size
352 .It Sy uncsz
353 Uncached size
354 .It Sy uncsz%
355 Uncached size percentage
356 .It Sy uncda
357 Uncached data size
358 .It Sy uncda%
359 Uncached data size percentage
360 .It Sy uncme
361 Uncached metadata size
362 .It Sy uncme%
363 Uncached metadata size percentage
364 .It Sy unced
365 Uncached evictable data size
366 .It Sy unced%
367 Uncached evictable data size percentage
368 .It Sy uncem
369 Uncached evictable metadata size
370 .It Sy uncem%
371 Uncached evictable metadata size percentage
372 .It Sy grow
373 ARC grow disabled
374 .It Sy need
375 ARC reclaim needed
376 .It Sy free
377 The ARC's idea of how much free memory there is, which includes evictable memory
378 in the page cache.
379 Since the ARC tries to keep
380 .Sy avail
381 above zero,
382 .Sy avail
383 is usually more instructive to observe than
384 .Sy free .
385 .It Sy avail
386 The ARC's idea of how much free memory is available to it, which is a bit less
387 than
388 .Sy free .
389 May temporarily be negative, in which case the ARC will reduce the target size
390 .Sy c .
393 .Sh OPTIONS
394 .Bl -tag -width "-v"
395 .It Fl a
396 Print all possible stats.
397 .It Fl f
398 Display only specific fields.
400 .Sx DESCRIPTION
401 for supported statistics.
402 .It Fl h
403 Display help message.
404 .It Fl o
405 Report statistics to a file instead of the standard output.
406 .It Fl p
407 Disable auto-scaling of numerical fields (for raw, machine-parsable values).
408 .It Fl s
409 Display data with a specified separator (default: 2 spaces).
410 .It Fl x
411 Print extended stats
412 .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 .
413 .It Fl v
414 Show field headers and definitions
417 .Sh OPERANDS
418 The following operands are supported:
419 .Bl -tag -compact -offset Ds -width "interval"
420 .It Ar interval
421 Specify the sampling interval in seconds.
422 .It Ar count
423 Display only
424 .Ar count
425 reports.