Google Git
Sign in
apache / hadoop-site / 952d547359cafef280f0a0324055741b2ed55be1 / . / content / docs / r3.3.1 / hadoop-yarn / hadoop-yarn-common / apidocs / org / apache / hadoop / yarn / util / Log4jWarningErrorMetricsAppender.html
blob: 1756d29d78587a9d24e58cba587edfca7bf55edb [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_292) on Tue Jun 15 06:10:04 GMT 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Log4jWarningErrorMetricsAppender (Apache Hadoop YARN Common 3.3.1 API)</title>
<meta name="date" content="2021-06-15">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Log4jWarningErrorMetricsAppender (Apache Hadoop YARN Common 3.3.1 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":9,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Log4jWarningErrorMetricsAppender.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/hadoop/yarn/util/LinuxResourceCalculatorPlugin.html" title="class in org.apache.hadoop.yarn.util"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/hadoop/yarn/util/Log4jWarningErrorMetricsAppender.Element.html" title="class in org.apache.hadoop.yarn.util"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/hadoop/yarn/util/Log4jWarningErrorMetricsAppender.html" target="_top">Frames</a></li>
<li><a href="Log4jWarningErrorMetricsAppender.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.hadoop.yarn.util</div>
<h2 title="Class Log4jWarningErrorMetricsAppender" class="title">Class Log4jWarningErrorMetricsAppender</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.log4j.AppenderSkeleton</li>
<li>
<ul class="inheritance">
<li>org.apache.hadoop.yarn.util.Log4jWarningErrorMetricsAppender</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>org.apache.log4j.Appender, org.apache.log4j.spi.OptionHandler</dd>
</dl>
<hr>
<br>
<pre>@InterfaceAudience.Private
@InterfaceStability.Unstable
public class <span class="typeNameLabel">Log4jWarningErrorMetricsAppender</span>
extends org.apache.log4j.AppenderSkeleton</pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/util/Log4jWarningErrorMetricsAppender.Element.html" title="class in org.apache.hadoop.yarn.util">Log4jWarningErrorMetricsAppender.Element</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/util/Log4jWarningErrorMetricsAppender.html#LOG_METRICS_APPENDER">LOG_METRICS_APPENDER</a></span></code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.log4j.AppenderSkeleton">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.log4j.AppenderSkeleton</h3>
<code>closed, errorHandler, headFilter, layout, name, tailFilter, threshold</code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/util/Log4jWarningErrorMetricsAppender.html#Log4jWarningErrorMetricsAppender--">Log4jWarningErrorMetricsAppender</a></span>()</code>
<div class="block">Create an appender to keep track of the errors and warnings logged by the
system.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/util/Log4jWarningErrorMetricsAppender.html#Log4jWarningErrorMetricsAppender-int-long-int-">Log4jWarningErrorMetricsAppender</a></span>(int&nbsp;cleanupIntervalSeconds,
long&nbsp;messageAgeLimitSeconds,
int&nbsp;maxUniqueMessages)</code>
<div class="block">Create an appender to keep track of the errors and warnings logged by the
system.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/util/Log4jWarningErrorMetricsAppender.html#append-org.apache.log4j.spi.LoggingEvent-">append</a></span>(org.apache.log4j.spi.LoggingEvent&nbsp;event)</code></td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/util/Log4jWarningErrorMetricsAppender.html#close--">close</a></span>()</code></td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/hadoop/yarn/util/Log4jWarningErrorMetricsAppender.html" title="class in org.apache.hadoop.yarn.util">Log4jWarningErrorMetricsAppender</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/util/Log4jWarningErrorMetricsAppender.html#findAppender--">findAppender</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/util/Log4jWarningErrorMetricsAppender.html#getCleanupInterval--">getCleanupInterval</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/util/Log4jWarningErrorMetricsAppender.html#getErrorCounts-java.util.List-">getErrorCounts</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&gt;&nbsp;cutoffs)</code>
<div class="block">Get the counts of errors in the time periods provided.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../../org/apache/hadoop/yarn/util/Log4jWarningErrorMetricsAppender.Element.html" title="class in org.apache.hadoop.yarn.util">Log4jWarningErrorMetricsAppender.Element</a>&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/util/Log4jWarningErrorMetricsAppender.html#getErrorMessagesAndCounts-java.util.List-">getErrorMessagesAndCounts</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&gt;&nbsp;cutoffs)</code>
<div class="block">Get the errors and the number of occurrences for each of the errors for the
time cutoffs provided.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/util/Log4jWarningErrorMetricsAppender.html#getMaxUniqueMessages--">getMaxUniqueMessages</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/util/Log4jWarningErrorMetricsAppender.html#getMessageAgeLimitSeconds--">getMessageAgeLimitSeconds</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/util/Log4jWarningErrorMetricsAppender.html#getWarningCounts-java.util.List-">getWarningCounts</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&gt;&nbsp;cutoffs)</code>
<div class="block">Get the counts of warnings in the time periods provided.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../../org/apache/hadoop/yarn/util/Log4jWarningErrorMetricsAppender.Element.html" title="class in org.apache.hadoop.yarn.util">Log4jWarningErrorMetricsAppender.Element</a>&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/util/Log4jWarningErrorMetricsAppender.html#getWarningMessagesAndCounts-java.util.List-">getWarningMessagesAndCounts</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&gt;&nbsp;cutoffs)</code>
<div class="block">Get the warning and the number of occurrences for each of the warnings for
the time cutoffs provided.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/util/Log4jWarningErrorMetricsAppender.html#requiresLayout--">requiresLayout</a></span>()</code></td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/util/Log4jWarningErrorMetricsAppender.html#setCleanupInterval-long-">setCleanupInterval</a></span>(long&nbsp;cleanupInterval)</code>&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/util/Log4jWarningErrorMetricsAppender.html#setMaxUniqueMessages-int-">setMaxUniqueMessages</a></span>(int&nbsp;maxUniqueMessages)</code>&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/util/Log4jWarningErrorMetricsAppender.html#setMessageAgeLimitSeconds-long-">setMessageAgeLimitSeconds</a></span>(long&nbsp;messageAgeLimitSeconds)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.log4j.AppenderSkeleton">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.log4j.AppenderSkeleton</h3>
<code>activateOptions, addFilter, clearFilters, doAppend, finalize, getErrorHandler, getFilter, getFirstFilter, getLayout, getName, getThreshold, isAsSevereAsThreshold, setErrorHandler, setLayout, setName, setThreshold</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="LOG_METRICS_APPENDER">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>LOG_METRICS_APPENDER</h4>
<pre>public static final&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> LOG_METRICS_APPENDER</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.yarn.util.Log4jWarningErrorMetricsAppender.LOG_METRICS_APPENDER">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Log4jWarningErrorMetricsAppender--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Log4jWarningErrorMetricsAppender</h4>
<pre>public&nbsp;Log4jWarningErrorMetricsAppender()</pre>
<div class="block">Create an appender to keep track of the errors and warnings logged by the
system. It will keep purge messages older than 2 days. It will store upto
the last 500 unique errors and the last 500 unique warnings. The thread to
purge message will run every 5 minutes, unless the 500 message limit is hit
earlier.</div>
</li>
</ul>
<a name="Log4jWarningErrorMetricsAppender-int-long-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Log4jWarningErrorMetricsAppender</h4>
<pre>public&nbsp;Log4jWarningErrorMetricsAppender(int&nbsp;cleanupIntervalSeconds,
long&nbsp;messageAgeLimitSeconds,
int&nbsp;maxUniqueMessages)</pre>
<div class="block">Create an appender to keep track of the errors and warnings logged by the
system.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cleanupIntervalSeconds</code> - the interval at which old messages are purged to prevent the
message stores from growing unbounded</dd>
<dd><code>messageAgeLimitSeconds</code> - the maximum age of a message in seconds before it is purged from
the store</dd>
<dd><code>maxUniqueMessages</code> - the maximum number of unique messages of each type we keep before
we start purging</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="append-org.apache.log4j.spi.LoggingEvent-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>append</h4>
<pre>protected&nbsp;void&nbsp;append(org.apache.log4j.spi.LoggingEvent&nbsp;event)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>append</code>&nbsp;in class&nbsp;<code>org.apache.log4j.AppenderSkeleton</code></dd>
</dl>
</li>
</ul>
<a name="close--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>public&nbsp;void&nbsp;close()</pre>
</li>
</ul>
<a name="requiresLayout--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>requiresLayout</h4>
<pre>public&nbsp;boolean&nbsp;requiresLayout()</pre>
</li>
</ul>
<a name="getErrorCounts-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getErrorCounts</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&gt;&nbsp;getErrorCounts(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&gt;&nbsp;cutoffs)</pre>
<div class="block">Get the counts of errors in the time periods provided. Note that the counts
provided by this function may differ from the ones provided by
getErrorMessagesAndCounts since the message store is purged at regular
intervals to prevent it from growing without bounds, while the store for
the counts is purged less frequently.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cutoffs</code> - list of timestamp cutoffs(in seconds) for which the counts are
desired</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>list of error counts in the time periods corresponding to cutoffs</dd>
</dl>
</li>
</ul>
<a name="getWarningCounts-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWarningCounts</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>&gt;&nbsp;getWarningCounts(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&gt;&nbsp;cutoffs)</pre>
<div class="block">Get the counts of warnings in the time periods provided. Note that the
counts provided by this function may differ from the ones provided by
getWarningMessagesAndCounts since the message store is purged at regular
intervals to prevent it from growing without bounds, while the store for
the counts is purged less frequently.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cutoffs</code> - list of timestamp cutoffs(in seconds) for which the counts are
desired</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>list of warning counts in the time periods corresponding to cutoffs</dd>
</dl>
</li>
</ul>
<a name="getErrorMessagesAndCounts-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getErrorMessagesAndCounts</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../../org/apache/hadoop/yarn/util/Log4jWarningErrorMetricsAppender.Element.html" title="class in org.apache.hadoop.yarn.util">Log4jWarningErrorMetricsAppender.Element</a>&gt;&gt;&nbsp;getErrorMessagesAndCounts(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&gt;&nbsp;cutoffs)</pre>
<div class="block">Get the errors and the number of occurrences for each of the errors for the
time cutoffs provided. Note that the counts provided by this function may
differ from the ones provided by getErrorCounts since the message store is
purged at regular intervals to prevent it from growing without bounds,
while the store for the counts is purged less frequently.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cutoffs</code> - list of timestamp cutoffs(in seconds) for which the counts are
desired</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>list of maps corresponding for each cutoff provided; each map
contains the error and the number of times the error occurred in
the time period</dd>
</dl>
</li>
</ul>
<a name="getWarningMessagesAndCounts-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWarningMessagesAndCounts</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../../org/apache/hadoop/yarn/util/Log4jWarningErrorMetricsAppender.Element.html" title="class in org.apache.hadoop.yarn.util">Log4jWarningErrorMetricsAppender.Element</a>&gt;&gt;&nbsp;getWarningMessagesAndCounts(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>&gt;&nbsp;cutoffs)</pre>
<div class="block">Get the warning and the number of occurrences for each of the warnings for
the time cutoffs provided. Note that the counts provided by this function
may differ from the ones provided by getWarningCounts since the message
store is purged at regular intervals to prevent it from growing without
bounds, while the store for the counts is purged less frequently.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cutoffs</code> - list of timestamp cutoffs(in seconds) for which the counts are
desired</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>list of maps corresponding for each cutoff provided; each map
contains the warning and the number of times the error occurred in
the time period</dd>
</dl>
</li>
</ul>
<a name="getCleanupInterval--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCleanupInterval</h4>
<pre>public&nbsp;long&nbsp;getCleanupInterval()</pre>
</li>
</ul>
<a name="setCleanupInterval-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCleanupInterval</h4>
<pre>public&nbsp;void&nbsp;setCleanupInterval(long&nbsp;cleanupInterval)</pre>
</li>
</ul>
<a name="getMessageAgeLimitSeconds--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMessageAgeLimitSeconds</h4>
<pre>public&nbsp;long&nbsp;getMessageAgeLimitSeconds()</pre>
</li>
</ul>
<a name="setMessageAgeLimitSeconds-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMessageAgeLimitSeconds</h4>
<pre>public&nbsp;void&nbsp;setMessageAgeLimitSeconds(long&nbsp;messageAgeLimitSeconds)</pre>
</li>
</ul>
<a name="getMaxUniqueMessages--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxUniqueMessages</h4>
<pre>public&nbsp;int&nbsp;getMaxUniqueMessages()</pre>
</li>
</ul>
<a name="setMaxUniqueMessages-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMaxUniqueMessages</h4>
<pre>public&nbsp;void&nbsp;setMaxUniqueMessages(int&nbsp;maxUniqueMessages)</pre>
</li>
</ul>
<a name="findAppender--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>findAppender</h4>
<pre>public static&nbsp;<a href="../../../../../org/apache/hadoop/yarn/util/Log4jWarningErrorMetricsAppender.html" title="class in org.apache.hadoop.yarn.util">Log4jWarningErrorMetricsAppender</a>&nbsp;findAppender()</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Log4jWarningErrorMetricsAppender.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/hadoop/yarn/util/LinuxResourceCalculatorPlugin.html" title="class in org.apache.hadoop.yarn.util"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/hadoop/yarn/util/Log4jWarningErrorMetricsAppender.Element.html" title="class in org.apache.hadoop.yarn.util"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/hadoop/yarn/util/Log4jWarningErrorMetricsAppender.html" target="_top">Frames</a></li>
<li><a href="Log4jWarningErrorMetricsAppender.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2008&#x2013;2021 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>