Class Server
java.lang.Object
org.apache.logging.log4j.core.jmx.Server
Creates MBeans to instrument various classes in the log4j class hierarchy.
All instrumentation for Log4j 2 classes can be disabled by setting system property -Dlog4j2.disable.jmx=true
.
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionstatic String
Either returns the specified name as is, or returns a quoted value containing the specified name with the special characters (comma, equals, colon, quote, asterisk, or question mark) preceded with a backslash.static void
static void
static void
unregisterLoggerContext
(String loggerContextName) Unregisters all MBeans associated with the specified logger context (including MBeans forLoggerConfig
s andAppender
s from the platform MBean server.static void
unregisterLoggerContext
(String contextName, MBeanServer mbs) Unregisters all MBeans associated with the specified logger context (including MBeans forLoggerConfig
s andAppender
s from the platform MBean server.static void
Unregister all log4j MBeans from the platform MBean server.static void
Unregister all log4j MBeans from the specified MBean server.
-
Field Details
-
DOMAIN
The domain part, or prefix ("org.apache.logging.log4j2") of theObjectName
of all MBeans that instrument Log4J2 components.- See Also:
-
-
Method Details
-
escape
Either returns the specified name as is, or returns a quoted value containing the specified name with the special characters (comma, equals, colon, quote, asterisk, or question mark) preceded with a backslash.- Parameters:
name
- the name to escape so it can be used as a value in anObjectName
.- Returns:
- the escaped name
-
reregisterMBeansAfterReconfigure
public static void reregisterMBeansAfterReconfigure() -
reregisterMBeansAfterReconfigure
-
unregisterMBeans
public static void unregisterMBeans()Unregister all log4j MBeans from the platform MBean server. -
unregisterMBeans
Unregister all log4j MBeans from the specified MBean server.- Parameters:
mbs
- the MBean server to unregister from.
-
unregisterLoggerContext
Unregisters all MBeans associated with the specified logger context (including MBeans forLoggerConfig
s andAppender
s from the platform MBean server.- Parameters:
loggerContextName
- name of the logger context to unregister
-
unregisterLoggerContext
Unregisters all MBeans associated with the specified logger context (including MBeans forLoggerConfig
s andAppender
s from the platform MBean server.- Parameters:
contextName
- name of the logger context to unregistermbs
- the MBean Server to unregister the instrumented objects from
-