Add solution for inotify watcher limit issue to docs
What does this merge request do and why?
The update includes a new section in the documentation that addresses an error related to the maximum number of inotify watchers. It provides a solution by linking to a resource that explains how to increase the maximum allowed inotify watchers.
Following logs were listed:
2024-05-13_11:39:27.26118 rails-web: /home/xxx/.asdf/installs/ruby/3.2.3/lib/ruby/gems/3.2.0/gems/rb-inotify-0.10.1/lib/rb-inotify/watcher.rb:74:in `initialize': No space left on device - Failed to watch "/home/lukas/projects/gitlab-development-kit/gitlab/app/views/admin/background_jobs": The user limit on the total number of inotify watches was reached or the kernel failed to allocate a needed resource. (Errno::ENOSPC)
2024-05-13_11:39:27.26045 rails-web: {"timestamp":"2024-05-13T11:39:27.260Z","pid":294205,"message":"! Unable to load application: Listen::Error::INotifyMaxWatchesExceeded: Unable to monitor directories for changes because iNotify max watches exceeded. See https://github.com/guard/listen/blob/master/README.md#increasing-the-amount-of-inotify-watchers .n"}
2024-05-13_11:39:27.26094 rails-web: /home/xxx/.asdf/installs/ruby/3.2.3/lib/ruby/gems/3.2.0/gems/listen-3.7.1/lib/listen/adapter/linux.rb:32:in `rescue in _configure': Unable to monitor directories for changes because iNotify max watches exceeded. See https://github.com/guard/listen/blob/master/README.md#increasing-the-amount-of-inotify-watchers . (Listen::Error::INotifyMaxWatchesExceeded)
How to set up and validate locally
Adapt or reset the notify watcher limit to a minimum on Debian 12, apply the changes to the kernel and restart gdk.
Impacted categories
The following categories relate to this merge request:
-
gdk-reliability - e.g. When a GDK action fails to complete. -
gdk-usability - e.g. Improvements or suggestions around how the GDK functions. -
gdk-performance - e.g. When a GDK action is slow or times out.
Merge request checklist
-
This change is backward compatible. If not, please include steps to communicate to our users. -
Tests added for new functionality. If not, please raise an issue to follow-up. -
Documentation added/updated, if needed. -
Announcement added, if change is notable. -
gdk doctor
test added, if needed. -
Add the ~highlight
label if this MR should be included in theCHANGELOG.md
.
Edited by Lukas Wanko