From b4239495a07171572fd95d19785593d7407df6a7 Mon Sep 17 00:00:00 2001 From: trapexit Date: Fri, 13 Feb 2026 00:21:43 -0500 Subject: [PATCH] Update docs for logging changes + new video (#1618) --- mkdocs/docs/config/options.md | 5 ++++- mkdocs/docs/error_handling_and_logging.md | 17 ++++++++++++----- mkdocs/docs/media_and_publicity.md | 2 ++ 3 files changed, 18 insertions(+), 6 deletions(-) diff --git a/mkdocs/docs/config/options.md b/mkdocs/docs/config/options.md index 326a162b..f6f52826 100644 --- a/mkdocs/docs/config/options.md +++ b/mkdocs/docs/config/options.md @@ -220,7 +220,10 @@ config file. * **noforget**: Effectively sets `remember-nodes` to infinity. * **allow-idmap=BOOL**: Enables idmap (identity mapping). (default: true) - +* **debug**: Enable debugging information. At the moment limited to a + FUSE message trace saved to `log.file`. (default: false) +* **log.file**: The file path for the FUSE message trace. Empty string + will set to stderr. (default: stderr) **NOTE:** Options are evaluated in the order listed so if the options are **func.rmdir=rand,category.action=ff** the **action** category diff --git a/mkdocs/docs/error_handling_and_logging.md b/mkdocs/docs/error_handling_and_logging.md index 4c2c39c0..86dc7c6b 100644 --- a/mkdocs/docs/error_handling_and_logging.md +++ b/mkdocs/docs/error_handling_and_logging.md @@ -88,11 +88,18 @@ filesystems. Mainly `ext4`. ## 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 maintenance tasks. These are logged via `syslog` and on -`systemd` based systems can be viewed by running +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 all time time. However, there is a debug mode +which can be toggled on as needed, even at runtime, which will record +some information to help with debugging. The main thing it will record +is a trace of all FUSE messages to the location defined by the +`log.file` option. See [config section](config/options.md) for more +details. + +That said even with debug mode disabled mergerfs will log certain +details via `syslog` which on `systemd` based systems can be viewed by +running: ``` journalctl -t mergerfs diff --git a/mkdocs/docs/media_and_publicity.md b/mkdocs/docs/media_and_publicity.md index 9753295f..1efe6332 100644 --- a/mkdocs/docs/media_and_publicity.md +++ b/mkdocs/docs/media_and_publicity.md @@ -68,6 +68,8 @@ * 2025-04-23 - [How to build the Perfect Media Server | Part 1 - The Tech Stack | mergerfs, SnapRAID, and docker.](https://www.youtube.com/watch?v=Yt67zz9p0FU) * 2025-06-12 - [DIY Unraid-like functionality](https://www.youtube.com/watch?v=fR0XhaWvR1E) * 2025-09-22 - [استفاده از Snapraid و MergerFS | جایگزین RAID5](https://www.youtube.com/watch?v=GA6OvaUBKXs) +* 2026-02-10 - [Never run out of space again! Using MergerFS with Immich to expand your storage seamlessly](https://www.youtube.com/watch?v=Vbu4WzWUikQ) + ## Podcasts