Add doc explaining calculation of system_memory_high_watermark depend…

…s on os
erlang · Oct 17, 2024 · 6a41f5b · 6a41f5b
1 parent 4b0ef3f
commit 6a41f5b
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/lib/os_mon/src/memsup.erl b/lib/os_mon/src/memsup.erl
@@ -29,7 +29,9 @@ Periodically performs a memory check:
 
 - If more than a certain amount of available system memory is allocated, as
   reported by the underlying operating system, the alarm
-  `{system_memory_high_watermark, []}` is set.
+  `{system_memory_high_watermark, []}` is set. How the amount of available
+  memory is determined depends on the underlying OS and may change as better
+  values become available.
 - If any Erlang process `Pid` in the system has allocated more than a certain
   amount of total system memory, the alarm
   `{process_memory_high_watermark, Pid}` is set.