From 12d630245723f37c435a840a9b130e9d8b061b7e Mon Sep 17 00:00:00 2001
From: Antonio SJ Musumeci <trapexit@spawn.link>
Date: Sat, 25 Jan 2025 20:56:28 -0600
Subject: [PATCH] Add details about logging to syslog

---
 ...andling.md => error_handling_and_logging.md} | 17 ++++++++++++++++-
 mkdocs/mkdocs.yml                               |  2 +-
 2 files changed, 17 insertions(+), 2 deletions(-)
 rename mkdocs/docs/{error_handling.md => error_handling_and_logging.md} (76%)

diff --git a/mkdocs/docs/error_handling.md b/mkdocs/docs/error_handling_and_logging.md
similarity index 76%
rename from mkdocs/docs/error_handling.md
rename to mkdocs/docs/error_handling_and_logging.md
index c36d6dfa..84b94bbd 100644
--- a/mkdocs/docs/error_handling.md
+++ b/mkdocs/docs/error_handling_and_logging.md
@@ -1,4 +1,6 @@
-# Error Handling
+# Error Handling and Logging
+
+## Error Handling
 
 POSIX filesystem functions offer a single return code meaning that
 there is some complication regarding the handling of multiple branches
@@ -35,3 +37,16 @@ For create functions `mkdir`, `mknod`, and `symlink` which don't
 return a file descriptor and therefore can have `all` or `epall`
 policies it will return success if any of the calls succeed and an
 error otherwise.
+
+
+## Logging
+
+Filesystems, and therefore mergerfs, are doing lots of small actions
+at high speed. It simply isn't reasonable to log all the actions of
+the system. That said: certain details are logged at startup and when
+performing mainance tasks. These are logged via `syslog` and on
+`systemd` based systems can be viewed by running
+
+```
+journalctl -t mergerfs
+```
diff --git a/mkdocs/mkdocs.yml b/mkdocs/mkdocs.yml
index 82dd9495..48fccba4 100644
--- a/mkdocs/mkdocs.yml
+++ b/mkdocs/mkdocs.yml
@@ -80,7 +80,7 @@ nav:
   - config/statfs.md
   - config/flush-on-close.md
   - config/export-support.md
-- error_handling.md
+- error_handling_and_logging.md
 - runtime_interfaces.md
 - remote_filesystems.md
 - tips_notes.md