]> git.proxmox.com Git - mirror_zfs-debian.git/blob - man/man5/zfs-events.5
Imported Upstream version 0.6.5.3
[mirror_zfs-debian.git] / man / man5 / zfs-events.5
1 '\" te
2 .\" Copyright (c) 2013 by Turbo Fredriksson <turbo@bayour.com>. All rights reserved.
3 .\" The contents of this file are subject to the terms of the Common Development
4 .\" and Distribution License (the "License"). You may not use this file except
5 .\" in compliance with the License. You can obtain a copy of the license at
6 .\" usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
7 .\"
8 .\" See the License for the specific language governing permissions and
9 .\" limitations under the License. When distributing Covered Code, include this
10 .\" CDDL HEADER in each file and include the License file at
11 .\" usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this
12 .\" CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your
13 .\" own identifying information:
14 .\" Portions Copyright [yyyy] [name of copyright owner]
15 .TH ZFS-EVENTS 5 "Jun 6, 2015"
16 .SH NAME
17 zfs\-events \- Events created by the ZFS filesystem.
18 .SH DESCRIPTION
19 .sp
20 .LP
21 Description of the different events generated by the ZFS stack.
22 .sp
23 Most of these don't have any description. The events generated by ZFS
24 have never been publicly documented. What is here is intended as a
25 starting point to provide documentation for all possible events.
26 .sp
27 To view all events created since the loading of the ZFS infrastructure
28 (i.e, "the module"), run
29 .P
30 .nf
31 \fBzpool events\fR
32 .fi
33 .P
34 to get a short list, and
35 .P
36 .nf
37 \fBzpool events -v\fR
38 .fi
39 .P
40 to get a full detail of the events and what information
41 is available about it.
42 .sp
43 This man page lists the different subclasses that are issued
44 in the case of an event. The full event name would be
45 \fIereport.fs.zfs.SUBCLASS\fR, but we only list the last
46 part here.
47
48 .SS "EVENTS (SUBCLASS)"
49 .sp
50 .LP
51
52 .sp
53 .ne 2
54 .na
55 \fBchecksum\fR
56 .ad
57 .RS 12n
58 Issued when a checksum error have been detected.
59 .RE
60
61 .sp
62 .ne 2
63 .na
64 \fBio\fR
65 .ad
66 .RS 12n
67 Issued when there is an I/O error in a vdev in the pool.
68 .RE
69
70 .sp
71 .ne 2
72 .na
73 \fBdata\fR
74 .ad
75 .RS 12n
76 Issued when there have been data errors in the pool.
77 .RE
78
79 .sp
80 .ne 2
81 .na
82 \fBdelay\fR
83 .ad
84 .RS 12n
85 Issued when an I/O was slow to complete as defined by the zio_delay_max module
86 option.
87 .RE
88
89 .sp
90 .ne 2
91 .na
92 \fBconfig.sync\fR
93 .ad
94 .RS 12n
95 Issued every time a vdev change have been done to the pool.
96 .RE
97
98 .sp
99 .ne 2
100 .na
101 \fBzpool\fR
102 .ad
103 .RS 12n
104 Issued when a pool cannot be imported.
105 .RE
106
107 .sp
108 .ne 2
109 .na
110 \fBzpool.destroy\fR
111 .ad
112 .RS 12n
113 Issued when a pool is destroyed.
114 .RE
115
116 .sp
117 .ne 2
118 .na
119 \fBzpool.export\fR
120 .ad
121 .RS 12n
122 Issued when a pool is exported.
123 .RE
124
125 .sp
126 .ne 2
127 .na
128 \fBzpool.import\fR
129 .ad
130 .RS 12n
131 Issued when a pool is imported.
132 .RE
133
134 .sp
135 .ne 2
136 .na
137 \fBzpool.reguid\fR
138 .ad
139 .RS 12n
140 Issued when a REGUID (new unique identifier for the pool have been regenerated) have been detected.
141 .RE
142
143 .sp
144 .ne 2
145 .na
146 \fBvdev.unknown\fR
147 .ad
148 .RS 12n
149 Issued when the vdev is unknown. Such as trying to clear device
150 errors on a vdev that have failed/been kicked from the system/pool
151 and is no longer available.
152 .RE
153
154 .sp
155 .ne 2
156 .na
157 \fBvdev.open_failed\fR
158 .ad
159 .RS 12n
160 Issued when a vdev could not be opened (because it didn't exist for example).
161 .RE
162
163 .sp
164 .ne 2
165 .na
166 \fBvdev.corrupt_data\fR
167 .ad
168 .RS 12n
169 Issued when corrupt data have been detected on a vdev.
170 .RE
171
172 .sp
173 .ne 2
174 .na
175 \fBvdev.no_replicas\fR
176 .ad
177 .RS 12n
178 Issued when there are no more replicas to sustain the pool.
179 This would lead to the pool being \fIDEGRADED\fR.
180 .RE
181
182 .sp
183 .ne 2
184 .na
185 \fBvdev.bad_guid_sum\fR
186 .ad
187 .RS 12n
188 Issued when a missing device in the pool have been detected.
189 .RE
190
191 .sp
192 .ne 2
193 .na
194 \fBvdev.too_small\fR
195 .ad
196 .RS 12n
197 Issued when the system (kernel) have removed a device, and ZFS
198 notices that the device isn't there any more. This is usually
199 followed by a \fBprobe_failure\fR event.
200 .RE
201
202 .sp
203 .ne 2
204 .na
205 \fBvdev.bad_label\fR
206 .ad
207 .RS 12n
208 Issued when the label is OK but invalid.
209 .RE
210
211 .sp
212 .ne 2
213 .na
214 \fBvdev.bad_ashift\fR
215 .ad
216 .RS 12n
217 Issued when the ashift alignment requirement has increased.
218 .RE
219
220 .sp
221 .ne 2
222 .na
223 \fBvdev.remove\fR
224 .ad
225 .RS 12n
226 Issued when a vdev is detached from a mirror (or a spare detached from a
227 vdev where it have been used to replace a failed drive - only works if
228 the original drive have been readded).
229 .RE
230
231 .sp
232 .ne 2
233 .na
234 \fBvdev.clear\fR
235 .ad
236 .RS 12n
237 Issued when clearing device errors in a pool. Such as running \fBzpool clear\fR
238 on a device in the pool.
239 .RE
240
241 .sp
242 .ne 2
243 .na
244 \fBvdev.check\fR
245 .ad
246 .RS 12n
247 Issued when a check to see if a given vdev could be opened is started.
248 .RE
249
250 .sp
251 .ne 2
252 .na
253 \fBvdev.spare\fR
254 .ad
255 .RS 12n
256 Issued when a spare have kicked in to replace a failed device.
257 .RE
258
259 .sp
260 .ne 2
261 .na
262 \fBvdev.autoexpand\fR
263 .ad
264 .RS 12n
265 Issued when a vdev can be automatically expanded.
266 .RE
267
268 .sp
269 .ne 2
270 .na
271 \fBio_failure\fR
272 .ad
273 .RS 12n
274 Issued when there is an I/O failure in a vdev in the pool.
275 .RE
276
277 .sp
278 .ne 2
279 .na
280 \fBprobe_failure\fR
281 .ad
282 .RS 12n
283 Issued when a probe fails on a vdev. This would occur if a vdeev
284 have been kicked from the system outside of ZFS (such as the kernel
285 have removed the device).
286 .RE
287
288 .sp
289 .ne 2
290 .na
291 \fBlog_replay\fR
292 .ad
293 .RS 12n
294 Issued when the intent log cannot be replayed. The can occur in the case
295 of a missing or damaged log device.
296 .RE
297
298 .sp
299 .ne 2
300 .na
301 \fBresilver.start\fR
302 .ad
303 .RS 12n
304 Issued when a resilver is started.
305 .RE
306
307 .sp
308 .ne 2
309 .na
310 \fBresilver.finish\fR
311 .ad
312 .RS 12n
313 Issued when the running resilver have finished.
314 .RE
315
316 .sp
317 .ne 2
318 .na
319 \fBscrub.start\fR
320 .ad
321 .RS 12n
322 Issued when a scrub is started on a pool.
323 .RE
324
325 .sp
326 .ne 2
327 .na
328 \fBscrub.finish\fR
329 .ad
330 .RS 12n
331 Issued when a pool have finished scrubbing.
332 .RE
333
334 .sp
335 .ne 2
336 .na
337 \fBbootfs.vdev.attach\fR
338 .ad
339 .RS 12n
340 .RE
341
342 .SS "PAYLOADS"
343 .sp
344 .LP
345 This is the payload (data, information) that accompanies an
346 event.
347 .sp
348 For
349 .BR zed (8),
350 these are set to uppercase and prefixed with \fBZEVENT_\fR.
351
352 .sp
353 .ne 2
354 .na
355 \fBpool\fR
356 .ad
357 .RS 12n
358 Pool name.
359 .RE
360
361 .sp
362 .ne 2
363 .na
364 \fBpool_failmode\fR
365 .ad
366 .RS 12n
367 Failmode - \fBwait\fR, \fBcontinue\fR or \fBpanic\fR.
368 See
369 .BR pool (8)
370 (\fIfailmode\fR property) for more information.
371 .RE
372
373 .sp
374 .ne 2
375 .na
376 \fBpool_guid\fR
377 .ad
378 .RS 12n
379 The GUID of the pool.
380 .RE
381
382 .sp
383 .ne 2
384 .na
385 \fBpool_context\fR
386 .ad
387 .RS 12n
388 The load state for the pool (0=none, 1=open, 2=import, 3=tryimport, 4=recover
389 5=error).
390 .RE
391
392 .sp
393 .ne 2
394 .na
395 \fBvdev_guid\fR
396 .ad
397 .RS 12n
398 The GUID of the vdev in question (the vdev failing or operated upon with
399 \fBzpool clear\fR etc).
400 .RE
401
402 .sp
403 .ne 2
404 .na
405 \fBvdev_type\fR
406 .ad
407 .RS 12n
408 Type of vdev - \fBdisk\fR, \fBfile\fR, \fBmirror\fR etc. See
409 .BR zpool (8)
410 under \fBVirtual Devices\fR for more information on possible values.
411 .RE
412
413 .sp
414 .ne 2
415 .na
416 \fBvdev_path\fR
417 .ad
418 .RS 12n
419 Full path of the vdev, including any \fI-partX\fR.
420 .RE
421
422 .sp
423 .ne 2
424 .na
425 \fBvdev_devid\fR
426 .ad
427 .RS 12n
428 ID of vdev (if any).
429 .RE
430
431 .sp
432 .ne 2
433 .na
434 \fBvdev_fru\fR
435 .ad
436 .RS 12n
437 Physical FRU location.
438 .RE
439
440 .sp
441 .ne 2
442 .na
443 \fBvdev_state\fR
444 .ad
445 .RS 12n
446 State of vdev (0=uninitialized, 1=closed, 2=offline, 3=removed, 4=failed to open, 5=faulted, 6=degraded, 7=healty).
447 .RE
448
449 .sp
450 .ne 2
451 .na
452 \fBvdev_ashift\fR
453 .ad
454 .RS 12n
455 The ashift value of the vdev.
456 .RE
457
458 .sp
459 .ne 2
460 .na
461 \fBvdev_complete_ts\fR
462 .ad
463 .RS 12n
464 The time the last I/O completed for the specified vdev.
465 .RE
466
467 .sp
468 .ne 2
469 .na
470 \fBvdev_delta_ts\fR
471 .ad
472 .RS 12n
473 The time since the last I/O completed for the specified vdev.
474 .RE
475
476 .sp
477 .ne 2
478 .na
479 \fBvdev_spare_paths\fR
480 .ad
481 .RS 12n
482 List of spares, including full path and any \fI-partX\fR.
483 .RE
484
485 .sp
486 .ne 2
487 .na
488 \fBvdev_spare_guids\fR
489 .ad
490 .RS 12n
491 GUID(s) of spares.
492 .RE
493
494 .sp
495 .ne 2
496 .na
497 \fBvdev_read_errors\fR
498 .ad
499 .RS 12n
500 How many read errors that have been detected on the vdev.
501 .RE
502
503 .sp
504 .ne 2
505 .na
506 \fBvdev_write_errors\fR
507 .ad
508 .RS 12n
509 How many write errors that have been detected on the vdev.
510 .RE
511
512 .sp
513 .ne 2
514 .na
515 \fBvdev_cksum_errors\fR
516 .ad
517 .RS 12n
518 How many checkum errors that have been detected on the vdev.
519 .RE
520
521 .sp
522 .ne 2
523 .na
524 \fBparent_guid\fR
525 .ad
526 .RS 12n
527 GUID of the vdev parent.
528 .RE
529
530 .sp
531 .ne 2
532 .na
533 \fBparent_type\fR
534 .ad
535 .RS 12n
536 Type of parent. See \fBvdev_type\fR.
537 .RE
538
539 .sp
540 .ne 2
541 .na
542 \fBparent_path\fR
543 .ad
544 .RS 12n
545 Path of the vdev parent (if any).
546 .RE
547
548 .sp
549 .ne 2
550 .na
551 \fBparent_devid\fR
552 .ad
553 .RS 12n
554 ID of the vdev parent (if any).
555 .RE
556
557 .sp
558 .ne 2
559 .na
560 \fBzio_objset\fR
561 .ad
562 .RS 12n
563 The object set number for a given I/O.
564 .RE
565
566 .sp
567 .ne 2
568 .na
569 \fBzio_object\fR
570 .ad
571 .RS 12n
572 The object number for a given I/O.
573 .RE
574
575 .sp
576 .ne 2
577 .na
578 \fBzio_level\fR
579 .ad
580 .RS 12n
581 The block level for a given I/O.
582 .RE
583
584 .sp
585 .ne 2
586 .na
587 \fBzio_blkid\fR
588 .ad
589 .RS 12n
590 The block ID for a given I/O.
591 .RE
592
593 .sp
594 .ne 2
595 .na
596 \fBzio_err\fR
597 .ad
598 .RS 12n
599 The errno for a failure when handling a given I/O.
600 .RE
601
602 .sp
603 .ne 2
604 .na
605 \fBzio_offset\fR
606 .ad
607 .RS 12n
608 The offset in bytes of where to write the I/O for the specified vdev.
609 .RE
610
611 .sp
612 .ne 2
613 .na
614 \fBzio_size\fR
615 .ad
616 .RS 12n
617 The size in bytes of the I/O.
618 .RE
619
620 .sp
621 .ne 2
622 .na
623 \fBzio_flags\fR
624 .ad
625 .RS 12n
626 The current flags describing how the I/O should be handled. See the
627 \fBI/O FLAGS\fR section for the full list of I/O flags.
628 .RE
629
630 .sp
631 .ne 2
632 .na
633 \fBzio_stage\fR
634 .ad
635 .RS 12n
636 The current stage of the I/O in the pipeline. See the \fBI/O STAGES\fR
637 section for a full list of all the I/O stages.
638 .RE
639
640 .sp
641 .ne 2
642 .na
643 \fBzio_pipeline\fR
644 .ad
645 .RS 12n
646 The valid pipeline stages for the I/O. See the \fBI/O STAGES\fR section for a
647 full list of all the I/O stages.
648 .RE
649
650 .sp
651 .ne 2
652 .na
653 \fBzio_delay\fR
654 .ad
655 .RS 12n
656 The time in ticks (HZ) required for the block layer to service the I/O. Unlike
657 \fBzio_delta\fR this does not include any vdev queuing time and is therefore
658 solely a measure of the block layer performance. On most modern Linux systems
659 HZ is defined as 1000 making a tick equivalent to 1 millisecond.
660 .RE
661
662 .sp
663 .ne 2
664 .na
665 \fBzio_timestamp\fR
666 .ad
667 .RS 12n
668 The time when a given I/O was submitted.
669 .RE
670
671 .sp
672 .ne 2
673 .na
674 \fBzio_delta\fR
675 .ad
676 .RS 12n
677 The time required to service a given I/O.
678 .RE
679
680 .sp
681 .ne 2
682 .na
683 \fBprev_state\fR
684 .ad
685 .RS 12n
686 The previous state of the vdev.
687 .RE
688
689 .sp
690 .ne 2
691 .na
692 \fBcksum_expected\fR
693 .ad
694 .RS 12n
695 The expected checksum value.
696 .RE
697
698 .sp
699 .ne 2
700 .na
701 \fBcksum_actual\fR
702 .ad
703 .RS 12n
704 The actual/current checksum value.
705 .RE
706
707 .sp
708 .ne 2
709 .na
710 \fBcksum_algorithm\fR
711 .ad
712 .RS 12n
713 Checksum algorithm used. See \fBzfs\fR(8) for more information on checksum algorithms available.
714 .RE
715
716 .sp
717 .ne 2
718 .na
719 \fBcksum_byteswap\fR
720 .ad
721 .RS 12n
722 Checksum value is byte swapped.
723 .RE
724
725 .sp
726 .ne 2
727 .na
728 \fBbad_ranges\fR
729 .ad
730 .RS 12n
731 Checksum bad offset ranges.
732 .RE
733
734 .sp
735 .ne 2
736 .na
737 \fBbad_ranges_min_gap\fR
738 .ad
739 .RS 12n
740 Checksum allowed minimum gap.
741 .RE
742
743 .sp
744 .ne 2
745 .na
746 \fBbad_range_sets\fR
747 .ad
748 .RS 12n
749 Checksum for each range the number of bits set.
750 .RE
751
752 .sp
753 .ne 2
754 .na
755 \fBbad_range_clears\fR
756 .ad
757 .RS 12n
758 Checksum for each range the number of bits cleared.
759 .RE
760
761 .sp
762 .ne 2
763 .na
764 \fBbad_set_bits\fR
765 .ad
766 .RS 12n
767 Checksum array of bits set.
768 .RE
769
770 .sp
771 .ne 2
772 .na
773 \fBbad_cleared_bits\fR
774 .ad
775 .RS 12n
776 Checksum array of bits cleared.
777 .RE
778
779 .sp
780 .ne 2
781 .na
782 \fBbad_set_histogram\fR
783 .ad
784 .RS 12n
785 Checksum histogram of set bits by bit number in a 64-bit word.
786 .RE
787
788 .sp
789 .ne 2
790 .na
791 \fBbad_cleared_histogram\fR
792 .ad
793 .RS 12n
794 Checksum histogram of cleared bits by bit number in a 64-bit word.
795 .RE
796
797 .SS "I/O STAGES"
798 .sp
799 .LP
800 The ZFS I/O pipeline is comprised of various stages which are defined
801 below. The individual stages are used to construct these basic I/O
802 operations: Read, Write, Free, Claim, and Ioctl. These stages may be
803 set on an event to describe the life cycle of a given I/O.
804
805 .TS
806 tab(:);
807 l l l .
808 Stage:Bit Mask:Operations
809 _:_:_
810 ZIO_STAGE_OPEN:0x00000001:RWFCI
811
812 ZIO_STAGE_READ_BP_INIT:0x00000002:R----
813 ZIO_STAGE_FREE_BP_INIT:0x00000004:--F--
814 ZIO_STAGE_ISSUE_ASYNC:0x00000008:RWF--
815 ZIO_STAGE_WRITE_BP_INIT:0x00000010:-W---
816
817 ZIO_STAGE_CHECKSUM_GENERATE:0x00000020:-W---
818
819 ZIO_STAGE_NOP_WRITE:0x00000040:-W---
820
821 ZIO_STAGE_DDT_READ_START:0x00000080:R----
822 ZIO_STAGE_DDT_READ_DONE:0x00000100:R----
823 ZIO_STAGE_DDT_WRITE:0x00000200:-W---
824 ZIO_STAGE_DDT_FREE:0x00000400:--F--
825
826 ZIO_STAGE_GANG_ASSEMBLE:0x00000800:RWFC-
827 ZIO_STAGE_GANG_ISSUE:0x00001000:RWFC-
828
829 ZIO_STAGE_DVA_ALLOCATE:0x00002000:-W---
830 ZIO_STAGE_DVA_FREE:0x00004000:--F--
831 ZIO_STAGE_DVA_CLAIM:0x00008000:---C-
832
833 ZIO_STAGE_READY:0x00010000:RWFCI
834
835 ZIO_STAGE_VDEV_IO_START:0x00020000:RW--I
836 ZIO_STAGE_VDEV_IO_DONE:0x00040000:RW--I
837 ZIO_STAGE_VDEV_IO_ASSESS:0x00080000:RW--I
838
839 ZIO_STAGE_CHECKSUM_VERIFY0:0x00100000:R----
840
841 ZIO_STAGE_DONE:0x00200000:RWFCI
842 .TE
843
844 .SS "I/O FLAGS"
845 .sp
846 .LP
847 Every I/O in the pipeline contains a set of flags which describe its
848 function and are used to govern its behavior. These flags will be set
849 in an event as an \fBzio_flags\fR payload entry.
850
851 .TS
852 tab(:);
853 l l .
854 Flag:Bit Mask
855 _:_
856 ZIO_FLAG_DONT_AGGREGATE:0x00000001
857 ZIO_FLAG_IO_REPAIR:0x00000002
858 ZIO_FLAG_SELF_HEAL:0x00000004
859 ZIO_FLAG_RESILVER:0x00000008
860 ZIO_FLAG_SCRUB:0x00000010
861 ZIO_FLAG_SCAN_THREAD:0x00000020
862 ZIO_FLAG_PHYSICAL:0x00000040
863
864 ZIO_FLAG_CANFAIL:0x00000080
865 ZIO_FLAG_SPECULATIVE:0x00000100
866 ZIO_FLAG_CONFIG_WRITER:0x00000200
867 ZIO_FLAG_DONT_RETRY:0x00000400
868 ZIO_FLAG_DONT_CACHE:0x00000800
869 ZIO_FLAG_NODATA:0x00001000
870 ZIO_FLAG_INDUCE_DAMAGE:0x00002000
871
872 ZIO_FLAG_IO_RETRY:0x00004000
873 ZIO_FLAG_PROBE:0x00008000
874 ZIO_FLAG_TRYHARD:0x00010000
875 ZIO_FLAG_OPTIONAL:0x00020000
876
877 ZIO_FLAG_DONT_QUEUE:0x00040000
878 ZIO_FLAG_DONT_PROPAGATE:0x00080000
879 ZIO_FLAG_IO_BYPASS:0x00100000
880 ZIO_FLAG_IO_REWRITE:0x00200000
881 ZIO_FLAG_RAW:0x00400000
882 ZIO_FLAG_GANG_CHILD:0x00800000
883 ZIO_FLAG_DDT_CHILD:0x01000000
884 ZIO_FLAG_GODFATHER:0x02000000
885 ZIO_FLAG_NOPWRITE:0x04000000
886 ZIO_FLAG_REEXECUTED:0x08000000
887 ZIO_FLAG_DELEGATED:0x10000000
888 ZIO_FLAG_FASTWRITE:0x20000000
889 .TE