| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> |
| <span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache license, Version 2.0<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * the License. You may obtain a copy of the License at<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> *<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> *<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * See the license for the specific language governing permissions and<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * limitations under the license.<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> */<a name="line.16"></a> |
| <span class="sourceLineNo">017</span>package org.apache.logging.log4j.core.jmx;<a name="line.17"></a> |
| <span class="sourceLineNo">018</span><a name="line.18"></a> |
| <span class="sourceLineNo">019</span>import java.lang.management.ManagementFactory;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.util.List;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.util.Map;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.util.Set;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.util.concurrent.Executor;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import java.util.concurrent.ExecutorService;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import java.util.concurrent.Executors;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span><a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import javax.management.InstanceAlreadyExistsException;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import javax.management.InstanceNotFoundException;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import javax.management.MBeanRegistrationException;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import javax.management.MBeanServer;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import javax.management.NotCompliantMBeanException;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import javax.management.ObjectName;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span><a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import org.apache.logging.log4j.LogManager;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import org.apache.logging.log4j.core.Appender;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span>import org.apache.logging.log4j.core.LoggerContext;<a name="line.36"></a> |
| <span class="sourceLineNo">037</span>import org.apache.logging.log4j.core.appender.AsyncAppender;<a name="line.37"></a> |
| <span class="sourceLineNo">038</span>import org.apache.logging.log4j.core.async.AsyncLoggerConfig;<a name="line.38"></a> |
| <span class="sourceLineNo">039</span>import org.apache.logging.log4j.core.async.AsyncLoggerContext;<a name="line.39"></a> |
| <span class="sourceLineNo">040</span>import org.apache.logging.log4j.core.config.LoggerConfig;<a name="line.40"></a> |
| <span class="sourceLineNo">041</span>import org.apache.logging.log4j.core.impl.Log4jContextFactory;<a name="line.41"></a> |
| <span class="sourceLineNo">042</span>import org.apache.logging.log4j.core.selector.ContextSelector;<a name="line.42"></a> |
| <span class="sourceLineNo">043</span>import org.apache.logging.log4j.core.util.Constants;<a name="line.43"></a> |
| <span class="sourceLineNo">044</span>import org.apache.logging.log4j.core.util.Log4jThreadFactory;<a name="line.44"></a> |
| <span class="sourceLineNo">045</span>import org.apache.logging.log4j.spi.LoggerContextFactory;<a name="line.45"></a> |
| <span class="sourceLineNo">046</span>import org.apache.logging.log4j.status.StatusLogger;<a name="line.46"></a> |
| <span class="sourceLineNo">047</span>import org.apache.logging.log4j.util.PropertiesUtil;<a name="line.47"></a> |
| <span class="sourceLineNo">048</span><a name="line.48"></a> |
| <span class="sourceLineNo">049</span>/**<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * Creates MBeans to instrument various classes in the log4j class hierarchy.<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * <p><a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * All instrumentation for Log4j 2 classes can be disabled by setting system property {@code -Dlog4j2.disable.jmx=true}.<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * </p><a name="line.53"></a> |
| <span class="sourceLineNo">054</span> */<a name="line.54"></a> |
| <span class="sourceLineNo">055</span>public final class Server {<a name="line.55"></a> |
| <span class="sourceLineNo">056</span><a name="line.56"></a> |
| <span class="sourceLineNo">057</span> private static final String CONTEXT_NAME_ALL = "*";<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> /**<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * The domain part, or prefix ({@value}) of the {@code ObjectName} of all MBeans that instrument Log4J2 components.<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> */<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> public static final String DOMAIN = "org.apache.logging.log4j2";<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> private static final String PROPERTY_DISABLE_JMX = "log4j2.disable.jmx";<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> private static final String PROPERTY_ASYNC_NOTIF = "log4j2.jmx.notify.async";<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> private static final String THREAD_NAME_PREFIX = "jmx.notif";<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> private static final StatusLogger LOGGER = StatusLogger.getLogger();<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> static final Executor executor = isJmxDisabled() ? null : createExecutor();<a name="line.66"></a> |
| <span class="sourceLineNo">067</span><a name="line.67"></a> |
| <span class="sourceLineNo">068</span> private Server() {<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> }<a name="line.69"></a> |
| <span class="sourceLineNo">070</span><a name="line.70"></a> |
| <span class="sourceLineNo">071</span> /**<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * Returns either a {@code null} Executor (causing JMX notifications to be sent from the caller thread) or a daemon<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * background thread Executor, depending on the value of system property "log4j2.jmx.notify.async". If this<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> * property is not set, use a {@code null} Executor for web apps to avoid memory leaks and other issues when the<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * web app is restarted.<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * @see <a href="https://issues.apache.org/jira/browse/LOG4J2-938">LOG4J2-938</a><a name="line.76"></a> |
| <span class="sourceLineNo">077</span> */<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> private static ExecutorService createExecutor() {<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> final boolean defaultAsync = !Constants.IS_WEB_APP;<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> final boolean async = PropertiesUtil.getProperties().getBooleanProperty(PROPERTY_ASYNC_NOTIF, defaultAsync);<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> return async ? Executors.newFixedThreadPool(1, Log4jThreadFactory.createDaemonThreadFactory(THREAD_NAME_PREFIX))<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> : null;<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> }<a name="line.83"></a> |
| <span class="sourceLineNo">084</span><a name="line.84"></a> |
| <span class="sourceLineNo">085</span> /**<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * Either returns the specified name as is, or returns a quoted value containing the specified name with the special<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * characters (comma, equals, colon, quote, asterisk, or question mark) preceded with a backslash.<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> *<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * @param name the name to escape so it can be used as a value in an {@link ObjectName}.<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> * @return the escaped name<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> */<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> public static String escape(final String name) {<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> final StringBuilder sb = new StringBuilder(name.length() * 2);<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> boolean needsQuotes = false;<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> for (int i = 0; i < name.length(); i++) {<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> final char c = name.charAt(i);<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> switch (c) {<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> case '\\':<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> case '*':<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> case '?':<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> case '\"':<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> // quote, star, question & backslash must be escaped<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> sb.append('\\');<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> needsQuotes = true; // ... and can only appear in quoted value<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> break;<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> case ',':<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> case '=':<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> case ':':<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> // no need to escape these, but value must be quoted<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> needsQuotes = true;<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> break;<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> case '\r':<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> // drop \r characters: \\r gives "invalid escape sequence"<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> continue;<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> case '\n':<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> // replace \n characters with \\n sequence<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> sb.append("\\n");<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> needsQuotes = true;<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> continue;<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> }<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> sb.append(c);<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> }<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> if (needsQuotes) {<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> sb.insert(0, '\"');<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> sb.append('\"');<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> }<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> return sb.toString();<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> }<a name="line.128"></a> |
| <span class="sourceLineNo">129</span><a name="line.129"></a> |
| <span class="sourceLineNo">130</span> private static boolean isJmxDisabled() {<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> return PropertiesUtil.getProperties().getBooleanProperty(PROPERTY_DISABLE_JMX);<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> }<a name="line.132"></a> |
| <span class="sourceLineNo">133</span><a name="line.133"></a> |
| <span class="sourceLineNo">134</span> public static void reregisterMBeansAfterReconfigure() {<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> // avoid creating Platform MBean Server if JMX disabled<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> if (isJmxDisabled()) {<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> LOGGER.debug("JMX disabled for Log4j2. Not registering MBeans.");<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> return;<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> }<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> final MBeanServer mbs = ManagementFactory.getPlatformMBeanServer();<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> reregisterMBeansAfterReconfigure(mbs);<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> }<a name="line.142"></a> |
| <span class="sourceLineNo">143</span><a name="line.143"></a> |
| <span class="sourceLineNo">144</span> public static void reregisterMBeansAfterReconfigure(final MBeanServer mbs) {<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> if (isJmxDisabled()) {<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> LOGGER.debug("JMX disabled for Log4j2. Not registering MBeans.");<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> return;<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> }<a name="line.148"></a> |
| <span class="sourceLineNo">149</span><a name="line.149"></a> |
| <span class="sourceLineNo">150</span> // now provide instrumentation for the newly configured<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> // LoggerConfigs and Appenders<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> try {<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> final ContextSelector selector = getContextSelector();<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> if (selector == null) {<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> LOGGER.debug("Could not register MBeans: no ContextSelector found.");<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> return;<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> }<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> LOGGER.trace("Reregistering MBeans after reconfigure. Selector={}", selector);<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> final List<LoggerContext> contexts = selector.getLoggerContexts();<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> int i = 0;<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> for (final LoggerContext ctx : contexts) {<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> LOGGER.trace("Reregistering context ({}/{}): '{}' {}", ++i, contexts.size(), ctx.getName(), ctx);<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> // first unregister the context and all nested loggers,<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> // appenders, statusLogger, contextSelector, ringbuffers...<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> unregisterLoggerContext(ctx.getName(), mbs);<a name="line.165"></a> |
| <span class="sourceLineNo">166</span><a name="line.166"></a> |
| <span class="sourceLineNo">167</span> final LoggerContextAdmin mbean = new LoggerContextAdmin(ctx, executor);<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> register(mbs, mbean, mbean.getObjectName());<a name="line.168"></a> |
| <span class="sourceLineNo">169</span><a name="line.169"></a> |
| <span class="sourceLineNo">170</span> if (ctx instanceof AsyncLoggerContext) {<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> final RingBufferAdmin rbmbean = ((AsyncLoggerContext) ctx).createRingBufferAdmin();<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> if (rbmbean.getBufferSize() > 0) {<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> // don't register if Disruptor not started (DefaultConfiguration: config not found)<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> register(mbs, rbmbean, rbmbean.getObjectName());<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> }<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> }<a name="line.176"></a> |
| <span class="sourceLineNo">177</span><a name="line.177"></a> |
| <span class="sourceLineNo">178</span> // register the status logger and the context selector<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> // repeatedly<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> // for each known context: if one context is unregistered,<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> // these MBeans should still be available for the other<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> // contexts.<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> registerStatusLogger(ctx.getName(), mbs, executor);<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> registerContextSelector(ctx.getName(), selector, mbs, executor);<a name="line.184"></a> |
| <span class="sourceLineNo">185</span><a name="line.185"></a> |
| <span class="sourceLineNo">186</span> registerLoggerConfigs(ctx, mbs, executor);<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> registerAppenders(ctx, mbs, executor);<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> }<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> } catch (final Exception ex) {<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> LOGGER.error("Could not register mbeans", ex);<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> }<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> }<a name="line.192"></a> |
| <span class="sourceLineNo">193</span><a name="line.193"></a> |
| <span class="sourceLineNo">194</span> /**<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> * Unregister all log4j MBeans from the platform MBean server.<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> */<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> public static void unregisterMBeans() {<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> if (isJmxDisabled()) {<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> LOGGER.debug("JMX disabled for Log4j2. Not unregistering MBeans.");<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> return;<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> }<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> unregisterMBeans(ManagementFactory.getPlatformMBeanServer());<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> }<a name="line.203"></a> |
| <span class="sourceLineNo">204</span><a name="line.204"></a> |
| <span class="sourceLineNo">205</span> /**<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> * Unregister all log4j MBeans from the specified MBean server.<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> *<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> * @param mbs the MBean server to unregister from.<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> */<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> public static void unregisterMBeans(final MBeanServer mbs) {<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> if (mbs != null) {<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> unregisterStatusLogger(CONTEXT_NAME_ALL, mbs);<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> unregisterContextSelector(CONTEXT_NAME_ALL, mbs);<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> unregisterContexts(mbs);<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> unregisterLoggerConfigs(CONTEXT_NAME_ALL, mbs);<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> unregisterAsyncLoggerRingBufferAdmins(CONTEXT_NAME_ALL, mbs);<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> unregisterAsyncLoggerConfigRingBufferAdmins(CONTEXT_NAME_ALL, mbs);<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> unregisterAppenders(CONTEXT_NAME_ALL, mbs);<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> unregisterAsyncAppenders(CONTEXT_NAME_ALL, mbs);<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> }<a name="line.220"></a> |
| <span class="sourceLineNo">221</span> }<a name="line.221"></a> |
| <span class="sourceLineNo">222</span><a name="line.222"></a> |
| <span class="sourceLineNo">223</span> /**<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> * Returns the {@code ContextSelector} of the current {@code Log4jContextFactory}.<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> *<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> * @return the {@code ContextSelector} of the current {@code Log4jContextFactory}<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> */<a name="line.227"></a> |
| <span class="sourceLineNo">228</span> private static ContextSelector getContextSelector() {<a name="line.228"></a> |
| <span class="sourceLineNo">229</span> final LoggerContextFactory factory = LogManager.getFactory();<a name="line.229"></a> |
| <span class="sourceLineNo">230</span> if (factory instanceof Log4jContextFactory) {<a name="line.230"></a> |
| <span class="sourceLineNo">231</span> final ContextSelector selector = ((Log4jContextFactory) factory).getSelector();<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> return selector;<a name="line.232"></a> |
| <span class="sourceLineNo">233</span> }<a name="line.233"></a> |
| <span class="sourceLineNo">234</span> return null;<a name="line.234"></a> |
| <span class="sourceLineNo">235</span> }<a name="line.235"></a> |
| <span class="sourceLineNo">236</span><a name="line.236"></a> |
| <span class="sourceLineNo">237</span> /**<a name="line.237"></a> |
| <span class="sourceLineNo">238</span> * Unregisters all MBeans associated with the specified logger context (including MBeans for {@code LoggerConfig}s<a name="line.238"></a> |
| <span class="sourceLineNo">239</span> * and {@code Appender}s from the platform MBean server.<a name="line.239"></a> |
| <span class="sourceLineNo">240</span> *<a name="line.240"></a> |
| <span class="sourceLineNo">241</span> * @param loggerContextName name of the logger context to unregister<a name="line.241"></a> |
| <span class="sourceLineNo">242</span> */<a name="line.242"></a> |
| <span class="sourceLineNo">243</span> public static void unregisterLoggerContext(final String loggerContextName) {<a name="line.243"></a> |
| <span class="sourceLineNo">244</span> if (isJmxDisabled()) {<a name="line.244"></a> |
| <span class="sourceLineNo">245</span> LOGGER.debug("JMX disabled for Log4j2. Not unregistering MBeans.");<a name="line.245"></a> |
| <span class="sourceLineNo">246</span> return;<a name="line.246"></a> |
| <span class="sourceLineNo">247</span> }<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> final MBeanServer mbs = ManagementFactory.getPlatformMBeanServer();<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> unregisterLoggerContext(loggerContextName, mbs);<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> }<a name="line.250"></a> |
| <span class="sourceLineNo">251</span><a name="line.251"></a> |
| <span class="sourceLineNo">252</span> /**<a name="line.252"></a> |
| <span class="sourceLineNo">253</span> * Unregisters all MBeans associated with the specified logger context (including MBeans for {@code LoggerConfig}s<a name="line.253"></a> |
| <span class="sourceLineNo">254</span> * and {@code Appender}s from the platform MBean server.<a name="line.254"></a> |
| <span class="sourceLineNo">255</span> *<a name="line.255"></a> |
| <span class="sourceLineNo">256</span> * @param contextName name of the logger context to unregister<a name="line.256"></a> |
| <span class="sourceLineNo">257</span> * @param mbs the MBean Server to unregister the instrumented objects from<a name="line.257"></a> |
| <span class="sourceLineNo">258</span> */<a name="line.258"></a> |
| <span class="sourceLineNo">259</span> public static void unregisterLoggerContext(final String contextName, final MBeanServer mbs) {<a name="line.259"></a> |
| <span class="sourceLineNo">260</span> final String search = String.format(LoggerContextAdminMBean.PATTERN, escape(contextName), "*");<a name="line.260"></a> |
| <span class="sourceLineNo">261</span> unregisterAllMatching(search, mbs); // unregister context mbean<a name="line.261"></a> |
| <span class="sourceLineNo">262</span><a name="line.262"></a> |
| <span class="sourceLineNo">263</span> // now unregister all MBeans associated with this logger context<a name="line.263"></a> |
| <span class="sourceLineNo">264</span> unregisterStatusLogger(contextName, mbs);<a name="line.264"></a> |
| <span class="sourceLineNo">265</span> unregisterContextSelector(contextName, mbs);<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> unregisterLoggerConfigs(contextName, mbs);<a name="line.266"></a> |
| <span class="sourceLineNo">267</span> unregisterAppenders(contextName, mbs);<a name="line.267"></a> |
| <span class="sourceLineNo">268</span> unregisterAsyncAppenders(contextName, mbs);<a name="line.268"></a> |
| <span class="sourceLineNo">269</span> unregisterAsyncLoggerRingBufferAdmins(contextName, mbs);<a name="line.269"></a> |
| <span class="sourceLineNo">270</span> unregisterAsyncLoggerConfigRingBufferAdmins(contextName, mbs);<a name="line.270"></a> |
| <span class="sourceLineNo">271</span> }<a name="line.271"></a> |
| <span class="sourceLineNo">272</span><a name="line.272"></a> |
| <span class="sourceLineNo">273</span> private static void registerStatusLogger(final String contextName, final MBeanServer mbs, final Executor executor)<a name="line.273"></a> |
| <span class="sourceLineNo">274</span> throws InstanceAlreadyExistsException, MBeanRegistrationException, NotCompliantMBeanException {<a name="line.274"></a> |
| <span class="sourceLineNo">275</span><a name="line.275"></a> |
| <span class="sourceLineNo">276</span> final StatusLoggerAdmin mbean = new StatusLoggerAdmin(contextName, executor);<a name="line.276"></a> |
| <span class="sourceLineNo">277</span> register(mbs, mbean, mbean.getObjectName());<a name="line.277"></a> |
| <span class="sourceLineNo">278</span> }<a name="line.278"></a> |
| <span class="sourceLineNo">279</span><a name="line.279"></a> |
| <span class="sourceLineNo">280</span> private static void registerContextSelector(final String contextName, final ContextSelector selector,<a name="line.280"></a> |
| <span class="sourceLineNo">281</span> final MBeanServer mbs, final Executor executor) throws InstanceAlreadyExistsException,<a name="line.281"></a> |
| <span class="sourceLineNo">282</span> MBeanRegistrationException, NotCompliantMBeanException {<a name="line.282"></a> |
| <span class="sourceLineNo">283</span><a name="line.283"></a> |
| <span class="sourceLineNo">284</span> final ContextSelectorAdmin mbean = new ContextSelectorAdmin(contextName, selector);<a name="line.284"></a> |
| <span class="sourceLineNo">285</span> register(mbs, mbean, mbean.getObjectName());<a name="line.285"></a> |
| <span class="sourceLineNo">286</span> }<a name="line.286"></a> |
| <span class="sourceLineNo">287</span><a name="line.287"></a> |
| <span class="sourceLineNo">288</span> private static void unregisterStatusLogger(final String contextName, final MBeanServer mbs) {<a name="line.288"></a> |
| <span class="sourceLineNo">289</span> final String search = String.format(StatusLoggerAdminMBean.PATTERN, escape(contextName), "*");<a name="line.289"></a> |
| <span class="sourceLineNo">290</span> unregisterAllMatching(search, mbs);<a name="line.290"></a> |
| <span class="sourceLineNo">291</span> }<a name="line.291"></a> |
| <span class="sourceLineNo">292</span><a name="line.292"></a> |
| <span class="sourceLineNo">293</span> private static void unregisterContextSelector(final String contextName, final MBeanServer mbs) {<a name="line.293"></a> |
| <span class="sourceLineNo">294</span> final String search = String.format(ContextSelectorAdminMBean.PATTERN, escape(contextName), "*");<a name="line.294"></a> |
| <span class="sourceLineNo">295</span> unregisterAllMatching(search, mbs);<a name="line.295"></a> |
| <span class="sourceLineNo">296</span> }<a name="line.296"></a> |
| <span class="sourceLineNo">297</span><a name="line.297"></a> |
| <span class="sourceLineNo">298</span> private static void unregisterLoggerConfigs(final String contextName, final MBeanServer mbs) {<a name="line.298"></a> |
| <span class="sourceLineNo">299</span> final String pattern = LoggerConfigAdminMBean.PATTERN;<a name="line.299"></a> |
| <span class="sourceLineNo">300</span> final String search = String.format(pattern, escape(contextName), "*");<a name="line.300"></a> |
| <span class="sourceLineNo">301</span> unregisterAllMatching(search, mbs);<a name="line.301"></a> |
| <span class="sourceLineNo">302</span> }<a name="line.302"></a> |
| <span class="sourceLineNo">303</span><a name="line.303"></a> |
| <span class="sourceLineNo">304</span> private static void unregisterContexts(final MBeanServer mbs) {<a name="line.304"></a> |
| <span class="sourceLineNo">305</span> final String pattern = LoggerContextAdminMBean.PATTERN;<a name="line.305"></a> |
| <span class="sourceLineNo">306</span> final String search = String.format(pattern, "*");<a name="line.306"></a> |
| <span class="sourceLineNo">307</span> unregisterAllMatching(search, mbs);<a name="line.307"></a> |
| <span class="sourceLineNo">308</span> }<a name="line.308"></a> |
| <span class="sourceLineNo">309</span><a name="line.309"></a> |
| <span class="sourceLineNo">310</span> private static void unregisterAppenders(final String contextName, final MBeanServer mbs) {<a name="line.310"></a> |
| <span class="sourceLineNo">311</span> final String pattern = AppenderAdminMBean.PATTERN;<a name="line.311"></a> |
| <span class="sourceLineNo">312</span> final String search = String.format(pattern, escape(contextName), "*");<a name="line.312"></a> |
| <span class="sourceLineNo">313</span> unregisterAllMatching(search, mbs);<a name="line.313"></a> |
| <span class="sourceLineNo">314</span> }<a name="line.314"></a> |
| <span class="sourceLineNo">315</span><a name="line.315"></a> |
| <span class="sourceLineNo">316</span> private static void unregisterAsyncAppenders(final String contextName, final MBeanServer mbs) {<a name="line.316"></a> |
| <span class="sourceLineNo">317</span> final String pattern = AsyncAppenderAdminMBean.PATTERN;<a name="line.317"></a> |
| <span class="sourceLineNo">318</span> final String search = String.format(pattern, escape(contextName), "*");<a name="line.318"></a> |
| <span class="sourceLineNo">319</span> unregisterAllMatching(search, mbs);<a name="line.319"></a> |
| <span class="sourceLineNo">320</span> }<a name="line.320"></a> |
| <span class="sourceLineNo">321</span><a name="line.321"></a> |
| <span class="sourceLineNo">322</span> private static void unregisterAsyncLoggerRingBufferAdmins(final String contextName, final MBeanServer mbs) {<a name="line.322"></a> |
| <span class="sourceLineNo">323</span> final String pattern1 = RingBufferAdminMBean.PATTERN_ASYNC_LOGGER;<a name="line.323"></a> |
| <span class="sourceLineNo">324</span> final String search1 = String.format(pattern1, escape(contextName));<a name="line.324"></a> |
| <span class="sourceLineNo">325</span> unregisterAllMatching(search1, mbs);<a name="line.325"></a> |
| <span class="sourceLineNo">326</span> }<a name="line.326"></a> |
| <span class="sourceLineNo">327</span><a name="line.327"></a> |
| <span class="sourceLineNo">328</span> private static void unregisterAsyncLoggerConfigRingBufferAdmins(final String contextName, final MBeanServer mbs) {<a name="line.328"></a> |
| <span class="sourceLineNo">329</span> final String pattern2 = RingBufferAdminMBean.PATTERN_ASYNC_LOGGER_CONFIG;<a name="line.329"></a> |
| <span class="sourceLineNo">330</span> final String search2 = String.format(pattern2, escape(contextName), "*");<a name="line.330"></a> |
| <span class="sourceLineNo">331</span> unregisterAllMatching(search2, mbs);<a name="line.331"></a> |
| <span class="sourceLineNo">332</span> }<a name="line.332"></a> |
| <span class="sourceLineNo">333</span><a name="line.333"></a> |
| <span class="sourceLineNo">334</span> private static void unregisterAllMatching(final String search, final MBeanServer mbs) {<a name="line.334"></a> |
| <span class="sourceLineNo">335</span> try {<a name="line.335"></a> |
| <span class="sourceLineNo">336</span> final ObjectName pattern = new ObjectName(search);<a name="line.336"></a> |
| <span class="sourceLineNo">337</span> final Set<ObjectName> found = mbs.queryNames(pattern, null);<a name="line.337"></a> |
| <span class="sourceLineNo">338</span> if (found == null || found.isEmpty()) {<a name="line.338"></a> |
| <span class="sourceLineNo">339</span> LOGGER.trace("Unregistering but no MBeans found matching '{}'", search);<a name="line.339"></a> |
| <span class="sourceLineNo">340</span> } else {<a name="line.340"></a> |
| <span class="sourceLineNo">341</span> LOGGER.trace("Unregistering {} MBeans: {}", found.size(), found);<a name="line.341"></a> |
| <span class="sourceLineNo">342</span> }<a name="line.342"></a> |
| <span class="sourceLineNo">343</span> if (found != null) {<a name="line.343"></a> |
| <span class="sourceLineNo">344</span> for (final ObjectName objectName : found) {<a name="line.344"></a> |
| <span class="sourceLineNo">345</span> mbs.unregisterMBean(objectName);<a name="line.345"></a> |
| <span class="sourceLineNo">346</span> }<a name="line.346"></a> |
| <span class="sourceLineNo">347</span> }<a name="line.347"></a> |
| <span class="sourceLineNo">348</span> } catch (final InstanceNotFoundException ex) {<a name="line.348"></a> |
| <span class="sourceLineNo">349</span> LOGGER.debug("Could not unregister MBeans for " + search + ". Ignoring " + ex);<a name="line.349"></a> |
| <span class="sourceLineNo">350</span> } catch (final Exception ex) {<a name="line.350"></a> |
| <span class="sourceLineNo">351</span> LOGGER.error("Could not unregister MBeans for " + search, ex);<a name="line.351"></a> |
| <span class="sourceLineNo">352</span> }<a name="line.352"></a> |
| <span class="sourceLineNo">353</span> }<a name="line.353"></a> |
| <span class="sourceLineNo">354</span><a name="line.354"></a> |
| <span class="sourceLineNo">355</span> private static void registerLoggerConfigs(final LoggerContext ctx, final MBeanServer mbs, final Executor executor)<a name="line.355"></a> |
| <span class="sourceLineNo">356</span> throws InstanceAlreadyExistsException, MBeanRegistrationException, NotCompliantMBeanException {<a name="line.356"></a> |
| <span class="sourceLineNo">357</span><a name="line.357"></a> |
| <span class="sourceLineNo">358</span> final Map<String, LoggerConfig> map = ctx.getConfiguration().getLoggers();<a name="line.358"></a> |
| <span class="sourceLineNo">359</span> for (final String name : map.keySet()) {<a name="line.359"></a> |
| <span class="sourceLineNo">360</span> final LoggerConfig cfg = map.get(name);<a name="line.360"></a> |
| <span class="sourceLineNo">361</span> final LoggerConfigAdmin mbean = new LoggerConfigAdmin(ctx, cfg);<a name="line.361"></a> |
| <span class="sourceLineNo">362</span> register(mbs, mbean, mbean.getObjectName());<a name="line.362"></a> |
| <span class="sourceLineNo">363</span><a name="line.363"></a> |
| <span class="sourceLineNo">364</span> if (cfg instanceof AsyncLoggerConfig) {<a name="line.364"></a> |
| <span class="sourceLineNo">365</span> final AsyncLoggerConfig async = (AsyncLoggerConfig) cfg;<a name="line.365"></a> |
| <span class="sourceLineNo">366</span> final RingBufferAdmin rbmbean = async.createRingBufferAdmin(ctx.getName());<a name="line.366"></a> |
| <span class="sourceLineNo">367</span> register(mbs, rbmbean, rbmbean.getObjectName());<a name="line.367"></a> |
| <span class="sourceLineNo">368</span> }<a name="line.368"></a> |
| <span class="sourceLineNo">369</span> }<a name="line.369"></a> |
| <span class="sourceLineNo">370</span> }<a name="line.370"></a> |
| <span class="sourceLineNo">371</span><a name="line.371"></a> |
| <span class="sourceLineNo">372</span> private static void registerAppenders(final LoggerContext ctx, final MBeanServer mbs, final Executor executor)<a name="line.372"></a> |
| <span class="sourceLineNo">373</span> throws InstanceAlreadyExistsException, MBeanRegistrationException, NotCompliantMBeanException {<a name="line.373"></a> |
| <span class="sourceLineNo">374</span><a name="line.374"></a> |
| <span class="sourceLineNo">375</span> final Map<String, Appender> map = ctx.getConfiguration().getAppenders();<a name="line.375"></a> |
| <span class="sourceLineNo">376</span> for (final String name : map.keySet()) {<a name="line.376"></a> |
| <span class="sourceLineNo">377</span> final Appender appender = map.get(name);<a name="line.377"></a> |
| <span class="sourceLineNo">378</span><a name="line.378"></a> |
| <span class="sourceLineNo">379</span> if (appender instanceof AsyncAppender) {<a name="line.379"></a> |
| <span class="sourceLineNo">380</span> final AsyncAppender async = ((AsyncAppender) appender);<a name="line.380"></a> |
| <span class="sourceLineNo">381</span> final AsyncAppenderAdmin mbean = new AsyncAppenderAdmin(ctx.getName(), async);<a name="line.381"></a> |
| <span class="sourceLineNo">382</span> register(mbs, mbean, mbean.getObjectName());<a name="line.382"></a> |
| <span class="sourceLineNo">383</span> } else {<a name="line.383"></a> |
| <span class="sourceLineNo">384</span> final AppenderAdmin mbean = new AppenderAdmin(ctx.getName(), appender);<a name="line.384"></a> |
| <span class="sourceLineNo">385</span> register(mbs, mbean, mbean.getObjectName());<a name="line.385"></a> |
| <span class="sourceLineNo">386</span> }<a name="line.386"></a> |
| <span class="sourceLineNo">387</span> }<a name="line.387"></a> |
| <span class="sourceLineNo">388</span> }<a name="line.388"></a> |
| <span class="sourceLineNo">389</span><a name="line.389"></a> |
| <span class="sourceLineNo">390</span> private static void register(final MBeanServer mbs, final Object mbean, final ObjectName objectName)<a name="line.390"></a> |
| <span class="sourceLineNo">391</span> throws InstanceAlreadyExistsException, MBeanRegistrationException, NotCompliantMBeanException {<a name="line.391"></a> |
| <span class="sourceLineNo">392</span> LOGGER.debug("Registering MBean {}", objectName);<a name="line.392"></a> |
| <span class="sourceLineNo">393</span> mbs.registerMBean(mbean, objectName);<a name="line.393"></a> |
| <span class="sourceLineNo">394</span> }<a name="line.394"></a> |
| <span class="sourceLineNo">395</span>}<a name="line.395"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
