diff options
Diffstat (limited to 'lib/os_mon/doc/src/disksup.xml')
| -rw-r--r-- | lib/os_mon/doc/src/disksup.xml | 41 |
1 files changed, 34 insertions, 7 deletions
diff --git a/lib/os_mon/doc/src/disksup.xml b/lib/os_mon/doc/src/disksup.xml index 47eff80ff5..59ba7eaf9e 100644 --- a/lib/os_mon/doc/src/disksup.xml +++ b/lib/os_mon/doc/src/disksup.xml @@ -4,7 +4,7 @@ <erlref> <header> <copyright> - <year>1996</year><year>2021</year> + <year>1996</year><year>2022</year> <holder>Ericsson AB. All Rights Reserved.</holder> </copyright> <legalnotice> @@ -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, |