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

In the log all the integer should be assumed 64 bits

Browse source
This commit is contained in:
Andrea Mazzoleni 2026-01-16 10:16:27 +01:00
parent 9d383f08c9
commit be3c5bf8eb
4 changed files with 186 additions and 163 deletions
Download patch file Download diff file Expand all files Collapse all files

2
cmdline/list.c
View file

@ -62,7 +62,7 @@ void state_list(struct snapraid_state* state)
file_size += file->size;
if (state->opt.gui_verbose)
log_tag("file:%s:%s:%" PRIu64 ":%" PRIi64 ":%u:%" PRIi64 "\n", disk->name, esc_tag(file->sub, esc_buffer), file->size, file->mtime_sec, file->mtime_nsec, file->inode);
log_tag("file:%s:%s:%" PRIu64 ":%" PRIi64 ":%u:%" PRIu64 "\n", disk->name, esc_tag(file->sub, esc_buffer), file->size, file->mtime_sec, file->mtime_nsec, file->inode);
t = file->mtime_sec;
#if HAVE_LOCALTIME_R

116
doc/snapraid_log.1
View file

@ -67,9 +67,16 @@ is escaped to \\\\.
.PD
.RE
.PP
Some tags are output only when the \`\-\-gui\` option is used. They provide
extra verbose state and runtime progress only useful for a GUI
interface.
Some tags are output only when the \`\-\-gui\` or \`\-\-gui\-verbose\` option
is used. They provide extra verbose state and runtime progress only
useful for a GUI interface.
.PP
Integer values are marked as \`uint\` when they are unsigned and as \`int\`
when they are signed. However, for practical purposes you can treat
all of them as signed integers.
All integer values should be assumed to be 64 bits wide, regardless
of the signed/unsigned marker.
Floating point values are marked as \`float\`.
.SH CONFIGURATION TAGS
These tags report the memory usage and global configuration.
.TP
@ -133,7 +140,7 @@ This is the optional mount point for the \'share\' feature.
.TP
.B autosave:<bytes>
If the autosave feature is enabled, and after how many bytes
(uint64). This specifies the interval for content file saving.
(uint). This specifies the interval for content file saving.
.TP
.B filter:<pattern>
All the active filters with their patterns. These patterns
@ -175,7 +182,7 @@ in the content file.
The path (escaped).
.HP 4
.I <size>
The size of the parity file (uint64).
The size of the parity file (uint).
.PD
.RE
.TP
@ -202,10 +209,10 @@ The size of disk and parity as stored in the content file.
Name of the data or parity disk.
.HP 4
.I <size>
The size of the data in the disk or parity (uint64).
The size of the data in the disk or parity (uint).
.HP 4
.I <free_size>
The free size in the disk or parity (uint64).
The free size in the disk or parity (uint).
.PD
.RE
.TP
@ -228,7 +235,7 @@ The number of elements (uint)
The version of SnapRAID run.
.TP
.B unixtime:<time>
The current time in the unix format (uint64), representing
The current time in the unix format (uint), representing
seconds since the epoch.
.TP
.B time:<YYYY\-MM\-DD HH:MM:SS>
@ -242,30 +249,31 @@ All the arguments of the executable command. The 0 one is the
executable run.
.TP
.B memory:used:<bytes>
The total memory currently used by the application in bytes (uint64).
The total memory currently used by the application in bytes (uint).
.TP
.B memory:block:<bytes>
Size of the internal \`snapraid_block\` structure in bytes (uint64).
Size of the internal \`snapraid_block\` structure in bytes (uint).
.TP
.B memory:extent:<bytes>
Size of the internal \`snapraid_extent\` structure in bytes (uint64).
Size of the internal \`snapraid_extent\` structure in bytes (uint).
.TP
.B memory:file:<bytes>
Size of the internal \`snapraid_file\` structure in bytes (uint64).
Size of the internal \`snapraid_file\` structure in bytes (uint).
.TP
.B memory:link:<bytes>
Size of the internal \`snapraid_link\` structure in bytes (uint64).
Size of the internal \`snapraid_link\` structure in bytes (uint).
.TP
.B memory:dir:<bytes>
Size of the internal \`snapraid_dir\` structure in bytes (uint64).
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.
.TP
.B scan:equal:<disk_name>:<path>
A file, link, or directory is equal (unchanged) (GUI only).
A file, link, or directory is equal (unchanged).
No action is required for this item.
Only with \`\-\-gui\-verbose\`.
.RS 4
.PD 0
.HP 4
@ -409,7 +417,7 @@ Current block index position processed (uint).
Number of blocks processed (uint).
.HP 4
.I <sizedone>
Current size processed (uint64).
Current size processed (uint).
.HP 4
.I <perc>
Completion percentage (uint).
@ -554,7 +562,7 @@ by \`/N\` to indicate the split index, where N starts
from 0. The \`/0\` is always omitted.
.HP 4
.I <device>
The unique device ID (uint64).
The unique device ID (uint).
.HP 4
.I <temp>
The current temperature read from the disk in degrees
@ -582,7 +590,7 @@ Only monotone increasing temperatures are included in the history.
.PD 0
.HP 4
.I <device>
The unique device ID (uint64).
The unique device ID (uint).
.HP 4
.I <count>
The total number of collected data points (uint).
@ -610,26 +618,26 @@ where T_0 is the initial temperature.
.PD 0
.HP 4
.I <device>
The unique device ID (uint64).
The unique device ID (uint).
.HP 4
.I <k_heat>
The heating rate constant, k (double).
The heating rate constant, k (float).
.HP 4
.I <t_ambient>
The ambient temperature, T_ambient (double).
The ambient temperature, T_ambient (float).
.HP 4
.I <t_steady>
The estimated steady\-state temperature, T_steady (double),
The estimated steady\-state temperature, T_steady (float),
which is the maximum expected temperature of the disk.
.HP 4
.I <rmse>
Root Mean Square Error of the fit (double).
Root Mean Square Error of the fit (float).
.HP 4
.I <r_squared>
Coefficient of determination (R^2) of the fit (double).
Coefficient of determination (R^2) of the fit (float).
.HP 4
.I <max_error>
Maximum absolute error of the fit (double).
Maximum absolute error of the fit (float).
.PD
.RE
.TP
@ -681,7 +689,7 @@ This determines the maximum size of data that can be added.
.B summary:file_count:<uint>
Total number of files in the array.
.TP
.B summary:file_block_count:<uint64>
.B summary:file_block_count:<uint>
Total number of data blocks used by files.
.TP
.B summary:fragmented_file_count:<uint>
@ -696,13 +704,13 @@ This is a measure of data fragmentation overhead.
Total number of files with a zero sub\-second timestamp. This
can occur on certain filesystems and may affect change detection.
.TP
.B summary:file_size:<uint64>
.B summary:file_size:<uint>
Total size of all files in bytes.
.TP
.B summary:parity_size:<uint64>
.B summary:parity_size:<uint>
Total size of allocated parity blocks in bytes.
.TP
.B summary:parity_size_max:<uint64>
.B summary:parity_size_max:<uint>
Maximum possible parity size (allocated + min free) in bytes.
This is the effective maximum protection size.
.TP
@ -716,14 +724,14 @@ The previous hash algorithm used, if a rehash is in progress.
The best hash algorithm for optimal performance based on
system capabilities.
.TP
.B summary:total_wasted:<uint64>
.B summary:total_wasted:<uint>
Total wasted space (space on data disks exceeding parity
capacity) in bytes.
.TP
.B summary:total_used:<uint64>
.B summary:total_used:<uint>
Total used space by data files in bytes.
.TP
.B summary:total_free:<uint64>
.B summary:total_free:<uint>
Total free space (usable by data) in bytes, limited by parity
capacity.
.TP
@ -793,7 +801,7 @@ Number of excess fragments on the disk.
.B summary:disk_zerosubsecond_file_count:<name>:<uint>
Number of files with zero sub\-second timestamp on the disk.
.TP
.B summary:disk_file_size:<name>:<uint64>
.B summary:disk_file_size:<name>:<uint>
Total size of files on the disk in bytes.
.TP
.B summary:disk_block_allocated:<name>:<uint>
@ -817,14 +825,14 @@ This is the logical limit imposed by the parity files.
.B summary:disk_block_max:<name>:<uint>
Maximum usable blocks (minimum of \`..._by_space\` and \`..._by_parity\`).
.TP
.B summary:disk_space_wasted:<name>:<int64>
.B summary:disk_space_wasted:<name>:<int>
Wasted space on the disk in bytes (positive if disk is larger
than usable parity space).
.TP
.B summary:disk_used:<name>:<uint64>
.B summary:disk_used:<name>:<uint>
Used space on the disk in bytes.
.TP
.B summary:disk_free:<name>:<uint64>
.B summary:disk_free:<name>:<uint>
Free usable space on the disk in bytes, limited by \`disk_block_max\`.
.TP
.B summary:disk_use_percent:<name>:<uint>
@ -1316,18 +1324,18 @@ The path of the file relative to the disk\'s root
(escaped).
.HP 4
.I <size>
The size of the file in bytes (uint64).
The size of the file in bytes (uint).
.HP 4
.I <mtime_sec>
The file\'s modification time in seconds since the
Epoch (int64).
Epoch (int).
.HP 4
.I <mtime_nsec>
The file\'s modification time nanosecond component
(uint).
.HP 4
.I <inode>
The file\'s inode number (int64).
The file\'s inode number (uint).
.PD
.RE
.TP
@ -1372,7 +1380,7 @@ Logs the total size of all regular files processed.
.PD 0
.HP 4
.I <size>
The cumulative size of all files (uint64, bytes).
The cumulative size of all files (uint, bytes).
.PD
.RE
.TP
@ -1423,7 +1431,7 @@ The path of the previously processed duplicate file
relative to its disk\'s mount point (escaped).
.HP 4
.I <size>
The size of the duplicate file in bytes (uint64). This
The size of the duplicate file in bytes (uint). This
size corresponds to the file \`<file_path2>\`.
.PD
.RE
@ -1448,7 +1456,7 @@ the sum of the sizes of all files considered duplicates.
.PD 0
.HP 4
.I <size>
The total size of duplicate files in gigabytes (uint64).
The total size of duplicate files in gigabytes (uint).
.PD
.RE
.TP
@ -1584,11 +1592,11 @@ reported by specific SMART attributes (5, 187, 188, 197, 198).
.PD 0
.HP 4
.I <afr_value>
The computed Annual Failure Rate (double).
The computed Annual Failure Rate (float).
.HP 4
.I <afr_prob>
The probability of one or more failures in the
next year (double).
next year (float).
.PD
.RE
.TP
@ -1598,7 +1606,7 @@ Logs the size of the disk.
.PD 0
.HP 4
.I <size_bytes>
The disk size in bytes (uint64).
The disk size in bytes (uint).
.PD
.RE
.TP
@ -1608,7 +1616,7 @@ Logs the total error count.
.PD 0
.HP 4
.I <error_count>
The total error count (uint64).
The total error count (uint).
.PD
.RE
.TP
@ -1636,10 +1644,10 @@ returned \'DISK FAILING\'\`.
.PD 0
.HP 4
.I <flags_decimal>
The raw flags value (uint64, decimal).
The raw flags value (uint, decimal).
.HP 4
.I <flags_hex>
The raw flags value (uint64, hexadecimal).
The raw flags value (uint, hexadecimal).
.PD
.RE
.TP
@ -1652,10 +1660,10 @@ Logs the raw value of any assigned SMART attribute.
The SMART attribute ID (uint).
.HP 4
.I <value_decimal>
The raw attribute value (uint64, decimal).
The raw attribute value (uint, decimal).
.HP 4
.I <value_hex>
The raw attribute value (uint64, hexadecimal).
The raw attribute value (uint, hexadecimal).
.PD
.RE
.TP
@ -1685,7 +1693,7 @@ disk was used during that time.
.PD 0
.HP 4
.I <access_number>
Total number of accesses (int64).
Total number of accesses (uint).
.PD
.RE
.SS Summary
@ -1699,14 +1707,14 @@ one disk failure in the next year.
.PD 0
.HP 4
.I <array_afr>
The sum of AFRs of all disks in the array (double).
The sum of AFRs of all disks in the array (float).
.HP 4
.I <array_prob>
The probability of at least one disk failure in
.PD
.RE
.RS 4
the next year (double).
the next year (float).
.RE
.SH DEVICE STATUS TAGS
These tags log the lifecycle of hardware interactions and external
@ -1754,7 +1762,7 @@ exit code that was not explicitly recognized as a valid state.
.HP 4
.I <exit_code>
The integer exit status returned by the
process.
process (int).
.PD
.RE
.SH ERROR TAGS

115
doc/snapraid_log.d
View file

@ -47,10 +47,16 @@ Description
The carriage return - is escaped to \r.
The backslash - is escaped to \\.
Some tags are output only when the `--gui` option is used. They provide
extra verbose state and runtime progress only useful for a GUI
interface.
Some tags are output only when the `--gui` or `--gui-verbose` option
is used. They provide extra verbose state and runtime progress only
useful for a GUI interface.
Integer values are marked as `uint` when they are unsigned and as `int`
when they are signed. However, for practical purposes you can treat
all of them as signed integers.
All integer values should be assumed to be 64 bits wide, regardless
of the signed/unsigned marker.
Floating point values are marked as `float`.
Configuration Tags
These tags report the memory usage and global configuration.
@ -97,7 +103,7 @@ Configuration Tags
=autosave:<bytes>
If the autosave feature is enabled, and after how many bytes
(uint64). This specifies the interval for content file saving.
(uint). This specifies the interval for content file saving.
=filter:<pattern>
All the active filters with their patterns. These patterns
@ -131,7 +137,7 @@ Content Tags
<uuid> - The UUID of the disk containing the path as stored
in the content file.
<path> - The path (escaped).
<size> - The size of the parity file (uint64).
<size> - The size of the parity file (uint).
=content_data:<disk_name>:<uuid>
The data disk as stored in the content file.
@ -144,8 +150,8 @@ Content Tags
The size of disk and parity as stored in the content file.
<disk_name> - Name of the data or parity disk.
<size> - The size of the data in the disk or parity (uint64).
<free_size> - The free size in the disk or parity (uint64).
<size> - The size of the data in the disk or parity (uint).
<free_size> - The free size in the disk or parity (uint).
=content_info:<kind>:<counter>
The counters in the content file.
@ -159,7 +165,7 @@ Diagnostics Tags
The version of SnapRAID run.
=unixtime:<time>
The current time in the unix format (uint64), representing
The current time in the unix format (uint), representing
seconds since the epoch.
=time:<YYYY-MM-DD HH:MM:SS>
@ -173,22 +179,22 @@ Diagnostics Tags
executable run.
=memory:used:<bytes>
The total memory currently used by the application in bytes (uint64).
The total memory currently used by the application in bytes (uint).
=memory:block:<bytes>
Size of the internal `snapraid_block` structure in bytes (uint64).
Size of the internal `snapraid_block` structure in bytes (uint).
=memory:extent:<bytes>
Size of the internal `snapraid_extent` structure in bytes (uint64).
Size of the internal `snapraid_extent` structure in bytes (uint).
=memory:file:<bytes>
Size of the internal `snapraid_file` structure in bytes (uint64).
Size of the internal `snapraid_file` structure in bytes (uint).
=memory:link:<bytes>
Size of the internal `snapraid_link` structure in bytes (uint64).
Size of the internal `snapraid_link` structure in bytes (uint).
=memory:dir:<bytes>
Size of the internal `snapraid_dir` structure in bytes (uint64).
Size of the internal `snapraid_dir` structure in bytes (uint).
Scan Tags
These tags report detected differences between the filesystem and the
@ -196,8 +202,9 @@ Scan Tags
`scan:equal` is only output when the `--gui` option is used.
=scan:equal:<disk_name>:<path>
A file, link, or directory is equal (unchanged) (GUI only).
A file, link, or directory is equal (unchanged).
No action is required for this item.
Only with `--gui-verbose`.
<disk_name> - Name of the data disk.
<path> - Path to the file/link/dir relative to the disk mount
@ -298,7 +305,7 @@ General Progress and Execution Tags
<blockidx> - Current block index position processed (uint).
<blockdone> - Number of blocks processed (uint).
<sizedone> - Current size processed (uint64).
<sizedone> - Current size processed (uint).
<perc> - Completion percentage (uint).
<eta> - Estimated time to completion in seconds (uint).
<speed_mbs> - Data processing speed in MB/s (uint).
@ -373,7 +380,7 @@ Thermal Tags
In case of split parity, the parity name is followed
by `/N` to indicate the split index, where N starts
from 0. The `/0` is always omitted.
<device> - The unique device ID (uint64).
<device> - The unique device ID (uint).
<temp> - The current temperature read from the disk in degrees
Celsius.
@ -389,7 +396,7 @@ Thermal Tags
so far for a specific disk, used for fitting the heating model.
Only monotone increasing temperatures are included in the history.
<device> - The unique device ID (uint64).
<device> - The unique device ID (uint).
<count> - The total number of collected data points (uint).
<data_points> - A comma-separated list of temperature/time pairs.
Each pair is formatted as <temp>/<time_offset>.
@ -404,14 +411,14 @@ Thermal Tags
The model is: T(t) = T_steady - (T_steady - T_0) e^(-kt),
where T_0 is the initial temperature.
<device> - The unique device ID (uint64).
<k_heat> - The heating rate constant, k (double).
<t_ambient> - The ambient temperature, T_ambient (double).
<t_steady> - The estimated steady-state temperature, T_steady (double),
<device> - The unique device ID (uint).
<k_heat> - The heating rate constant, k (float).
<t_ambient> - The ambient temperature, T_ambient (float).
<t_steady> - The estimated steady-state temperature, T_steady (float),
which is the maximum expected temperature of the disk.
<rmse> - Root Mean Square Error of the fit (double).
<r_squared> - Coefficient of determination (R^2) of the fit (double).
<max_error> - Maximum absolute error of the fit (double).
<rmse> - Root Mean Square Error of the fit (float).
<r_squared> - Coefficient of determination (R^2) of the fit (float).
<max_error> - Maximum absolute error of the fit (float).
=thermal:spindown
Indicates that the thermal alarm limit has been reached, and
@ -452,7 +459,7 @@ Command Status Tags
This determines the maximum size of data that can be added.
=summary:file_count:<uint>
Total number of files in the array.
=summary:file_block_count:<uint64>
=summary:file_block_count:<uint>
Total number of data blocks used by files.
=summary:fragmented_file_count:<uint>
Total number of fragmented files, meaning files whose blocks
@ -463,11 +470,11 @@ Command Status Tags
=summary:zerosubsecond_file_count:<uint>
Total number of files with a zero sub-second timestamp. This
can occur on certain filesystems and may affect change detection.
=summary:file_size:<uint64>
=summary:file_size:<uint>
Total size of all files in bytes.
=summary:parity_size:<uint64>
=summary:parity_size:<uint>
Total size of allocated parity blocks in bytes.
=summary:parity_size_max:<uint64>
=summary:parity_size_max:<uint>
Maximum possible parity size (allocated + min free) in bytes.
This is the effective maximum protection size.
=summary:hash:<name>
@ -477,12 +484,12 @@ Command Status Tags
=summary:best_hash:<name>
The best hash algorithm for optimal performance based on
system capabilities.
=summary:total_wasted:<uint64>
=summary:total_wasted:<uint>
Total wasted space (space on data disks exceeding parity
capacity) in bytes.
=summary:total_used:<uint64>
=summary:total_used:<uint>
Total used space by data files in bytes.
=summary:total_free:<uint64>
=summary:total_free:<uint>
Total free space (usable by data) in bytes, limited by parity
capacity.
=summary:total_use_percent:<uint>
@ -530,7 +537,7 @@ Command Status Tags
Number of excess fragments on the disk.
=summary:disk_zerosubsecond_file_count:<name>:<uint>
Number of files with zero sub-second timestamp on the disk.
=summary:disk_file_size:<name>:<uint64>
=summary:disk_file_size:<name>:<uint>
Total size of files on the disk in bytes.
=summary:disk_block_allocated:<name>:<uint>
Highest block index used on the disk + 1.
@ -547,12 +554,12 @@ Command Status Tags
This is the logical limit imposed by the parity files.
=summary:disk_block_max:<name>:<uint>
Maximum usable blocks (minimum of `..._by_space` and `..._by_parity`).
=summary:disk_space_wasted:<name>:<int64>
=summary:disk_space_wasted:<name>:<int>
Wasted space on the disk in bytes (positive if disk is larger
than usable parity space).
=summary:disk_used:<name>:<uint64>
=summary:disk_used:<name>:<uint>
Used space on the disk in bytes.
=summary:disk_free:<name>:<uint64>
=summary:disk_free:<name>:<uint>
Free usable space on the disk in bytes, limited by `disk_block_max`.
=summary:disk_use_percent:<name>:<uint>
Disk use percentage relative to `disk_block_max`.
@ -827,12 +834,12 @@ Command List Tags
<disk_name> - The configured name of the disk.
<subpath> - The path of the file relative to the disk's root
(escaped).
<size> - The size of the file in bytes (uint64).
<size> - The size of the file in bytes (uint).
<mtime_sec> - The file's modification time in seconds since the
Epoch (int64).
Epoch (int).
<mtime_nsec> - The file's modification time nanosecond component
(uint).
<inode> - The file's inode number (int64).
<inode> - The file's inode number (uint).
=link_<type>:<disk_name>:<subpath>:<linkto>
Logs details for a link found on a disk. The `<type>` component
@ -857,7 +864,7 @@ Command List Tags
=summary:file_size:<size>
Logs the total size of all regular files processed.
<size> - The cumulative size of all files (uint64, bytes).
<size> - The cumulative size of all files (uint, bytes).
=summary:link_count:<count>
Logs the total number of links processed (hardlinks, symlinks,
@ -892,7 +899,7 @@ Command Dup Tags
of `<file_path1>`.
<file_path2> - The path of the previously processed duplicate file
relative to its disk's mount point (escaped).
<size> - The size of the duplicate file in bytes (uint64). This
<size> - The size of the duplicate file in bytes (uint). This
size corresponds to the file `<file_path2>`.
Summary Tags
@ -908,7 +915,7 @@ Command Dup Tags
Logs the total size of all duplicate files found. This size is
the sum of the sizes of all files considered duplicates.
<size> - The total size of duplicate files in gigabytes (uint64).
<size> - The total size of duplicate files in gigabytes (uint).
=summary:exit:<status>
Logs the overall exit status of the command. The `status` is one of
@ -1001,19 +1008,19 @@ Command Smart And Probe Tags
attributes. The AFR is calculated using the maximum rate
reported by specific SMART attributes (5, 187, 188, 197, 198).
<afr_value> - The computed Annual Failure Rate (double).
<afr_value> - The computed Annual Failure Rate (float).
<afr_prob> - The probability of one or more failures in the
next year (double).
next year (float).
=attr:<device_file>:<disk_name>[/<split_index>]:size:<size_bytes>
Logs the size of the disk.
<size_bytes> - The disk size in bytes (uint64).
<size_bytes> - The disk size in bytes (uint).
=attr:<device_file>:<disk_name>[/<split_index>]:error:<error_count>
Logs the total error count.
<error_count> - The total error count (uint64).
<error_count> - The total error count (uint).
=attr:<device_file>:<disk_name>[/<split_index>]:rotationrate:<rate>
Logs the disk's rotation rate.
@ -1031,15 +1038,15 @@ Command Smart And Probe Tags
`Device could not be opened`, or `SMART status check
returned 'DISK FAILING'`.
<flags_decimal> - The raw flags value (uint64, decimal).
<flags_hex> - The raw flags value (uint64, hexadecimal).
<flags_decimal> - The raw flags value (uint, decimal).
<flags_hex> - The raw flags value (uint, hexadecimal).
=attr:<device_file>:<disk_name>[/<split_index>]:<id>:<value_decimal>:<value_hex>
Logs the raw value of any assigned SMART attribute.
<id> - The SMART attribute ID (uint).
<value_decimal> - The raw attribute value (uint64, decimal).
<value_hex> - The raw attribute value (uint64, hexadecimal).
<value_decimal> - The raw attribute value (uint, decimal).
<value_hex> - The raw attribute value (uint, hexadecimal).
=attr:<device_file>:<disk_name>[/<split_index>]:power:active
Logs that the device was confirmed to be in an active power
@ -1064,7 +1071,7 @@ Command Smart And Probe Tags
Comparing this number at different times, you can detect if the
disk was used during that time.
<access_number> - Total number of accesses (int64).
<access_number> - Total number of accesses (uint).
Summary
Tags logging the overall failure probabilities for the array.
@ -1074,9 +1081,9 @@ Command Smart And Probe Tags
(sum of individual disk AFRs) and the probability of at least
one disk failure in the next year.
<array_afr> - The sum of AFRs of all disks in the array (double).
<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 (double).
the next year (float).
Device Status Tags
These tags log the lifecycle of hardware interactions and external
@ -1109,7 +1116,7 @@ Device Status Tags
exit code that was not explicitly recognized as a valid state.
<exit_code> - The integer exit status returned by the
process.
process (int).
Error Tags
These tags report specific errors that occur on data disks during the

116
doc/snapraid_log.txt
View file

@ -51,9 +51,16 @@ The following characters are escaped into sequences:
The carriage return - is escaped to \r.
The backslash - is escaped to \\.
Some tags are output only when the `--gui` option is used. They provide
extra verbose state and runtime progress only useful for a GUI
interface.
Some tags are output only when the `--gui` or `--gui-verbose` option
is used. They provide extra verbose state and runtime progress only
useful for a GUI interface.
Integer values are marked as `uint` when they are unsigned and as `int`
when they are signed. However, for practical purposes you can treat
all of them as signed integers.
All integer values should be assumed to be 64 bits wide, regardless
of the signed/unsigned marker.
Floating point values are marked as `float`.
2 CONFIGURATION TAGS
@ -103,7 +110,7 @@ These tags report the memory usage and global configuration.
autosave:<bytes>
If the autosave feature is enabled, and after how many bytes
(uint64). This specifies the interval for content file saving.
(uint). This specifies the interval for content file saving.
filter:<pattern>
All the active filters with their patterns. These patterns
@ -140,7 +147,7 @@ These tags report the information stored in the content file.
<uuid> - The UUID of the disk containing the path as stored
in the content file.
<path> - The path (escaped).
<size> - The size of the parity file (uint64).
<size> - The size of the parity file (uint).
content_data:<disk_name>:<uuid>
The data disk as stored in the content file.
@ -153,8 +160,8 @@ These tags report the information stored in the content file.
The size of disk and parity as stored in the content file.
<disk_name> - Name of the data or parity disk.
<size> - The size of the data in the disk or parity (uint64).
<free_size> - The free size in the disk or parity (uint64).
<size> - The size of the data in the disk or parity (uint).
<free_size> - The free size in the disk or parity (uint).
content_info:<kind>:<counter>
The counters in the content file.
@ -171,7 +178,7 @@ These tags report the information stored in the content file.
The version of SnapRAID run.
unixtime:<time>
The current time in the unix format (uint64), representing
The current time in the unix format (uint), representing
seconds since the epoch.
time:<YYYY-MM-DD HH:MM:SS>
@ -185,22 +192,22 @@ These tags report the information stored in the content file.
executable run.
memory:used:<bytes>
The total memory currently used by the application in bytes (uint64).
The total memory currently used by the application in bytes (uint).
memory:block:<bytes>
Size of the internal `snapraid_block` structure in bytes (uint64).
Size of the internal `snapraid_block` structure in bytes (uint).
memory:extent:<bytes>
Size of the internal `snapraid_extent` structure in bytes (uint64).
Size of the internal `snapraid_extent` structure in bytes (uint).
memory:file:<bytes>
Size of the internal `snapraid_file` structure in bytes (uint64).
Size of the internal `snapraid_file` structure in bytes (uint).
memory:link:<bytes>
Size of the internal `snapraid_link` structure in bytes (uint64).
Size of the internal `snapraid_link` structure in bytes (uint).
memory:dir:<bytes>
Size of the internal `snapraid_dir` structure in bytes (uint64).
Size of the internal `snapraid_dir` structure in bytes (uint).
5 SCAN TAGS
@ -211,8 +218,9 @@ content file. They are output for every discovered change, and
`scan:equal` is only output when the `--gui` option is used.
scan:equal:<disk_name>:<path>
A file, link, or directory is equal (unchanged) (GUI only).
A file, link, or directory is equal (unchanged).
No action is required for this item.
Only with `--gui-verbose`.
<disk_name> - Name of the data disk.
<path> - Path to the file/link/dir relative to the disk mount
@ -316,7 +324,7 @@ Only produced when `--gui` option is used.
<blockidx> - Current block index position processed (uint).
<blockdone> - Number of blocks processed (uint).
<sizedone> - Current size processed (uint64).
<sizedone> - Current size processed (uint).
<perc> - Completion percentage (uint).
<eta> - Estimated time to completion in seconds (uint).
<speed_mbs> - Data processing speed in MB/s (uint).
@ -394,7 +402,7 @@ disk access.
In case of split parity, the parity name is followed
by `/N` to indicate the split index, where N starts
from 0. The `/0` is always omitted.
<device> - The unique device ID (uint64).
<device> - The unique device ID (uint).
<temp> - The current temperature read from the disk in degrees
Celsius.
@ -410,7 +418,7 @@ disk access.
so far for a specific disk, used for fitting the heating model.
Only monotone increasing temperatures are included in the history.
<device> - The unique device ID (uint64).
<device> - The unique device ID (uint).
<count> - The total number of collected data points (uint).
<data_points> - A comma-separated list of temperature/time pairs.
Each pair is formatted as <temp>/<time_offset>.
@ -425,14 +433,14 @@ disk access.
The model is: T(t) = T_steady - (T_steady - T_0) e^(-kt),
where T_0 is the initial temperature.
<device> - The unique device ID (uint64).
<k_heat> - The heating rate constant, k (double).
<t_ambient> - The ambient temperature, T_ambient (double).
<t_steady> - The estimated steady-state temperature, T_steady (double),
<device> - The unique device ID (uint).
<k_heat> - The heating rate constant, k (float).
<t_ambient> - The ambient temperature, T_ambient (float).
<t_steady> - The estimated steady-state temperature, T_steady (float),
which is the maximum expected temperature of the disk.
<rmse> - Root Mean Square Error of the fit (double).
<r_squared> - Coefficient of determination (R^2) of the fit (double).
<max_error> - Maximum absolute error of the fit (double).
<rmse> - Root Mean Square Error of the fit (float).
<r_squared> - Coefficient of determination (R^2) of the fit (float).
<max_error> - Maximum absolute error of the fit (float).
thermal:spindown
Indicates that the thermal alarm limit has been reached, and
@ -476,7 +484,7 @@ and overall state.
This determines the maximum size of data that can be added.
summary:file_count:<uint>
Total number of files in the array.
summary:file_block_count:<uint64>
summary:file_block_count:<uint>
Total number of data blocks used by files.
summary:fragmented_file_count:<uint>
Total number of fragmented files, meaning files whose blocks
@ -487,11 +495,11 @@ and overall state.
summary:zerosubsecond_file_count:<uint>
Total number of files with a zero sub-second timestamp. This
can occur on certain filesystems and may affect change detection.
summary:file_size:<uint64>
summary:file_size:<uint>
Total size of all files in bytes.
summary:parity_size:<uint64>
summary:parity_size:<uint>
Total size of allocated parity blocks in bytes.
summary:parity_size_max:<uint64>
summary:parity_size_max:<uint>
Maximum possible parity size (allocated + min free) in bytes.
This is the effective maximum protection size.
summary:hash:<name>
@ -501,12 +509,12 @@ and overall state.
summary:best_hash:<name>
The best hash algorithm for optimal performance based on
system capabilities.
summary:total_wasted:<uint64>
summary:total_wasted:<uint>
Total wasted space (space on data disks exceeding parity
capacity) in bytes.
summary:total_used:<uint64>
summary:total_used:<uint>
Total used space by data files in bytes.
summary:total_free:<uint64>
summary:total_free:<uint>
Total free space (usable by data) in bytes, limited by parity
capacity.
summary:total_use_percent:<uint>
@ -554,7 +562,7 @@ is the disk name.
Number of excess fragments on the disk.
summary:disk_zerosubsecond_file_count:<name>:<uint>
Number of files with zero sub-second timestamp on the disk.
summary:disk_file_size:<name>:<uint64>
summary:disk_file_size:<name>:<uint>
Total size of files on the disk in bytes.
summary:disk_block_allocated:<name>:<uint>
Highest block index used on the disk + 1.
@ -571,12 +579,12 @@ is the disk name.
This is the logical limit imposed by the parity files.
summary:disk_block_max:<name>:<uint>
Maximum usable blocks (minimum of `..._by_space` and `..._by_parity`).
summary:disk_space_wasted:<name>:<int64>
summary:disk_space_wasted:<name>:<int>
Wasted space on the disk in bytes (positive if disk is larger
than usable parity space).
summary:disk_used:<name>:<uint64>
summary:disk_used:<name>:<uint>
Used space on the disk in bytes.
summary:disk_free:<name>:<uint64>
summary:disk_free:<name>:<uint>
Free usable space on the disk in bytes, limited by `disk_block_max`.
summary:disk_use_percent:<name>:<uint>
Disk use percentage relative to `disk_block_max`.
@ -860,12 +868,12 @@ the listing operation.
<disk_name> - The configured name of the disk.
<subpath> - The path of the file relative to the disk's root
(escaped).
<size> - The size of the file in bytes (uint64).
<size> - The size of the file in bytes (uint).
<mtime_sec> - The file's modification time in seconds since the
Epoch (int64).
Epoch (int).
<mtime_nsec> - The file's modification time nanosecond component
(uint).
<inode> - The file's inode number (int64).
<inode> - The file's inode number (uint).
link_<type>:<disk_name>:<subpath>:<linkto>
Logs details for a link found on a disk. The `<type>` component
@ -890,7 +898,7 @@ These tags log final statistics about the entire listing operation.
summary:file_size:<size>
Logs the total size of all regular files processed.
<size> - The cumulative size of all files (uint64, bytes).
<size> - The cumulative size of all files (uint, bytes).
summary:link_count:<count>
Logs the total number of links processed (hardlinks, symlinks,
@ -928,7 +936,7 @@ whole file is used to determine duplicates.
of `<file_path1>`.
<file_path2> - The path of the previously processed duplicate file
relative to its disk's mount point (escaped).
<size> - The size of the duplicate file in bytes (uint64). This
<size> - The size of the duplicate file in bytes (uint). This
size corresponds to the file `<file_path2>`.
---- 12.0.2 Summary Tags ----
@ -944,7 +952,7 @@ These tags provide a final summary of the duplicate finding process.
Logs the total size of all duplicate files found. This size is
the sum of the sizes of all files considered duplicates.
<size> - The total size of duplicate files in gigabytes (uint64).
<size> - The total size of duplicate files in gigabytes (uint).
summary:exit:<status>
Logs the overall exit status of the command. The `status` is one of
@ -1046,19 +1054,19 @@ Tags logging specific disk identification and attribute values.
attributes. The AFR is calculated using the maximum rate
reported by specific SMART attributes (5, 187, 188, 197, 198).
<afr_value> - The computed Annual Failure Rate (double).
<afr_value> - The computed Annual Failure Rate (float).
<afr_prob> - The probability of one or more failures in the
next year (double).
next year (float).
attr:<device_file>:<disk_name>[/<split_index>]:size:<size_bytes>
Logs the size of the disk.
<size_bytes> - The disk size in bytes (uint64).
<size_bytes> - The disk size in bytes (uint).
attr:<device_file>:<disk_name>[/<split_index>]:error:<error_count>
Logs the total error count.
<error_count> - The total error count (uint64).
<error_count> - The total error count (uint).
attr:<device_file>:<disk_name>[/<split_index>]:rotationrate:<rate>
Logs the disk's rotation rate.
@ -1076,15 +1084,15 @@ Tags logging specific disk identification and attribute values.
`Device could not be opened`, or `SMART status check
returned 'DISK FAILING'`.
<flags_decimal> - The raw flags value (uint64, decimal).
<flags_hex> - The raw flags value (uint64, hexadecimal).
<flags_decimal> - The raw flags value (uint, decimal).
<flags_hex> - The raw flags value (uint, hexadecimal).
attr:<device_file>:<disk_name>[/<split_index>]:<id>:<value_decimal>:<value_hex>
Logs the raw value of any assigned SMART attribute.
<id> - The SMART attribute ID (uint).
<value_decimal> - The raw attribute value (uint64, decimal).
<value_hex> - The raw attribute value (uint64, hexadecimal).
<value_decimal> - The raw attribute value (uint, decimal).
<value_hex> - The raw attribute value (uint, hexadecimal).
attr:<device_file>:<disk_name>[/<split_index>]:power:active
Logs that the device was confirmed to be in an active power
@ -1109,7 +1117,7 @@ Tags logging specific disk identification and attribute values.
Comparing this number at different times, you can detect if the
disk was used during that time.
<access_number> - Total number of accesses (int64).
<access_number> - Total number of accesses (uint).
---- 15.0.2 Summary ----
Tags logging the overall failure probabilities for the array.
@ -1119,9 +1127,9 @@ Tags logging the overall failure probabilities for the array.
(sum of individual disk AFRs) and the probability of at least
one disk failure in the next year.
<array_afr> - The sum of AFRs of all disks in the array (double).
<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 (double).
the next year (float).
16 DEVICE STATUS TAGS
@ -1157,7 +1165,7 @@ command execution with the `smartctl` command.
exit code that was not explicitly recognized as a valid state.
<exit_code> - The integer exit status returned by the
process.
process (int).
17 ERROR TAGS