blob: e4ff1e5729cc04afc9c06a57394e007b3b864f70 [file] [log] [blame]
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>MonitorMemory</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">MonitorMemory</h1><h2>Description: </h2><p>Checks the amount of Java Heap available in the JVM for a particular JVM Memory Pool. If the amount of space used exceeds some configurable threshold, will warn (via a log message and System-Level Bulletin) that the memory pool is exceeding this threshold.</p><h3>Tags: </h3><p>monitor, memory, heap, jvm, gc, garbage collection, warning</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values.</p><table id="properties"><tr><th>Display Name</th><th>API Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Memory Pool</strong></td><td>Memory Pool</td><td id="default-value">G1 Old Gen</td><td id="allowable-values"><ul><li>G1 Eden Space</li><li>G1 Old Gen</li><li>G1 Survivor Space</li></ul></td><td id="description">The name of the JVM Memory Pool to monitor. The allowed values for Memory Pools are platform and JVM dependent and may vary for different versions of Java and from published documentation. This reporting task will become invalidated if configured to use a Memory Pool that is not available on the currently running host platform and JVM</td></tr><tr><td id="name"><strong>Usage Threshold</strong></td><td>Usage Threshold</td><td id="default-value">65%</td><td id="allowable-values"></td><td id="description">Indicates the threshold at which warnings should be generated. This can be a percentage or a Data Size</td></tr><tr><td id="name">Reporting Interval</td><td>Reporting Interval</td><td></td><td id="allowable-values"></td><td id="description">Indicates how often this reporting task should report bulletins while the memory utilization exceeds the configured threshold</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>System Resource Considerations:</h3>None specified.</body></html>