(superset) branch master updated: docs: handling "System limit for number of file watchers reached" error (#25551)

[sf...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

sfirke pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/superset.git


The following commit(s) were added to refs/heads/master by this push:
     new 7f0c3b20ad docs: handling "System limit for number of file watchers reached" error (#25551)
7f0c3b20ad is described below

commit 7f0c3b20ad11a5e199d37c92aa3256279042d48c
Author: nitish-samsung-jha <14...@users.noreply.github.com>
AuthorDate: Thu Nov 16 21:30:42 2023 +0530

    docs: handling "System limit for number of file watchers reached" error (#25551)
    
    Co-authored-by: Sam Firke <sf...@users.noreply.github.com>
---
 CONTRIBUTING.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 343356b5a9..d427ba393d 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -610,6 +610,31 @@ Then put this:
 export NODE_OPTIONS=--no-experimental-fetch
 ```
 
+If while using the above commands you encounter an error related to the limit of file watchers:
+
+```bash
+Error: ENOSPC: System limit for number of file watchers reached
+```
+The error is thrown because the number of files monitored by the system has reached the limit.
+You can address this this error by increasing the number of inotify watchers.
+
+
+The current value of max watches can be checked with:
+```bash
+cat /proc/sys/fs/inotify/max_user_watches
+```
+Edit the file /etc/sysctl.conf to increase this value.
+The value needs to be decided based on the system memory [(see this StackOverflow answer for more context)](https://stackoverflow.com/questions/535768/what-is-a-reasonable-amount-of-inotify-watches-with-linux).
+
+Open the file in editor and add a line at the bottom specifying the max watches values.
+```bash
+fs.inotify.max_user_watches=524288
+```
+Save the file and exit editor.
+To confirm that the change succeeded, run the following command to load the updated value of max_user_watches from sysctl.conf:
+```bash
+sudo sysctl -p
+```
 #### Webpack dev server
 
 The dev server by default starts at `http://localhost:9000` and proxies the backend requests to `http://localhost:8088`.