sys/contrib/openzfs/man/man1/arcstat.1

   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 .\"
  12 .\" Copyright 2014 Adam Stevko.  All rights reserved.
  13 .\" Copyright (c) 2015 by Delphix. All rights reserved.
  14 .\" Copyright (c) 2020 by AJ Jordan. All rights reserved.
  15 .\"
  16 .TH ARCSTAT 1 "Aug 24, 2020" OpenZFS
  17 .SH NAME
  18 arcstat \- report ZFS ARC and L2ARC statistics
  19 .SH SYNOPSIS
  20 .LP
  21 .nf
  22 \fBarcstat\fR [\fB-hvx\fR] [\fB-f field[,field]...\fR] [\fB-o file\fR] [\fB-s string\fR] [\fBinterval\fR [\fBcount\fR]]
  23 .fi
  24
  25 .SH DESCRIPTION
  26 .LP
  27 The \fBarcstat\fR utility print various ZFS ARC and L2ARC statistics in
  28 vmstat-like fashion.
  29 .sp
  30
  31 .sp
  32 .LP
  33 The \fBarcstat\fR command reports the following information:
  34 .sp
  35 .ne 2
  36
  37 .\"
  38 .sp
  39 .ne 1
  40 .na
  41 \fBc \fR
  42 .ad
  43 .RS 14n
  44 ARC target size
  45 .RE
  46
  47 .sp
  48 .ne 2
  49 .na
  50 \fBdh% \fR
  51 .ad
  52 .RS 14n
  53 Demand data hit percentage
  54 .RE
  55
  56 .sp
  57 .ne 2
  58 .na
  59 \fBdm% \fR
  60 .ad
  61 .RS 14n
  62 Demand data miss percentage
  63 .RE
  64
  65 .sp
  66 .ne 2
  67 .na
  68 \fBmfu \fR
  69 .ad
  70 .RS 14n
  71 MFU list hits per second
  72 .RE
  73
  74 .sp
  75 .ne 2
  76 .na
  77 \fBmh% \fR
  78 .ad
  79 .RS 14n
  80 Metadata hit percentage
  81 .RE
  82
  83 .sp
  84 .ne 2
  85 .na
  86 \fBmm% \fR
  87 .ad
  88 .RS 14n
  89 Metadata miss percentage
  90 .RE
  91
  92 .sp
  93 .ne 2
  94 .na
  95 \fBmru \fR
  96 .ad
  97 .RS 14n
  98 MRU list hits per second
  99 .RE
 100
 101 .sp
 102 .ne 2
 103 .na
 104 \fBph% \fR
 105 .ad
 106 .RS 14n
 107 Prefetch hits percentage
 108 .RE
 109
 110 .sp
 111 .ne 2
 112 .na
 113 \fBpm% \fR
 114 .ad
 115 .RS 14n
 116 Prefetch miss percentage
 117 .RE
 118
 119 .sp
 120 .ne 2
 121 .na
 122 \fBdhit \fR
 123 .ad
 124 .RS 14n
 125 Demand data hits per second
 126 .RE
 127
 128 .sp
 129 .ne 2
 130 .na
 131 \fBdmis \fR
 132 .ad
 133 .RS 14n
 134 Demand data misses per second
 135 .RE
 136
 137 .sp
 138 .ne 2
 139 .na
 140 \fBhit% \fR
 141 .ad
 142 .RS 14n
 143 ARC hit percentage
 144 .RE
 145
 146 .sp
 147 .ne 2
 148 .na
 149 \fBhits \fR
 150 .ad
 151 .RS 14n
 152 ARC reads per second
 153 .RE
 154
 155 .sp
 156 .ne 2
 157 .na
 158 \fBmfug \fR
 159 .ad
 160 .RS 14n
 161 MFU ghost list hits per second
 162 .RE
 163
 164 .sp
 165 .ne 2
 166 .na
 167 \fBmhit \fR
 168 .ad
 169 .RS 14n
 170 Metadata hits per second
 171 .RE
 172
 173 .sp
 174 .ne 2
 175 .na
 176 \fBmiss \fR
 177 .ad
 178 .RS 14n
 179 ARC misses per second
 180 .RE
 181
 182 .sp
 183 .ne 2
 184 .na
 185 \fBmmis \fR
 186 .ad
 187 .RS 14n
 188 Metadata misses per second
 189 .RE
 190
 191 .sp
 192 .ne 2
 193 .na
 194 \fBmrug \fR
 195 .ad
 196 .RS 14n
 197 MRU ghost list hits per second
 198 .RE
 199
 200 .sp
 201 .ne 2
 202 .na
 203 \fBphit \fR
 204 .ad
 205 .RS 14n
 206 Prefetch hits per second
 207 .RE
 208
 209 .sp
 210 .ne 2
 211 .na
 212 \fBpmis \fR
 213 .ad
 214 .RS 14n
 215 Prefetch misses per second
 216 .RE
 217
 218 .sp
 219 .ne 2
 220 .na
 221 \fBread \fR
 222 .ad
 223 .RS 14n
 224 Total ARC accesses per second
 225 .RE
 226
 227 .sp
 228 .ne 2
 229 .na
 230 \fBtime \fR
 231 .ad
 232 .RS 14n
 233 Time
 234 .RE
 235
 236 .sp
 237 .ne 2
 238 .na
 239 \fBsize \fR
 240 .ad
 241 .RS 14n
 242 ARC size
 243 .RE
 244
 245 .sp
 246 .ne 2
 247 .na
 248 \fBarcsz \fR
 249 .ad
 250 .RS 14n
 251 Alias for \fBsize\fR
 252 .RE
 253
 254 .sp
 255 .ne 2
 256 .na
 257 \fBdread \fR
 258 .ad
 259 .RS 14n
 260 Demand data accesses per second
 261 .RE
 262
 263 .sp
 264 .ne 2
 265 .na
 266 \fBeskip \fR
 267 .ad
 268 .RS 14n
 269 evict_skip per second
 270 .RE
 271
 272 .sp
 273 .ne 2
 274 .na
 275 \fBmiss% \fR
 276 .ad
 277 .RS 14n
 278 ARC miss percentage
 279 .RE
 280
 281 .sp
 282 .ne 2
 283 .na
 284 \fBmread \fR
 285 .ad
 286 .RS 14n
 287 Metadata accesses per second
 288 .RE
 289
 290 .sp
 291 .ne 2
 292 .na
 293 \fBpread \fR
 294 .ad
 295 .RS 14n
 296 Prefetch accesses per second
 297 .RE
 298
 299 .sp
 300 .ne 2
 301 .na
 302 \fBl2hit% \fR
 303 .ad
 304 .RS 14n
 305 L2ARC access hit percentage
 306 .RE
 307
 308 .sp
 309 .ne 2
 310 .na
 311 \fBl2hits \fR
 312 .ad
 313 .RS 14n
 314 L2ARC hits per second
 315 .RE
 316
 317 .sp
 318 .ne 2
 319 .na
 320 \fBl2miss \fR
 321 .ad
 322 .RS 14n
 323 L2ARC misses per second
 324 .RE
 325
 326 .sp
 327 .ne 2
 328 .na
 329 \fBl2read \fR
 330 .ad
 331 .RS 14n
 332 Total L2ARC accesses per second
 333 .RE
 334
 335 .sp
 336 .ne 2
 337 .na
 338 \fBl2size \fR
 339 .ad
 340 .RS 14n
 341 Size of the L2ARC
 342 .RE
 343
 344 .sp
 345 .ne 2
 346 .na
 347 \fBmtxmis \fR
 348 .ad
 349 .RS 14n
 350 mutex_miss per second
 351 .RE
 352
 353 .sp
 354 .ne 2
 355 .na
 356 \fBl2bytes \fR
 357 .ad
 358 .RS 14n
 359 Bytes read per second from the L2ARC
 360 .RE
 361
 362 .sp
 363 .ne 2
 364 .na
 365 \fBl2miss% \fR
 366 .ad
 367 .RS 14n
 368 L2ARC access miss percentage
 369 .RE
 370
 371 .sp
 372 .ne 2
 373 .na
 374 \fBl2asize \fR
 375 .ad
 376 .RS 14n
 377 Actual (compressed) size of the L2ARC
 378 .RE
 379
 380 .sp
 381 .ne 2
 382 .na
 383 \fBgrow \fR
 384 .ad
 385 .RS 14n
 386 ARC grow disabled
 387 .RE
 388
 389 .sp
 390 .ne 2
 391 .na
 392 \fBneed \fR
 393 .ad
 394 .RS 14n
 395 ARC reclaim needed
 396 .RE
 397
 398 .sp
 399 .ne 2
 400 .na
 401 \fBfree \fR
 402 .ad
 403 .RS 14n
 404 The ARC's idea of how much free memory there is, which includes evictable memory in the page cache.
 405 Since the ARC tries to keep \fBavail\fR above zero, \fBavail\fR is usually more instructive to observe than \fBfree\fR.
 406 .RE
 407
 408 .sp
 409 .ne 2
 410 .na
 411 \fBavail \fR
 412 .ad
 413 .RS 14n
 414 The ARC's idea of how much free memory is available to it, which is a bit less than \fBfree\fR.
 415 May temporarily be negative, in which case the ARC will reduce the target size \fBc\fR.
 416 .RE
 417 .\"
 418
 419 .SH OPTIONS
 420 .LP
 421 The following options are supported:
 422
 423 .sp
 424 .ne 2
 425 .na
 426 \fB\fB-f\fR\fR
 427 .ad
 428 .RS 12n
 429 Display only specific fields. See \fBDESCRIPTION\fR for supported statistics.
 430 .RE
 431
 432 .sp
 433 .ne 2
 434 .na
 435 \fB\fB-h\fR\fR
 436 .ad
 437 .RS 12n
 438 Display help message.
 439 .RE
 440
 441 .sp
 442 .ne 2
 443 .na
 444 \fB\fB-o\fR\fR
 445 .ad
 446 .RS 12n
 447 Report statistics to a file instead of the standard output.
 448 .RE
 449
 450 .sp
 451 .ne 2
 452 .na
 453 \fB\fB-s\fR\fR
 454 .ad
 455 .RS 12n
 456 Display data with a specified separator (default: 2 spaces).
 457 .RE
 458
 459 .sp
 460 .ne 2
 461 .na
 462 \fB\fB-x\fR\fR
 463 .ad
 464 .RS 12n
 465 Print extended stats (same as -f time,mfu,mru,mfug,mrug,eskip,mtxmis,dread,pread,read).
 466 .RE
 467
 468 .sp
 469 .ne 2
 470 .na
 471 \fB\fB-v\fR\fR
 472 .ad
 473 .RS 12n
 474 Show field headers and definitions
 475 .RE
 476
 477 .SH OPERANDS
 478 .LP
 479 The following operands are supported:
 480 .sp
 481 .ne 2
 482 .na
 483 \fB\fIcount\fR\fR
 484 .ad
 485 .RS 12n
 486 Display only \fIcount\fR reports.
 487 .RE
 488
 489 .sp
 490 .ne 2
 491 .na
 492 \fB\fIinterval\fR\fR
 493 .ad
 494 .RS 12n
 495 Specify the sampling interval in seconds.
 496 .RE
 497
 498 .SH AUTHORS
 499 .LP
 500 arcstat was originally written in Perl by Neelakanth Nadgir and supported only ZFS ARC statistics.
 501 Mike Harsch updated it to support L2ARC statistics.
 502 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.