Class StatusLoggerAdmin
java.lang.Object
javax.management.NotificationBroadcasterSupport
org.apache.logging.log4j.core.jmx.StatusLoggerAdmin
- All Implemented Interfaces:
Closeable,AutoCloseable,EventListener,NotificationBroadcaster,NotificationEmitter,StatusLoggerAdminMBean,StatusListener
public class StatusLoggerAdmin
extends NotificationBroadcasterSupport
implements StatusListener, StatusLoggerAdminMBean
Implementation of the
StatusLoggerAdminMBean interface.-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final Stringprivate Levelprivate final ObjectNameprivate final AtomicLongFields inherited from interface org.apache.logging.log4j.core.jmx.StatusLoggerAdminMBean
NOTIF_TYPE_DATA, NOTIF_TYPE_MESSAGE, PATTERN -
Constructor Summary
ConstructorsConstructorDescriptionStatusLoggerAdmin(String contextName, Executor executor) Constructs a newStatusLoggerAdminwith theExecutorto be used for sendingNotifications asynchronously to listeners. -
Method Summary
Modifier and TypeMethodDescriptionvoidclose()private static MBeanNotificationInfoReturns the name of the LoggerContext that theStatusLoggeris associated with.getLevel()Returns theStatusLoggerlevel as a String.Returns theObjectNameof this mbean.Returns a list with the most recentStatusDataobjects in the status history.String[]Returns a string array with the most recent messages in the status history.Return the Log Level that this listener wants included.voidlog(StatusData data) Called as events occur to process the StatusData.private longprivate longprivate voidremoveListeners(String ctxName) Add listener to StatusLogger for this context, or replace it if it already exists.voidSets theStatusLoggerlevel to the specified value.Methods inherited from class javax.management.NotificationBroadcasterSupport
addNotificationListener, getNotificationInfo, handleNotification, removeNotificationListener, removeNotificationListener, sendNotification
-
Field Details
-
sequenceNo
-
objectName
-
contextName
-
level
-
-
Constructor Details
-
StatusLoggerAdmin
Constructs a newStatusLoggerAdminwith theExecutorto be used for sendingNotifications asynchronously to listeners.- Parameters:
contextName- name of the LoggerContext under which to register this StatusLoggerAdmin. Note that the StatusLogger may be registered multiple times, once for each LoggerContext. In web containers, each web application has its own LoggerContext and by associating the StatusLogger with the LoggerContext, all associated MBeans can be unloaded when the web application is undeployed.executor- used to send notifications asynchronously
-
-
Method Details
-
removeListeners
Add listener to StatusLogger for this context, or replace it if it already exists.- Parameters:
ctxName-
-
createNotificationInfo
-
getStatusDataHistory
Description copied from interface:StatusLoggerAdminMBeanReturns a string array with the most recent messages in the status history. The list has up to 200 entries by default but the length can be configured with system property"log4j2.status.entries".- Specified by:
getStatusDataHistoryin interfaceStatusLoggerAdminMBean- Returns:
- the most recent messages logged by the
StatusLogger.
-
getStatusData
Description copied from interface:StatusLoggerAdminMBeanReturns a list with the most recentStatusDataobjects in the status history. The list has up to 200 entries by default but the length can be configured with system property"log4j2.status.entries".Note that the returned objects may contain
Throwables from external libraries.JMX clients calling this method must be prepared to deal with the errors that occur if they do not have the class definition for such
Throwables in their classpath.- Specified by:
getStatusDatain interfaceStatusLoggerAdminMBean- Returns:
- the most recent messages logged by the
StatusLogger.
-
getLevel
Description copied from interface:StatusLoggerAdminMBeanReturns theStatusLoggerlevel as a String.- Specified by:
getLevelin interfaceStatusLoggerAdminMBean- Returns:
- the
StatusLoggerlevel.
-
getStatusLevel
Description copied from interface:StatusListenerReturn the Log Level that this listener wants included.- Specified by:
getStatusLevelin interfaceStatusListener- Returns:
- the Log Level.
-
setLevel
Description copied from interface:StatusLoggerAdminMBeanSets theStatusLoggerlevel to the specified value.- Specified by:
setLevelin interfaceStatusLoggerAdminMBean- Parameters:
level- the newStatusLoggerlevel.
-
getContextName
Description copied from interface:StatusLoggerAdminMBeanReturns the name of the LoggerContext that theStatusLoggeris associated with.- Specified by:
getContextNamein interfaceStatusLoggerAdminMBean- Returns:
- logger context name
-
log
Description copied from interface:StatusListenerCalled as events occur to process the StatusData.- Specified by:
login interfaceStatusListener- Parameters:
data- The StatusData for the event.
-
getObjectName
Returns theObjectNameof this mbean.- Specified by:
getObjectNamein interfaceStatusLoggerAdminMBean- Returns:
- the
ObjectName - See Also:
-
nextSeqNo
private long nextSeqNo() -
nowMillis
private long nowMillis() -
close
- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Throws:
IOException
-