aboutsummaryrefslogtreecommitdiffstats
path: root/erts
diff options
context:
space:
mode:
authorSverker Eriksson <[email protected]>2019-05-20 17:35:06 +0200
committerSverker Eriksson <[email protected]>2019-05-22 17:56:31 +0200
commitf8d2dfc06b599b8e3335a2afef89c763b01d6f55 (patch)
tree48d3c08d4a6c394f319a5a08ce494e2806b7e07c /erts
parent6618ce7b6a621e92db72ea4f01f7d38553c8818c (diff)
downloadotp-f8d2dfc06b599b8e3335a2afef89c763b01d6f55.tar.gz
otp-f8d2dfc06b599b8e3335a2afef89c763b01d6f55.tar.bz2
otp-f8d2dfc06b599b8e3335a2afef89c763b01d6f55.zip
erts: Clarify erlang:system_monitor/2 semantics
Diffstat (limited to 'erts')
-rw-r--r--erts/doc/src/erlang.xml12
1 files changed, 12 insertions, 0 deletions
diff --git a/erts/doc/src/erlang.xml b/erts/doc/src/erlang.xml
index a879cce840..998c9b6272 100644
--- a/erts/doc/src/erlang.xml
+++ b/erts/doc/src/erlang.xml
@@ -9412,6 +9412,18 @@ Metadata = #{ pid => pid(),
<p>Returns the previous system monitor settings just like
<seealso marker="#system_monitor/0">
<c>erlang:system_monitor/0</c></seealso>.</p>
+ <p>The arguments to <c>system_monitor/2</c> specifies how all
+ system monitoring on the node should be done, not how it should be
+ changed. This means only one process at a time
+ (<c><anno>MonitorPid</anno></c>) can be the receiver of system monitor
+ messages. Also, the way to clear a specific monitor option
+ is to not include it in the list <c><anno>Options</anno></c>. All
+ system monitoring will, however, be cleared if the process identified by
+ <c><anno>MonitorPid</anno></c> terminates.</p>
+ <p>There are no special option values (like zero) to clear an option.
+ Some of the options have a unspecified minimum value. Lower values
+ will be adjusted to the minimum value. For example, it is currently not
+ possible to monitor all garbage collections with <c>{long_gc, 0}</c>.</p>
<note>
<p>If a monitoring process gets so large that it itself
starts to cause system monitor messages when garbage