Interface LoggerConfigAdminMBean
- All Known Implementing Classes:
LoggerConfigAdmin
public interface LoggerConfigAdminMBean
The MBean interface for monitoring and managing a
LoggerConfig.-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionString[]Returns a String array with the appender refs configured for the instrumentedLoggerConfig.Returns a string description of all filters configured for the instrumentedLoggerConfig.getLevel()Returns theLoggerConfiglevel as a String.getName()Returns the name of the instrumentedLoggerConfig.booleanReturns whether the instrumentedLoggerConfigis additive.booleanReturns whether the instrumentedLoggerConfigis configured to include location.voidsetAdditive(boolean additive) Sets whether the instrumentedLoggerConfigshould be additive.voidSets theLoggerConfiglevel to the specified value.
-
Field Details
-
PATTERN
ObjectName pattern ("org.apache.logging.log4j2:type=%s,component=Loggers,name=%s") for LoggerConfigAdmin MBeans. This pattern contains two variables, where the first is the name of the context, the second is the name of the instrumented logger config.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);
- See Also:
-
-
Method Details
-
getName
String getName()Returns the name of the instrumentedLoggerConfig.- Returns:
- the name of the LoggerConfig
-
getLevel
String getLevel()Returns theLoggerConfiglevel as a String.- Returns:
- the
LoggerConfiglevel.
-
setLevel
Sets theLoggerConfiglevel to the specified value.- Parameters:
level- the newLoggerConfiglevel.- Throws:
IllegalArgumentException- if the specified level is not one of "OFF", "FATAL", "ERROR", "WARN", "INFO", "DEBUG", "TRACE", "ALL"
-
isAdditive
boolean isAdditive()Returns whether the instrumentedLoggerConfigis additive.- Returns:
trueif the LoggerConfig is additive,falseotherwise
-
setAdditive
void setAdditive(boolean additive) Sets whether the instrumentedLoggerConfigshould be additive.- Parameters:
additive-trueif the instrumented LoggerConfig should be additive,falseotherwise
-
isIncludeLocation
boolean isIncludeLocation()Returns whether the instrumentedLoggerConfigis configured to include location.- Returns:
- whether location should be passed downstream
-
getFilter
String getFilter()Returns a string description of all filters configured for the instrumentedLoggerConfig.- Returns:
- a string description of all configured filters for this LoggerConfig
-
getAppenderRefs
String[] getAppenderRefs()Returns a String array with the appender refs configured for the instrumentedLoggerConfig.- Returns:
- the appender refs for the instrumented
LoggerConfig.
-