Skip to content

Commit d019783

Browse files
committed
Docs: clarify SYNC_WARN_THRESHOLD as the self-service solution for recurring threshold warnings
1 parent 9513f96 commit d019783

2 files changed

Lines changed: 7 additions & 5 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Contributions are welcome!
3535
- After some preliminary checks, the script will execute `snapraid diff` to figure out if parity info is out of date, which means checking for changes since the last execution. During this step, the script will ensure drives are fine by reading parity and content files.
3636
- One of the following will happen:
3737
- If parity info is out of sync **and** the number of deleted or changed files exceed the threshold you have configured it **stops**. You may want to take a look to the output log.
38-
- If parity info is out of sync **and** the number of deleted or changed files exceed the threshold, you can still **force a sync** after a number of warnings. It's useful If you often get a false alarm but you're confident enough. This is called "Sync with threshold warnings"
38+
- If parity info is out of sync **and** the number of deleted or changed files exceed the threshold, you can still **force a sync** after a number of warnings. It's useful If you often get a false alarm but you're confident enough. This is called "Sync with threshold warnings" (configure with `SYNC_WARN_THRESHOLD` in `script-config.conf`).
3939
- Instead of forcing a sync based on the number of deleted files, you may consider the `ADD_DEL_THRESHOLD` feature, by allowing a sync that would otherwise violate the delete threshold, if the ratio of added to deleted files is greater than the value set.
4040
- If parity info is out of sync **but** the number of deleted or changed files did not exceed the threshold, it **executes a sync** to update the parity info.
4141
- When the parity info is in sync, either because nothing has changed or after a successfully sync, it runs the `snapraid scrub` command to validate the integrity of the data, both the files and the parity info. If sync was cancelled or other issues were found, scrub will not be run.

script-config.conf

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -145,10 +145,12 @@ IGNORE_PATTERN=()
145145
ADD_DEL_THRESHOLD=0
146146

147147
# Set number of warnings before forcing a sync, or force the sync every time
148-
# ignoring thresholds (Forced Sync). This option comes in handy when you cannot be
149-
# bothered to manually start a sync job when DEL_THRESHOLD or UP_THRESHOLD are
150-
# breached due to false alarm.
151-
# Set to 0 to ALWAYS force a sync (Forced Sync, ignoring the thresholds above)
148+
# ignoring thresholds (Forced Sync). This option comes in handy when you cannot be
149+
# bothered to manually start a sync job when DEL_THRESHOLD or UP_THRESHOLD are
150+
# breached due to false alarm.
151+
# Example: set to 3 to automatically force a sync after 3 consecutive threshold
152+
# warnings. This avoids having to SSH in and run --force-sync manually each time.
153+
# Set to 0 to ALWAYS force a sync (Forced Sync, ignoring the thresholds above)
152154
# Set to -1 to NEVER force a sync, the default behaviour (need to manual sync if
153155
# thresholds are breached).
154156
SYNC_WARN_THRESHOLD=-1

0 commit comments

Comments
 (0)