Add warnings on possible misconfiguration. Change BurstFilter to use rate instead of interval
git-svn-id: https://svn.apache.org/repos/asf/logging/log4j/branches/BRANCH_2_0_EXPERIMENTAL/rgoers@1178286 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/log4j2-core/src/main/java/org/apache/logging/log4j/core/config/BaseConfiguration.java b/log4j2-core/src/main/java/org/apache/logging/log4j/core/config/BaseConfiguration.java
index 1bae5f1..912cfc1 100644
--- a/log4j2-core/src/main/java/org/apache/logging/log4j/core/config/BaseConfiguration.java
+++ b/log4j2-core/src/main/java/org/apache/logging/log4j/core/config/BaseConfiguration.java
@@ -18,8 +18,10 @@
import org.apache.logging.log4j.Logger;
import org.apache.logging.log4j.core.Appender;
+import org.apache.logging.log4j.core.ErrorHandler;
import org.apache.logging.log4j.core.Filter;
import org.apache.logging.log4j.core.Lifecycle;
+import org.apache.logging.log4j.core.appender.DefaultErrorHandler;
import org.apache.logging.log4j.core.config.plugins.PluginAttr;
import org.apache.logging.log4j.core.config.plugins.PluginFactory;
import org.apache.logging.log4j.core.config.plugins.PluginManager;
@@ -88,8 +90,7 @@
setup();
doConfigure();
for (Appender appender : appenders.values()) {
- if (appender instanceof Lifecycle)
- ((Lifecycle)appender).start();
+ appender.start();
}
startFilters();
@@ -103,9 +104,7 @@
logger.clearAppenders();
}
for (Appender appender : appenders.values()) {
- if (appender instanceof Lifecycle) {
- ((Lifecycle)appender).stop();
- }
+ appender.stop();
}
stopFilters();
}
@@ -114,6 +113,8 @@
}
protected void doConfigure() {
+ boolean setRoot = false;
+ boolean setLoggers = false;
for (Node child : rootNode.getChildren()) {
createConfiguration(child);
if (child.getObject() == null) {
@@ -128,12 +129,23 @@
} else if (child.getName().equals("loggers")) {
Loggers l = (Loggers) child.getObject();
loggers = l.getMap();
+ setLoggers = true;
if (l.getRoot() != null) {
root = l.getRoot();
+ setRoot = true;
}
+ } else {
+ logger.error("Unknown object \"" + child.getName() + "\" of type " +
+ child.getObject().getClass().getName() + " is ignored");
}
}
+ if (!setLoggers) {
+ logger.warn("No Loggers were configured, using default");
+ } else if (!setRoot) {
+ logger.warn("No Root logger was configured, using default");
+ }
+
root.setConfigurationMonitor(monitor);
for (Map.Entry<String, LoggerConfig> entry : loggers.entrySet()) {
diff --git a/log4j2-core/src/main/java/org/apache/logging/log4j/core/config/plugins/LoggersPlugin.java b/log4j2-core/src/main/java/org/apache/logging/log4j/core/config/plugins/LoggersPlugin.java
index 59c4d52..5b22fb4 100644
--- a/log4j2-core/src/main/java/org/apache/logging/log4j/core/config/plugins/LoggersPlugin.java
+++ b/log4j2-core/src/main/java/org/apache/logging/log4j/core/config/plugins/LoggersPlugin.java
@@ -35,7 +35,7 @@
for (LoggerConfig logger : loggers) {
if (logger != null) {
- if (logger.getName().equals("root")) {
+ if (logger.getName().length() == 0) {
root = logger;
}
loggerMap.put(logger.getName(), logger);
diff --git a/log4j2-core/src/main/java/org/apache/logging/log4j/core/filter/BurstFilter.java b/log4j2-core/src/main/java/org/apache/logging/log4j/core/filter/BurstFilter.java
index 6ab339a..eca587e 100644
--- a/log4j2-core/src/main/java/org/apache/logging/log4j/core/filter/BurstFilter.java
+++ b/log4j2-core/src/main/java/org/apache/logging/log4j/core/filter/BurstFilter.java
@@ -40,7 +40,7 @@
* statements that can be sent to an appender. The filter is configured in the
* log4j configuration file. For example, the following configuration limits the
* number of INFO level (as well as DEBUG and TRACE) log statements that can be sent to the
- * console to a burst of 100 within 6 seconds. WARN, ERROR and FATAL messages would continue to
+ * console to a burst of 100 with an average rate of 16 per second. WARN, ERROR and FATAL messages would continue to
* be delivered.<br>
* <br>
* <p/>
@@ -48,7 +48,7 @@
* <Console name="console"><br>
* <PatternLayout pattern="%-5p %d{dd-MMM-yyyy HH:mm:ss} %x %t %m%n"/><br>
* $lt;filters><br>
- * <Burst level="INFO" burstInterval="6" maxBurst="100"/><br>
+ * <Burst level="INFO" rate="16" maxBurst="100"/><br>
* </filters><br>
* </Console><br>
* </code><br>
@@ -58,6 +58,11 @@
public class BurstFilter extends FilterBase {
private static final long NANOS_IN_SECONDS = 1000000000;
+
+ private static final int DEFAULT_RATE = 10;
+
+ private static final int DEFAULT_RATE_MULTIPLE = 100;
+
/**
* Level of messages to be filtered. Anything at or below this level will be
* filtered out if <code>maxBurst</code> has been exceeded. The default is
@@ -72,11 +77,10 @@
private final Queue<LogDelay> available = new ConcurrentLinkedQueue<LogDelay>();
- private BurstFilter(Level level, long burstInterval, long maxBurst,
- Result onMatch, Result onMismatch) {
+ private BurstFilter(Level level, long rate, long maxBurst, Result onMatch, Result onMismatch) {
super(onMatch, onMismatch);
this.level = level;
- this.burstInterval = burstInterval;
+ this.burstInterval = maxBurst / rate;
for (int i = 0; i < maxBurst; ++i) {
available.add(new LogDelay());
}
@@ -197,37 +201,31 @@
}
/**
- * @param level The logging level.
- * @param burstInterval Interval, in seconds, at which to add to the number of log statements
- * that will be allowed following a burst. This value specifies how often
- * <code>burstRecoverAmount</code> statements will be added to the total number
- * allowed for every <code>burstRecoveryInterval</code> that passes
- * following a burst, up to but not exceeding <code>maxBurst</code>.
- * @param maxBurst This value dictates the maximum traffic burst that can be logged to any appender
- * that uses the <code>BurstFilter</code>, i.e. there can never be more than
- * <code>maxBurst</code> log statements sent to an appender in
- * <code>burstRecoveryInterval</code> seconds.
- * @param match
- * @param mismatch
+ * @param level The logging level.
+ * @param rate The average number of events per second to allow.
+ * @param maxBurst The maximum number of events that can occur before events are filtered for exceeding the
+ * average rate. The default is 10 times the rate.
+ * @param match The Result to return when the filter matches. Defaults to Result.NEUTRAL.
+ * @param mismatch The Result to return when the filter does not match. The default is Result.DENY.
* @return
*/
@PluginFactory
public static BurstFilter createFilter(@PluginAttr("level") String level,
- @PluginAttr("burstInterval") String burstInterval,
+ @PluginAttr("rate") String rate,
@PluginAttr("maxBurst") String maxBurst,
@PluginAttr("onmatch") String match,
@PluginAttr("onmismatch") String mismatch) {
Result onMatch = match == null ? null : Result.valueOf(match);
Result onMismatch = mismatch == null ? null : Result.valueOf(mismatch);
Level lvl = Level.toLevel(level, Level.WARN);
- long brInterval = burstInterval == null ? 0 : Long.parseLong(burstInterval);
- long max = maxBurst == null ? 0 : Long.parseLong(maxBurst);
+ long eventRate = rate == null ? DEFAULT_RATE : Long.parseLong(rate);
+ long max = maxBurst == null ? eventRate * DEFAULT_RATE_MULTIPLE : Long.parseLong(maxBurst);
if (onMatch == null) {
onMatch = Result.NEUTRAL;
}
if (onMismatch == null) {
onMismatch = Result.DENY;
}
- return new BurstFilter(lvl, brInterval, max, onMatch, onMismatch);
+ return new BurstFilter(lvl, eventRate, max, onMatch, onMismatch);
}
}
\ No newline at end of file
diff --git a/log4j2-core/src/test/resources/log4j-burst.xml b/log4j2-core/src/test/resources/log4j-burst.xml
index 44ea1d5..dfa4b09 100644
--- a/log4j2-core/src/test/resources/log4j-burst.xml
+++ b/log4j2-core/src/test/resources/log4j-burst.xml
@@ -5,7 +5,7 @@
<List name="ListAppender">
<PatternLayout pattern="%-5p %d{dd-MMM-yyyy HH:mm:ss} %t %m%n"/>
<filters>
- <Burst level="INFO" burstInterval="3" maxBurst="100"/>
+ <Burst level="INFO" rate="33" maxBurst="100"/>
</filters>
</List>
</appenders>
