rt/snapraid
1
0
Fork 0
mirror of https://github.com/amadvance/snapraid.git synced 2026-10-26 02:49:02 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Revise log documentation

Browse source
This commit is contained in:
Andrea Mazzoleni 2026-01-18 12:34:03 +01:00
parent b29500c25f
commit 58ca0b7057
3 changed files with 53 additions and 46 deletions
Download patch file Download diff file Expand all files Collapse all files

37
doc/snapraid_log.1
View file

@ -267,13 +267,12 @@ Size of the internal \`snapraid_link\` structure in bytes (uint).
Size of the internal \`snapraid_dir\` structure in bytes (uint).
.SH SCAN TAGS
These tags report detected differences between the filesystem and the
content file. They are output for every discovered change, and
\`scan:equal\` is only output when the \`\-\-gui\` option is used.
content file. They are output for every discovered change.
.TP
.B scan:equal:<disk_name>:<path>
A file, link, or directory is equal (unchanged).
No action is required for this item.
Only with \`\-\-gui\-verbose\`.
Only produced when \`\-\-gui\-verbose\` option is used.
.RS 4
.PD 0
.HP 4
@ -843,13 +842,14 @@ These tags list files with zero sub\-second timestamps.
Lists files that have a zero sub\-second timestamp.
Up to 50 are logged per disk.
.SS Block Information Tags
These tags are generated when the GUI option is enabled (\`state\->opt.gui\`).
Status of all the blocks of the array.
.TP
.B block_count:<uint>
The total number of blocks in the array.
.TP
.B block:<index>:<time>:<used>:<unsynced>:<bad>:<rehash>
Status of a specific block.
Only produced when \`\-\-gui\-verbose\` option is used.
.RS 4
.PD 0
.HP 4
@ -876,6 +876,7 @@ the block has never been scrubbed.
.TP
.B block_noinfo:<index>:<used>:<unsynced>
Status of an unused block (no info recorded) in the content file.
Only produced when \`\-\-gui\-verbose\` option is used.
.RS 4
.PD 0
.HP 4
@ -1582,19 +1583,20 @@ The disk\'s model identifier (escaped).
.PD
.RE
.TP
.B attr:<device_file>:<disk_name>[/<split_index>]:afr:<afr_value>:<afr_prob>
.B attr:<device_file>:<disk_name>[/<split_index>]:afr:<afr>:<prob>
Logs the estimated Annual Failure Rate (AFR) and the
probability of one failure in the next year based on SMART
attributes. The AFR is calculated using the maximum rate
reported by specific SMART attributes (5, 187, 188, 197, 198).
probability of at least one failure in the next year based on
SMART attributes. The AFR is calculated using the SMART
attributes (5, 187, 188, 197, 198).
.RS 4
.PD 0
.HP 4
.I <afr_value>
The computed Annual Failure Rate (float).
.I <afr>
The computed Annual Failure Rate (the average number
of failures you expect in a year) (float).
.HP 4
.I <afr_prob>
The probability of one or more failures in the
.I <prob>
The probability of at least one failure in the
next year (float).
.PD
.RE
@ -1701,19 +1703,18 @@ Tags logging the overall failure probabilities for the array.
.B summary:array_failure:<array_afr>:<array_prob>
Logs the total estimated failure rate for the entire array
(sum of individual disk AFRs) and the probability of at least
one disk failure in the next year.
one failure in the next year.
.RS 4
.PD 0
.HP 4
.I <array_afr>
The sum of AFRs of all disks in the array (float).
The sum of AFRs of all disks in the array (the
average number of failures you expect in a year) (float).
.HP 4
.I <array_prob>
The probability of at least one disk failure in
.PD
.RE
.RS 4
The probability of at least one failure in
the next year (float).
.PD
.RE
.SH DEVICE STATUS TAGS
These tags log the lifecycle of hardware interactions and external

31
doc/snapraid_log.d
View file

@ -198,13 +198,12 @@ Diagnostics Tags
Scan Tags
These tags report detected differences between the filesystem and the
content file. They are output for every discovered change, and
`scan:equal` is only output when the `--gui` option is used.
content file. They are output for every discovered change.
=scan:equal:<disk_name>:<path>
A file, link, or directory is equal (unchanged).
No action is required for this item.
Only with `--gui-verbose`.
Only produced when `--gui-verbose` option is used.
<disk_name> - Name of the data disk.
<path> - Path to the file/link relative to the disk mount
@ -571,13 +570,14 @@ Command Status Tags
Up to 50 are logged per disk.
Block Information Tags
These tags are generated when the GUI option is enabled (`state->opt.gui`).
Status of all the blocks of the array.
=block_count:<uint>
The total number of blocks in the array.
=block:<index>:<time>:<used>:<unsynced>:<bad>:<rehash>
Status of a specific block.
Only produced when `--gui-verbose` option is used.
<index> - Block index.
<time> - Last scrub time (Unix timestamp). A value of 0 means
@ -589,6 +589,7 @@ Command Status Tags
=block_noinfo:<index>:<used>:<unsynced>
Status of an unused block (no info recorded) in the content file.
Only produced when `--gui-verbose` option is used.
<index> - Block index.
<used> - `used` if the block contains data, otherwise empty.
@ -1001,14 +1002,15 @@ Command Smart And Probe Tags
<model> - The disk's model identifier (escaped).
=attr:<device_file>:<disk_name>[/<split_index>]:afr:<afr_value>:<afr_prob>
=attr:<device_file>:<disk_name>[/<split_index>]:afr:<afr>:<prob>
Logs the estimated Annual Failure Rate (AFR) and the
probability of one failure in the next year based on SMART
attributes. The AFR is calculated using the maximum rate
reported by specific SMART attributes (5, 187, 188, 197, 198).
probability of at least one failure in the next year based on
SMART attributes. The AFR is calculated using the SMART
attributes (5, 187, 188, 197, 198).
<afr_value> - The computed Annual Failure Rate (float).
<afr_prob> - The probability of one or more failures in the
<afr> - The computed Annual Failure Rate (the average number
of failures you expect in a year) (float).
<prob> - The probability of at least one failure in the
next year (float).
=attr:<device_file>:<disk_name>[/<split_index>]:size:<size_bytes>
@ -1078,11 +1080,12 @@ Command Smart And Probe Tags
=summary:array_failure:<array_afr>:<array_prob>
Logs the total estimated failure rate for the entire array
(sum of individual disk AFRs) and the probability of at least
one disk failure in the next year.
one failure in the next year.
<array_afr> - The sum of AFRs of all disks in the array (float).
<array_prob> - The probability of at least one disk failure in
the next year (float).
<array_afr> - The sum of AFRs of all disks in the array (the
average number of failures you expect in a year) (float).
<array_prob> - The probability of at least one failure in
the next year (float).
Device Status Tags
These tags log the lifecycle of hardware interactions and external

31
doc/snapraid_log.txt
View file

@ -214,13 +214,12 @@ These tags report the information stored in the content file.
===========
These tags report detected differences between the filesystem and the
content file. They are output for every discovered change, and
`scan:equal` is only output when the `--gui` option is used.
content file. They are output for every discovered change.
scan:equal:<disk_name>:<path>
A file, link, or directory is equal (unchanged).
No action is required for this item.
Only with `--gui-verbose`.
Only produced when `--gui-verbose` option is used.
<disk_name> - Name of the data disk.
<path> - Path to the file/link relative to the disk mount
@ -596,13 +595,14 @@ These tags list files with zero sub-second timestamps.
Up to 50 are logged per disk.
---- 8.0.4 Block Information Tags ----
These tags are generated when the GUI option is enabled (`state->opt.gui`).
Status of all the blocks of the array.
block_count:<uint>
The total number of blocks in the array.
block:<index>:<time>:<used>:<unsynced>:<bad>:<rehash>
Status of a specific block.
Only produced when `--gui-verbose` option is used.
<index> - Block index.
<time> - Last scrub time (Unix timestamp). A value of 0 means
@ -614,6 +614,7 @@ These tags are generated when the GUI option is enabled (`state->opt.gui`).
block_noinfo:<index>:<used>:<unsynced>
Status of an unused block (no info recorded) in the content file.
Only produced when `--gui-verbose` option is used.
<index> - Block index.
<used> - `used` if the block contains data, otherwise empty.
@ -1047,14 +1048,15 @@ Tags logging specific disk identification and attribute values.
<model> - The disk's model identifier (escaped).
attr:<device_file>:<disk_name>[/<split_index>]:afr:<afr_value>:<afr_prob>
attr:<device_file>:<disk_name>[/<split_index>]:afr:<afr>:<prob>
Logs the estimated Annual Failure Rate (AFR) and the
probability of one failure in the next year based on SMART
attributes. The AFR is calculated using the maximum rate
reported by specific SMART attributes (5, 187, 188, 197, 198).
probability of at least one failure in the next year based on
SMART attributes. The AFR is calculated using the SMART
attributes (5, 187, 188, 197, 198).
<afr_value> - The computed Annual Failure Rate (float).
<afr_prob> - The probability of one or more failures in the
<afr> - The computed Annual Failure Rate (the average number
of failures you expect in a year) (float).
<prob> - The probability of at least one failure in the
next year (float).
attr:<device_file>:<disk_name>[/<split_index>]:size:<size_bytes>
@ -1124,11 +1126,12 @@ Tags logging the overall failure probabilities for the array.
summary:array_failure:<array_afr>:<array_prob>
Logs the total estimated failure rate for the entire array
(sum of individual disk AFRs) and the probability of at least
one disk failure in the next year.
one failure in the next year.
<array_afr> - The sum of AFRs of all disks in the array (float).
<array_prob> - The probability of at least one disk failure in
the next year (float).
<array_afr> - The sum of AFRs of all disks in the array (the
average number of failures you expect in a year) (float).
<array_prob> - The probability of at least one failure in
the next year (float).
16 DEVICE STATUS TAGS