<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html xmlns:erl="http://erlang.org" xmlns:fn="http://www.w3.org/2005/02/xpath-functions">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../../../doc/otp_doc.css" type="text/css">
<title>Erlang -- os_mon</title>
</head>
<body>
<div id="container">
<script id="js" type="text/javascript" language="JavaScript" src="../../../../doc/js/flipmenu/flipmenu.js"></script><script id="js2" type="text/javascript" src="../../../../doc/js/erlresolvelinks.js"></script><script language="JavaScript" type="text/javascript">
<!--
function getWinHeight() {
var myHeight = 0;
if( typeof( window.innerHeight ) == 'number' ) {
//Non-IE
myHeight = window.innerHeight;
} else if( document.documentElement && ( document.documentElement.clientWidth ||
document.documentElement.clientHeight ) ) {
//IE 6+ in 'standards compliant mode'
myHeight = document.documentElement.clientHeight;
} else if( document.body && ( document.body.clientWidth || document.body.clientHeight ) ) {
//IE 4 compatible
myHeight = document.body.clientHeight;
}
return myHeight;
}
function setscrollpos() {
var objf=document.getElementById('loadscrollpos');
document.getElementById("leftnav").scrollTop = objf.offsetTop - getWinHeight()/2;
}
function addEvent(obj, evType, fn){
if (obj.addEventListener){
obj.addEventListener(evType, fn, true);
return true;
} else if (obj.attachEvent){
var r = obj.attachEvent("on"+evType, fn);
return r;
} else {
return false;
}
}
addEvent(window, 'load', setscrollpos);
//--></script><div id="leftnav"><div class="innertube">
<div class="erlang-logo-wrapper"><a href="../../../../doc/index.html"><img alt="Erlang Logo" src="../../../../doc/erlang-logo.png" class="erlang-logo"></a></div>
<p class="section-title">OS_Mon</p>
<p class="section-subtitle">Reference Manual</p>
<p class="section-version">Version 2.4.7</p>
<ul class="panel-sections">
<li><a href="index.html">Reference Manual</a></li>
<li><a href="release_notes.html">Release Notes</a></li>
<li><a href="../pdf/os_mon-2.4.7.pdf">PDF</a></li>
<li><a href="../../../../doc/index.html">Top</a></li>
</ul>
<ul class="expand-collapse-items">
<li><a href="javascript:openAllFlips()">Expand All</a></li>
<li><a href="javascript:closeAllFlips()">Contract All</a></li>
</ul>
<h3>Table of Contents</h3>
<ul class="flipMenu">
<li title="os_mon (App)"><a href="os_mon_app.html">os_mon (App)
</a></li>
<li id="no" title="cpu_sup " expanded="false">cpu_sup<ul>
<li><a href="cpu_sup.html">
Top of manual page
</a></li>
<li title="avg1-0"><a href="cpu_sup.html#avg1-0">avg1/0</a></li>
<li title="avg15-0"><a href="cpu_sup.html#avg15-0">avg15/0</a></li>
<li title="avg5-0"><a href="cpu_sup.html#avg5-0">avg5/0</a></li>
<li title="nprocs-0"><a href="cpu_sup.html#nprocs-0">nprocs/0</a></li>
<li title="util-0"><a href="cpu_sup.html#util-0">util/0</a></li>
<li title="util-1"><a href="cpu_sup.html#util-1">util/1</a></li>
</ul>
</li>
<li id="no" title="disksup " expanded="false">disksup<ul>
<li><a href="disksup.html">
Top of manual page
</a></li>
<li title="get_almost_full_threshold-0"><a href="disksup.html#get_almost_full_threshold-0">get_almost_full_threshold/0</a></li>
<li title="get_check_interval-0"><a href="disksup.html#get_check_interval-0">get_check_interval/0</a></li>
<li title="get_disk_data-0"><a href="disksup.html#get_disk_data-0">get_disk_data/0</a></li>
<li title="set_almost_full_threshold-1"><a href="disksup.html#set_almost_full_threshold-1">set_almost_full_threshold/1</a></li>
<li title="set_check_interval-1"><a href="disksup.html#set_check_interval-1">set_check_interval/1</a></li>
</ul>
</li>
<li id="no" title="memsup " expanded="false">memsup<ul>
<li><a href="memsup.html">
Top of manual page
</a></li>
<li title="get_check_interval-0"><a href="memsup.html#get_check_interval-0">get_check_interval/0</a></li>
<li title="get_helper_timeout-0"><a href="memsup.html#get_helper_timeout-0">get_helper_timeout/0</a></li>
<li title="get_memory_data-0"><a href="memsup.html#get_memory_data-0">get_memory_data/0</a></li>
<li title="get_os_wordsize-0"><a href="memsup.html#get_os_wordsize-0">get_os_wordsize/0</a></li>
<li title="get_procmem_high_watermark-0"><a href="memsup.html#get_procmem_high_watermark-0">get_procmem_high_watermark/0</a></li>
<li title="get_sysmem_high_watermark-0"><a href="memsup.html#get_sysmem_high_watermark-0">get_sysmem_high_watermark/0</a></li>
<li title="get_system_memory_data-0"><a href="memsup.html#get_system_memory_data-0">get_system_memory_data/0</a></li>
<li title="set_check_interval-1"><a href="memsup.html#set_check_interval-1">set_check_interval/1</a></li>
<li title="set_helper_timeout-1"><a href="memsup.html#set_helper_timeout-1">set_helper_timeout/1</a></li>
<li title="set_procmem_high_watermark-1"><a href="memsup.html#set_procmem_high_watermark-1">set_procmem_high_watermark/1</a></li>
<li title="set_sysmem_high_watermark-1"><a href="memsup.html#set_sysmem_high_watermark-1">set_sysmem_high_watermark/1</a></li>
</ul>
</li>
<li id="no" title="os_mon_mib " expanded="false">os_mon_mib<ul>
<li><a href="os_mon_mib.html">
Top of manual page
</a></li>
<li title="load-1"><a href="os_mon_mib.html#load-1">load/1</a></li>
<li title="unload-1"><a href="os_mon_mib.html#unload-1">unload/1</a></li>
</ul>
</li>
<li id="no" title="os_sup " expanded="false">os_sup<ul>
<li><a href="os_sup.html">
Top of manual page
</a></li>
<li title="disable-0"><a href="os_sup.html#disable-0">disable/0</a></li>
<li title="disable-2"><a href="os_sup.html#disable-2">disable/2</a></li>
<li title="enable-0"><a href="os_sup.html#enable-0">enable/0</a></li>
<li title="enable-2"><a href="os_sup.html#enable-2">enable/2</a></li>
</ul>
</li>
<li id="no" title="nteventlog " expanded="false">nteventlog<ul>
<li><a href="nteventlog.html">
Top of manual page
</a></li>
<li title="start-2"><a href="nteventlog.html#start-2">start/2</a></li>
<li title="start_link-2"><a href="nteventlog.html#start_link-2">start_link/2</a></li>
<li title="stop-0"><a href="nteventlog.html#stop-0">stop/0</a></li>
</ul>
</li>
</ul>
</div></div>
<div id="content">
<div class="innertube">
<!-- refpage --><center><h1>os_mon</h1></center>
<h3><span onMouseOver="document.getElementById('ghlink-application-idm281472804543704').style.visibility = 'visible';" onMouseOut="document.getElementById('ghlink-application-idm281472804543704').style.visibility = 'hidden';"><span id="ghlink-application-idm281472804543704"></span><a class="title_link" name="application" href="#application">Application</a></span></h3>
<div class="REFBODY application-body">os_mon</div>
<h3><span onMouseOver="document.getElementById('ghlink-application-summary-idm281472804544328').style.visibility = 'visible';" onMouseOut="document.getElementById('ghlink-application-summary-idm281472804544328').style.visibility = 'hidden';"><span id="ghlink-application-summary-idm281472804544328"></span><a class="title_link" name="application-summary" href="#application-summary">Application Summary</a></span></h3>
<div class="REFBODY application-summary-body">OS Monitoring Application</div>
<h3><span onMouseOver="document.getElementById('ghlink-description-idm281472804545256').style.visibility = 'visible';" onMouseOut="document.getElementById('ghlink-description-idm281472804545256').style.visibility = 'hidden';"><span id="ghlink-description-idm281472804545256" class="ghlink"><a href="https://github.com/erlang/otp/edit/maint/lib/os_mon/doc/src/os_mon_app.xml#L33" title="Found an issue with the documentation? Fix it by clicking here!"><span class="pencil"></span></a></span><a class="title_link" name="description" href="#description">Description</a></span></h3>
<div class="REFBODY description-body"><p>
<p>The operating system monitor, OS_Mon, provides the following
services:</p>
<ul>
<li>
<span class="bold_code bc-19"><a href="cpu_sup.html">cpu_sup</a></span>
CPU load and utilization supervision (Unix)</li>
<li>
<span class="bold_code bc-19"><a href="disksup.html">disksup</a></span>
Disk supervision(Unix, Windows)</li>
<li>
<span class="bold_code bc-19"><a href="memsup.html">memsup</a></span>
Memory supervision (Unix, Windows, VxWorks)</li>
<li>
<span class="bold_code bc-19"><a href="os_sup.html">os_sup</a></span>
Interface to OS system messages (Solaris, Windows)</li>
</ul>
<p>To simplify usage of OS_Mon on distributed Erlang systems, it is
not considered an error trying to use a service at a node where it
is not available (either because OS_Mon is not running, or because
the service is not available for that OS, or because the service
is not started). Instead, a warning message is issued via
<span class="code">error_logger</span> and a dummy value is returned, which one is
specified in the man pages for the respective services.</p>
</p></div>
<h3><span onMouseOver="document.getElementById('ghlink-configuration-idm281472804689304').style.visibility = 'visible';" onMouseOut="document.getElementById('ghlink-configuration-idm281472804689304').style.visibility = 'hidden';"><span id="ghlink-configuration-idm281472804689304" class="ghlink"><a href="https://github.com/erlang/otp/edit/maint/lib/os_mon/doc/src/os_mon_app.xml#L55" title="Found an issue with the documentation? Fix it by clicking here!"><span class="pencil"></span></a></span><a class="title_link" name="configuration" href="#configuration">Configuration</a></span></h3>
<div class="REFBODY rb-3">
<p>When OS_Mon is started, by default all services available for
the OS, except <span class="code">os_sup</span>, are automatically started. This
configuration can be changed using the following application
configuration parameters:</p>
<dl>
<dt><strong><span class="code">start_cpu_sup = bool()</span></strong></dt>
<dd>
<p>Specifies if <span class="code">cpu_sup</span> should be started. Defaults to
<span class="code">true</span>.</p>
</dd>
<dt><strong><span class="code">start_disksup = bool()</span></strong></dt>
<dd>
<p>Specifies if <span class="code">disksup</span> should be started. Defaults to
<span class="code">true</span>.</p>
</dd>
<dt><strong><span class="code">start_memsup = bool()</span></strong></dt>
<dd>
<p>Specifies if <span class="code">memsup</span> should be started. Defaults to
<span class="code">true</span>.</p>
</dd>
<dt><strong><span class="code">start_os_sup = bool()</span></strong></dt>
<dd>
<p>Specifies if <span class="code">os_sup</span> should be started. Defaults to
<span class="code">false</span>.</p>
</dd>
</dl>
<p>Configuration parameters effecting the different OS_Mon services
are described in the respective man pages.</p>
<p>See <span class="bold_code bc-18"><a href="javascript:erlhref('../../../../doc/../','kernel','config.html');">config(4)</a></span> for
information about how to change the value of configuration
parameters.</p>
</div>
<h3><span onMouseOver="document.getElementById('ghlink-snmp-mibs-idm281472805133464').style.visibility = 'visible';" onMouseOut="document.getElementById('ghlink-snmp-mibs-idm281472805133464').style.visibility = 'hidden';"><span id="ghlink-snmp-mibs-idm281472805133464" class="ghlink"><a href="https://github.com/erlang/otp/edit/maint/lib/os_mon/doc/src/os_mon_app.xml#L90" title="Found an issue with the documentation? Fix it by clicking here!"><span class="pencil"></span></a></span><a class="title_link" name="snmp-mibs" href="#snmp-mibs">SNMP MIBs</a></span></h3>
<div class="REFBODY rb-3">
<p>The following MIBs are defined in OS_Mon:</p>
<dl>
<dt><strong>OTP-OS-MON-MIB</strong></dt>
<dd>
<p>This MIB contains objects for instrumentation of disk,
memory and CPU usage of the nodes in the system.</p>
</dd>
</dl>
<p>The MIB is stored in the <span class="code">mibs</span> directory. It is defined
in SNMPv2 SMI syntax. An SNMPv1 version of the MIB is delivered
in the <span class="code">mibs/v1</span> directory.</p>
<p>The compiled MIB is located under <span class="code">priv/mibs</span>, and
the generated <span class="code">.hrl</span> file under the <span class="code">include</span> directory.
To compile a MIB that IMPORTS the <span class="code">OTP-OS-MON-MIB</span>, give
the option <span class="code">{il, ["os_mon/priv/mibs"]}</span> to the MIB compiler.</p>
<p>If the MIB should be used in a system, it should be loaded into
an agent with a call to <span class="code">os_mon_mib:load(Agent)</span>, where
<span class="code">Agent</span> is the pid or registered name of an SNMP agent. Use
<span class="code">os_mon_mib:unload(Agent)</span> to unload the MIB.
The implementation of this MIB uses Mnesia to store a cache with
data needed, which implicates that Mnesia must be up and running.
The MIB also use functions defined for the <span class="code">OTP-MIB</span>, thus
that MIB must be loaded as well.</p>
</div>
<h3><span onMouseOver="document.getElementById('ghlink-see-also-idm281472804750600').style.visibility = 'visible';" onMouseOut="document.getElementById('ghlink-see-also-idm281472804750600').style.visibility = 'hidden';"><span id="ghlink-see-also-idm281472804750600" class="ghlink"><a href="https://github.com/erlang/otp/edit/maint/lib/os_mon/doc/src/os_mon_app.xml#L117" title="Found an issue with the documentation? Fix it by clicking here!"><span class="pencil"></span></a></span><a class="title_link" name="see-also" href="#see-also">See Also</a></span></h3>
<div class="REFBODY rb-3">
<p><span class="bold_code bc-19"><a href="cpu_sup.html">cpu_sup(3)</a></span>,
<span class="bold_code bc-19"><a href="disksup.html">disksup(3)</a></span>,
<span class="bold_code bc-19"><a href="memsup.html">memsup(3)</a></span>,
<span class="bold_code bc-19"><a href="os_sup.html">os_sup(3)</a></span>,
<span class="bold_code bc-19"><a href="nteventlog.html">nteventlog(3)</a></span>,
<span class="bold_code bc-18"><a href="javascript:erlhref('../../../../doc/../','snmp','snmp.html');">snmp(3)</a></span>.</p>
</div>
</div>
<div class="footer">
<hr>
<p>Copyright © 1997-2019 Ericsson AB. All Rights Reserved.</p>
</div>
</div>
</div>
<script type="text/javascript">window.__otpTopDocDir = '../../../../doc/js/';</script><script type="text/javascript" src="../../../../doc/js/highlight.js"></script>
</body>
</html>
