public interface LoggerConfigAdminMBean
LoggerConfig
.Modifier and Type | Field and Description |
---|---|
static String |
PATTERN
ObjectName pattern ("org.apache.logging.log4j2:type=%s,component=Loggers,name=%s") for LoggerConfigAdmin MBeans.
|
Modifier and Type | Method and Description |
---|---|
String[] |
getAppenderRefs()
Returns a String array with the appender refs configured for the
instrumented
LoggerConfig . |
String |
getFilter()
Returns a string description of all filters configured for the
instrumented
LoggerConfig . |
String |
getLevel()
Returns the
LoggerConfig level as a String. |
String |
getName()
Returns the name of the instrumented
LoggerConfig . |
boolean |
isAdditive()
Returns whether the instrumented
LoggerConfig is additive. |
boolean |
isIncludeLocation()
Returns whether the instrumented
LoggerConfig is configured to
include location. |
void |
setAdditive(boolean additive)
Sets whether the instrumented
LoggerConfig should be additive. |
void |
setLevel(String level)
Sets the
LoggerConfig level to the specified value. |
static final String PATTERN
You can find all registered LoggerConfigAdmin MBeans like this:
MBeanServer mbs = ManagementFactory.getPlatformMBeanServer(); String pattern = String.format(LoggerConfigAdminMBean.PATTERN, "*", "*"); Set<ObjectName> loggerConfigNames = mbs.queryNames(new ObjectName(pattern), null);
Some characters are not allowed in ObjectNames. The logger context name and logger config name may be quoted. When LoggerConfigAdmin MBeans are registered, their ObjectNames are created using this pattern as follows:
String ctxName = Server.escape(loggerContext.getName()); String loggerConfigName = Server.escape(loggerConfig.getName()); String name = String.format(PATTERN, ctxName, loggerConfigName); ObjectName objectName = new ObjectName(name);
Server.escape(String)
,
Constant Field ValuesString getName()
LoggerConfig
.String getLevel()
LoggerConfig
level as a String.LoggerConfig
level.void setLevel(String level)
LoggerConfig
level to the specified value.level
- the new LoggerConfig
level.IllegalArgumentException
- if the specified level is not one of
"OFF", "FATAL", "ERROR", "WARN", "INFO", "DEBUG", "TRACE",
"ALL"boolean isAdditive()
LoggerConfig
is additive.true
if the LoggerConfig is additive, false
otherwisevoid setAdditive(boolean additive)
LoggerConfig
should be additive.additive
- true
if the instrumented LoggerConfig should be
additive, false
otherwiseboolean isIncludeLocation()
LoggerConfig
is configured to
include location.String getFilter()
LoggerConfig
.String[] getAppenderRefs()
LoggerConfig
.LoggerConfig
.Copyright © 1999-2021 Apache Software Foundation. All Rights Reserved.
Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.