Interface AppenderAdminMBean
- All Known Implementing Classes:
AppenderAdmin
public interface AppenderAdminMBean
The MBean interface for monitoring and managing an
Appender.-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionReturns the result of callingtoStringon the error handler of this appender, or"null"if no error handler was set.Returns a string description of all filters configured for the instrumentedAppender.Returns the result of callingtoStringon theLayoutobject of the instrumentedAppender.getName()Returns the name of the instrumentedAppender.booleanReturns how exceptions thrown on the instrumentedAppenderare handled.
-
Field Details
-
PATTERN
ObjectName pattern ("org.apache.logging.log4j2:type=%s,component=Appenders,name=%s") for AppenderAdmin MBeans. This pattern contains two variables, where the first is the name of the context, the second is the name of the instrumented appender.You can find all registered AppenderAdmin MBeans like this:
MBeanServer mbs = ManagementFactory.getPlatformMBeanServer(); String pattern = String.format(AppenderAdminMBean.PATTERN, "*", "*"); Set<ObjectName> appenderNames = mbs.queryNames(new ObjectName(pattern), null);
Some characters are not allowed in ObjectNames. The logger context name and appender name may be quoted. When AppenderAdmin MBeans are registered, their ObjectNames are created using this pattern as follows:
String ctxName = Server.escape(loggerContext.getName()); String appenderName = Server.escape(appender.getName()); String name = String.format(PATTERN, ctxName, appenderName); ObjectName objectName = new ObjectName(name);
- See Also:
-
-
Method Details
-
getName
String getName()Returns the name of the instrumentedAppender.- Returns:
- the name of the Appender
-
getLayout
String getLayout()Returns the result of callingtoStringon theLayoutobject of the instrumentedAppender.- Returns:
- the
Layoutof the instrumentedAppenderas a string
-
isIgnoreExceptions
boolean isIgnoreExceptions()Returns how exceptions thrown on the instrumentedAppenderare handled.- Returns:
trueif any exceptions thrown by the Appender will be logged orfalseif such exceptions are re-thrown.
-
getErrorHandler
String getErrorHandler()Returns the result of callingtoStringon the error handler of this appender, or"null"if no error handler was set.- Returns:
- result of calling
toStringon the error handler of this appender, or"null"
-
getFilter
String getFilter()Returns a string description of all filters configured for the instrumentedAppender.- Returns:
- a string description of all configured filters for this appender
-