Google Git
Sign in
apache / logging-log4j-site / 9755b12b39efbc0142688f9b1a11ec68db89f97b / . / 2.13.0 / log4j-api / apidocs / src-html / org / apache / logging / log4j / message / ThreadDumpMessage.html
blob: b4a3869ce705201fb3461aa5c7c5395286e79cc9 [file] [log] [blame]
<!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.message;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import java.io.InvalidObjectException;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.io.ObjectInputStream;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.io.Serializable;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.HashMap;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.Iterator;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.Map;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.util.ServiceConfigurationError;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.util.ServiceLoader;<a name="line.26"></a>
<span class="sourceLineNo">027</span><a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.logging.log4j.status.StatusLogger;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.logging.log4j.util.StringBuilderFormattable;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.logging.log4j.util.Strings;<a name="line.30"></a>
<span class="sourceLineNo">031</span><a name="line.31"></a>
<span class="sourceLineNo">032</span>/**<a name="line.32"></a>
<span class="sourceLineNo">033</span> * Captures information about all running Threads.<a name="line.33"></a>
<span class="sourceLineNo">034</span> */<a name="line.34"></a>
<span class="sourceLineNo">035</span>@AsynchronouslyFormattable<a name="line.35"></a>
<span class="sourceLineNo">036</span>public class ThreadDumpMessage implements Message, StringBuilderFormattable {<a name="line.36"></a>
<span class="sourceLineNo">037</span> private static final long serialVersionUID = -1103400781608841088L;<a name="line.37"></a>
<span class="sourceLineNo">038</span> private static ThreadInfoFactory FACTORY;<a name="line.38"></a>
<span class="sourceLineNo">039</span><a name="line.39"></a>
<span class="sourceLineNo">040</span> private volatile Map&lt;ThreadInformation, StackTraceElement[]&gt; threads;<a name="line.40"></a>
<span class="sourceLineNo">041</span> private final String title;<a name="line.41"></a>
<span class="sourceLineNo">042</span> private String formattedMessage;<a name="line.42"></a>
<span class="sourceLineNo">043</span><a name="line.43"></a>
<span class="sourceLineNo">044</span> /**<a name="line.44"></a>
<span class="sourceLineNo">045</span> * Generate a ThreadDumpMessage with a title.<a name="line.45"></a>
<span class="sourceLineNo">046</span> * @param title The title.<a name="line.46"></a>
<span class="sourceLineNo">047</span> */<a name="line.47"></a>
<span class="sourceLineNo">048</span> public ThreadDumpMessage(final String title) {<a name="line.48"></a>
<span class="sourceLineNo">049</span> this.title = title == null ? Strings.EMPTY : title;<a name="line.49"></a>
<span class="sourceLineNo">050</span> threads = getFactory().createThreadInfo();<a name="line.50"></a>
<span class="sourceLineNo">051</span> }<a name="line.51"></a>
<span class="sourceLineNo">052</span><a name="line.52"></a>
<span class="sourceLineNo">053</span> private ThreadDumpMessage(final String formattedMsg, final String title) {<a name="line.53"></a>
<span class="sourceLineNo">054</span> this.formattedMessage = formattedMsg;<a name="line.54"></a>
<span class="sourceLineNo">055</span> this.title = title == null ? Strings.EMPTY : title;<a name="line.55"></a>
<span class="sourceLineNo">056</span> }<a name="line.56"></a>
<span class="sourceLineNo">057</span><a name="line.57"></a>
<span class="sourceLineNo">058</span> private static ThreadInfoFactory getFactory() {<a name="line.58"></a>
<span class="sourceLineNo">059</span> if (FACTORY == null) {<a name="line.59"></a>
<span class="sourceLineNo">060</span> FACTORY = initFactory(ThreadDumpMessage.class.getClassLoader());<a name="line.60"></a>
<span class="sourceLineNo">061</span> }<a name="line.61"></a>
<span class="sourceLineNo">062</span> return FACTORY;<a name="line.62"></a>
<span class="sourceLineNo">063</span> }<a name="line.63"></a>
<span class="sourceLineNo">064</span><a name="line.64"></a>
<span class="sourceLineNo">065</span> private static ThreadInfoFactory initFactory(final ClassLoader classLoader) {<a name="line.65"></a>
<span class="sourceLineNo">066</span> final ServiceLoader&lt;ThreadInfoFactory&gt; serviceLoader = ServiceLoader.load(ThreadInfoFactory.class, classLoader);<a name="line.66"></a>
<span class="sourceLineNo">067</span> ThreadInfoFactory result = null;<a name="line.67"></a>
<span class="sourceLineNo">068</span> try {<a name="line.68"></a>
<span class="sourceLineNo">069</span> final Iterator&lt;ThreadInfoFactory&gt; iterator = serviceLoader.iterator();<a name="line.69"></a>
<span class="sourceLineNo">070</span> while (result == null &amp;&amp; iterator.hasNext()) {<a name="line.70"></a>
<span class="sourceLineNo">071</span> result = iterator.next();<a name="line.71"></a>
<span class="sourceLineNo">072</span> }<a name="line.72"></a>
<span class="sourceLineNo">073</span> } catch (ServiceConfigurationError | LinkageError | Exception unavailable) { // if java management classes not available<a name="line.73"></a>
<span class="sourceLineNo">074</span> StatusLogger.getLogger().info("ThreadDumpMessage uses BasicThreadInfoFactory: " +<a name="line.74"></a>
<span class="sourceLineNo">075</span> "could not load extended ThreadInfoFactory: {}", unavailable.toString());<a name="line.75"></a>
<span class="sourceLineNo">076</span> result = null;<a name="line.76"></a>
<span class="sourceLineNo">077</span> }<a name="line.77"></a>
<span class="sourceLineNo">078</span> return result == null ? new BasicThreadInfoFactory() : result;<a name="line.78"></a>
<span class="sourceLineNo">079</span> }<a name="line.79"></a>
<span class="sourceLineNo">080</span><a name="line.80"></a>
<span class="sourceLineNo">081</span> @Override<a name="line.81"></a>
<span class="sourceLineNo">082</span> public String toString() {<a name="line.82"></a>
<span class="sourceLineNo">083</span> return getFormattedMessage();<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> /**<a name="line.86"></a>
<span class="sourceLineNo">087</span> * Returns the ThreadDump in printable format.<a name="line.87"></a>
<span class="sourceLineNo">088</span> * @return the ThreadDump suitable for logging.<a name="line.88"></a>
<span class="sourceLineNo">089</span> */<a name="line.89"></a>
<span class="sourceLineNo">090</span> @Override<a name="line.90"></a>
<span class="sourceLineNo">091</span> public String getFormattedMessage() {<a name="line.91"></a>
<span class="sourceLineNo">092</span> if (formattedMessage != null) {<a name="line.92"></a>
<span class="sourceLineNo">093</span> return formattedMessage;<a name="line.93"></a>
<span class="sourceLineNo">094</span> }<a name="line.94"></a>
<span class="sourceLineNo">095</span> final StringBuilder sb = new StringBuilder(255);<a name="line.95"></a>
<span class="sourceLineNo">096</span> formatTo(sb);<a name="line.96"></a>
<span class="sourceLineNo">097</span> return sb.toString();<a name="line.97"></a>
<span class="sourceLineNo">098</span> }<a name="line.98"></a>
<span class="sourceLineNo">099</span><a name="line.99"></a>
<span class="sourceLineNo">100</span> @Override<a name="line.100"></a>
<span class="sourceLineNo">101</span> public void formatTo(final StringBuilder sb) {<a name="line.101"></a>
<span class="sourceLineNo">102</span> sb.append(title);<a name="line.102"></a>
<span class="sourceLineNo">103</span> if (title.length() &gt; 0) {<a name="line.103"></a>
<span class="sourceLineNo">104</span> sb.append('\n');<a name="line.104"></a>
<span class="sourceLineNo">105</span> }<a name="line.105"></a>
<span class="sourceLineNo">106</span> for (final Map.Entry&lt;ThreadInformation, StackTraceElement[]&gt; entry : threads.entrySet()) {<a name="line.106"></a>
<span class="sourceLineNo">107</span> final ThreadInformation info = entry.getKey();<a name="line.107"></a>
<span class="sourceLineNo">108</span> info.printThreadInfo(sb);<a name="line.108"></a>
<span class="sourceLineNo">109</span> info.printStack(sb, entry.getValue());<a name="line.109"></a>
<span class="sourceLineNo">110</span> sb.append('\n');<a name="line.110"></a>
<span class="sourceLineNo">111</span> }<a name="line.111"></a>
<span class="sourceLineNo">112</span> }<a name="line.112"></a>
<span class="sourceLineNo">113</span><a name="line.113"></a>
<span class="sourceLineNo">114</span> /**<a name="line.114"></a>
<span class="sourceLineNo">115</span> * Returns the title.<a name="line.115"></a>
<span class="sourceLineNo">116</span> * @return the title.<a name="line.116"></a>
<span class="sourceLineNo">117</span> */<a name="line.117"></a>
<span class="sourceLineNo">118</span> @Override<a name="line.118"></a>
<span class="sourceLineNo">119</span> public String getFormat() {<a name="line.119"></a>
<span class="sourceLineNo">120</span> return title == null ? Strings.EMPTY : title;<a name="line.120"></a>
<span class="sourceLineNo">121</span> }<a name="line.121"></a>
<span class="sourceLineNo">122</span><a name="line.122"></a>
<span class="sourceLineNo">123</span> /**<a name="line.123"></a>
<span class="sourceLineNo">124</span> * Returns an array with a single element, a Map containing the ThreadInformation as the key.<a name="line.124"></a>
<span class="sourceLineNo">125</span> * and the StackTraceElement array as the value;<a name="line.125"></a>
<span class="sourceLineNo">126</span> * @return the "parameters" to this Message.<a name="line.126"></a>
<span class="sourceLineNo">127</span> */<a name="line.127"></a>
<span class="sourceLineNo">128</span> @Override<a name="line.128"></a>
<span class="sourceLineNo">129</span> public Object[] getParameters() {<a name="line.129"></a>
<span class="sourceLineNo">130</span> return null;<a name="line.130"></a>
<span class="sourceLineNo">131</span> }<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> * Creates a ThreadDumpMessageProxy that can be serialized.<a name="line.134"></a>
<span class="sourceLineNo">135</span> * @return a ThreadDumpMessageProxy.<a name="line.135"></a>
<span class="sourceLineNo">136</span> */<a name="line.136"></a>
<span class="sourceLineNo">137</span> protected Object writeReplace() {<a name="line.137"></a>
<span class="sourceLineNo">138</span> return new ThreadDumpMessageProxy(this);<a name="line.138"></a>
<span class="sourceLineNo">139</span> }<a name="line.139"></a>
<span class="sourceLineNo">140</span><a name="line.140"></a>
<span class="sourceLineNo">141</span> private void readObject(final ObjectInputStream stream)<a name="line.141"></a>
<span class="sourceLineNo">142</span> throws InvalidObjectException {<a name="line.142"></a>
<span class="sourceLineNo">143</span> throw new InvalidObjectException("Proxy required");<a name="line.143"></a>
<span class="sourceLineNo">144</span> }<a name="line.144"></a>
<span class="sourceLineNo">145</span><a name="line.145"></a>
<span class="sourceLineNo">146</span> /**<a name="line.146"></a>
<span class="sourceLineNo">147</span> * Proxy pattern used to serialize the ThreadDumpMessage.<a name="line.147"></a>
<span class="sourceLineNo">148</span> */<a name="line.148"></a>
<span class="sourceLineNo">149</span> private static class ThreadDumpMessageProxy implements Serializable {<a name="line.149"></a>
<span class="sourceLineNo">150</span><a name="line.150"></a>
<span class="sourceLineNo">151</span> private static final long serialVersionUID = -3476620450287648269L;<a name="line.151"></a>
<span class="sourceLineNo">152</span> private final String formattedMsg;<a name="line.152"></a>
<span class="sourceLineNo">153</span> private final String title;<a name="line.153"></a>
<span class="sourceLineNo">154</span><a name="line.154"></a>
<span class="sourceLineNo">155</span> ThreadDumpMessageProxy(final ThreadDumpMessage msg) {<a name="line.155"></a>
<span class="sourceLineNo">156</span> this.formattedMsg = msg.getFormattedMessage();<a name="line.156"></a>
<span class="sourceLineNo">157</span> this.title = msg.title;<a name="line.157"></a>
<span class="sourceLineNo">158</span> }<a name="line.158"></a>
<span class="sourceLineNo">159</span><a name="line.159"></a>
<span class="sourceLineNo">160</span> /**<a name="line.160"></a>
<span class="sourceLineNo">161</span> * Returns a ThreadDumpMessage using the data in the proxy.<a name="line.161"></a>
<span class="sourceLineNo">162</span> * @return a ThreadDumpMessage.<a name="line.162"></a>
<span class="sourceLineNo">163</span> */<a name="line.163"></a>
<span class="sourceLineNo">164</span> protected Object readResolve() {<a name="line.164"></a>
<span class="sourceLineNo">165</span> return new ThreadDumpMessage(formattedMsg, title);<a name="line.165"></a>
<span class="sourceLineNo">166</span> }<a name="line.166"></a>
<span class="sourceLineNo">167</span> }<a name="line.167"></a>
<span class="sourceLineNo">168</span><a name="line.168"></a>
<span class="sourceLineNo">169</span> /**<a name="line.169"></a>
<span class="sourceLineNo">170</span> * Factory to create Thread information.<a name="line.170"></a>
<span class="sourceLineNo">171</span> * &lt;p&gt;<a name="line.171"></a>
<span class="sourceLineNo">172</span> * Implementations of this class are loaded via the standard java Service Provider interface.<a name="line.172"></a>
<span class="sourceLineNo">173</span> * &lt;/p&gt;<a name="line.173"></a>
<span class="sourceLineNo">174</span> * @see /log4j-core/src/main/resources/META-INF/services/org.apache.logging.log4j.message.ThreadDumpMessage$ThreadInfoFactory<a name="line.174"></a>
<span class="sourceLineNo">175</span> */<a name="line.175"></a>
<span class="sourceLineNo">176</span> public static interface ThreadInfoFactory {<a name="line.176"></a>
<span class="sourceLineNo">177</span> Map&lt;ThreadInformation, StackTraceElement[]&gt; createThreadInfo();<a name="line.177"></a>
<span class="sourceLineNo">178</span> }<a name="line.178"></a>
<span class="sourceLineNo">179</span><a name="line.179"></a>
<span class="sourceLineNo">180</span> /**<a name="line.180"></a>
<span class="sourceLineNo">181</span> * Factory to create basic thread information.<a name="line.181"></a>
<span class="sourceLineNo">182</span> */<a name="line.182"></a>
<span class="sourceLineNo">183</span> private static class BasicThreadInfoFactory implements ThreadInfoFactory {<a name="line.183"></a>
<span class="sourceLineNo">184</span> @Override<a name="line.184"></a>
<span class="sourceLineNo">185</span> public Map&lt;ThreadInformation, StackTraceElement[]&gt; createThreadInfo() {<a name="line.185"></a>
<span class="sourceLineNo">186</span> final Map&lt;Thread, StackTraceElement[]&gt; map = Thread.getAllStackTraces();<a name="line.186"></a>
<span class="sourceLineNo">187</span> final Map&lt;ThreadInformation, StackTraceElement[]&gt; threads =<a name="line.187"></a>
<span class="sourceLineNo">188</span> new HashMap&lt;&gt;(map.size());<a name="line.188"></a>
<span class="sourceLineNo">189</span> for (final Map.Entry&lt;Thread, StackTraceElement[]&gt; entry : map.entrySet()) {<a name="line.189"></a>
<span class="sourceLineNo">190</span> threads.put(new BasicThreadInformation(entry.getKey()), entry.getValue());<a name="line.190"></a>
<span class="sourceLineNo">191</span> }<a name="line.191"></a>
<span class="sourceLineNo">192</span> return threads;<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><a name="line.195"></a>
<span class="sourceLineNo">196</span> /**<a name="line.196"></a>
<span class="sourceLineNo">197</span> * Always returns null.<a name="line.197"></a>
<span class="sourceLineNo">198</span> *<a name="line.198"></a>
<span class="sourceLineNo">199</span> * @return null<a name="line.199"></a>
<span class="sourceLineNo">200</span> */<a name="line.200"></a>
<span class="sourceLineNo">201</span> @Override<a name="line.201"></a>
<span class="sourceLineNo">202</span> public Throwable getThrowable() {<a name="line.202"></a>
<span class="sourceLineNo">203</span> return null;<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>
</pre>
</div>
</body>
</html>