summaryrefslogtreecommitdiff
path: root/lib/os_mon/doc
diff options
context:
space:
mode:
authorjdamanalo <jamanalo5@up.edu.ph>2022-11-03 17:54:47 +0800
committerRickard Green <rickard@erlang.org>2022-11-08 18:38:23 +0100
commit3fa8a0469773d634f38b514ddd197b4d6a8dbf8c (patch)
treea44ea3aa04875c8f906ffbfc57d8c3a85173d909 /lib/os_mon/doc
parent4a7eeb5a76093a5f84ab859d1ecb1749cc94dd63 (diff)
downloaderlang-3fa8a0469773d634f38b514ddd197b4d6a8dbf8c.tar.gz
os_mon: allow check intervals smaller than 1 minute
- expand type of `disk_space_check_interval` to `Minute | {TimeUnit, Time}`
Diffstat (limited to 'lib/os_mon/doc')
-rw-r--r--lib/os_mon/doc/src/disksup.xml39
1 files changed, 33 insertions, 6 deletions
diff --git a/lib/os_mon/doc/src/disksup.xml b/lib/os_mon/doc/src/disksup.xml
index 47eff80ff5..daba73007f 100644
--- a/lib/os_mon/doc/src/disksup.xml
+++ b/lib/os_mon/doc/src/disksup.xml
@@ -57,15 +57,42 @@
longer valid.</p>
</description>
+ <datatypes>
+ <datatype>
+ <name>time()</name>
+ <desc>
+ <p>Supported units:</p>
+ <taglist>
+ <tag><c>integer() >= 1</c></tag>
+ <item>
+ <p>The time interval in minutes.</p>
+ </item>
+ <tag><c>{TimeUnit, Time}</c></tag>
+ <item>
+ <p>
+ The time interval <c>Time</c> in a time unit specified by <c>TimeUnit</c> where
+ <c>TimeUnit</c> is of the type
+ <seetype marker="erts:erlang#time_unit"><c>erlang:time_unit()</c></seetype>
+ and <c>Time</c> is a positive integer. The time interval needs to be at least one
+ millisecond long.
+ </p>
+ </item>
+ </taglist>
+ </desc>
+ </datatype>
+ </datatypes>
+
<section>
<marker id="config"></marker>
<title>Configuration</title>
<p>The following configuration parameters can be used to change
the default values for time interval and threshold:</p>
<taglist>
- <tag><c>disk_space_check_interval = int()>0</c></tag>
+ <tag>
+ <c>disk_space_check_interval = </c><seetype marker="#time"><c>time()</c></seetype>
+ </tag>
<item>
- <p>The time interval, in minutes, for the periodic disk space
+ <p>The time interval for the periodic disk space
check. The default is 30 minutes.</p>
</item>
<tag><c>disk_almost_full_threshold = float()</c></tag>
@@ -123,13 +150,13 @@
</desc>
</func>
<func>
- <name since="">set_check_interval(Minutes) -> ok</name>
- <fsummary>Set time interval, in minutes, for the periodic disk space check</fsummary>
+ <name since="">set_check_interval(Time) -> ok</name>
+ <fsummary>Set time interval for the periodic disk space check</fsummary>
<type>
- <v>Minutes = int()>=1</v>
+ <v>Time = <seetype marker="#time">time()</seetype></v>
</type>
<desc>
- <p>Changes the time interval, given in minutes, for the periodic
+ <p>Changes the time interval for the periodic
disk space check.</p>
<p>The change will take effect after the next disk space check
and is non-persist. That is, in case of a process restart,