Skip to content

Commit 6c22505

Browse files
author
Oliver Cervera
authored
Add Healthchecks.io documentation
1 parent 5fc8da6 commit 6c22505

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ Contributions are welcome!
2424
### Additional Information
2525
- Docker container management, if enabled, will manage containers before SnapRAID activity and restore them when finished. It avoids nasty errors aboud data being written during SnapRAID sync.
2626
- You can either choose to pause or stop your containers and manage a remote docker host.
27+
- Healthchecks.io can be used to track script execution time and to promptly alert about errors.
28+
2729
- Important messages are sent to the system log.
2830

2931
## Customization
@@ -42,6 +44,10 @@ If you don't know what to do, I recommend using the default values and see how i
4244
- Data to be scrubbed - by default 5% older than 10 days.
4345
- Pre-hashing - enabled by default. Mitigate the lack of ECC memory, reading data twice to avoid silent read errors.
4446
- SMART Log - enabled by default. A SnapRAID report for disks health status.
47+
- Healthchecks.io integration
48+
- Script execution result can be reported to Healthchecks.io.
49+
- If the script ends with a **_WARNING_** message, it will be reported **_DOWN_** to Healthchecks.io, instead if the message is **_COMPLETED_** it will be **_UP_**. If you don't read your emails every day, this is a great one for you, since the service can report you in other ways.
50+
- The reason of the failure, which is the email subject, is included as well.
4551
- Container management - disabled by default.
4652
- A list of containers you want to be interrupted before running actions and restored when completed.
4753
- Docker mode - choose to pause/unpause or to stop/restart your containers

0 commit comments

Comments
 (0)