Google Git
Sign in
apache / juneau-website / 3ec6a38af8eff23af4011afbc4a002edec02bd97 / . / content / site / apidocs-9.0.0 / src-html / org / apache / juneau / microservice / resources / LogParser.Entry.html
blob: 20e3592b8fc95843f1e78b134e12345156f33e65 [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="../../../../../../javadoc.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 contributor license agreements. See the NOTICE file *<a name="line.2"></a>
<span class="sourceLineNo">003</span>// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file *<a name="line.3"></a>
<span class="sourceLineNo">004</span>// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance *<a name="line.4"></a>
<span class="sourceLineNo">005</span>// * with the License. You may obtain a copy of the License at *<a name="line.5"></a>
<span class="sourceLineNo">006</span>// * *<a name="line.6"></a>
<span class="sourceLineNo">007</span>// * http://www.apache.org/licenses/LICENSE-2.0 *<a name="line.7"></a>
<span class="sourceLineNo">008</span>// * *<a name="line.8"></a>
<span class="sourceLineNo">009</span>// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an *<a name="line.9"></a>
<span class="sourceLineNo">010</span>// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *<a name="line.10"></a>
<span class="sourceLineNo">011</span>// * specific language governing permissions and limitations under the License. *<a name="line.11"></a>
<span class="sourceLineNo">012</span>// ***************************************************************************************************************************<a name="line.12"></a>
<span class="sourceLineNo">013</span>package org.apache.juneau.microservice.resources;<a name="line.13"></a>
<span class="sourceLineNo">014</span><a name="line.14"></a>
<span class="sourceLineNo">015</span>import java.io.*;<a name="line.15"></a>
<span class="sourceLineNo">016</span>import java.nio.charset.*;<a name="line.16"></a>
<span class="sourceLineNo">017</span>import java.text.*;<a name="line.17"></a>
<span class="sourceLineNo">018</span>import java.util.*;<a name="line.18"></a>
<span class="sourceLineNo">019</span>import java.util.regex.*;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>/**<a name="line.21"></a>
<span class="sourceLineNo">022</span> * Utility class for reading log files.<a name="line.22"></a>
<span class="sourceLineNo">023</span> *<a name="line.23"></a>
<span class="sourceLineNo">024</span> * &lt;p&gt;<a name="line.24"></a>
<span class="sourceLineNo">025</span> * Provides the capability of returning splices of log files based on dates and filtering based on thread and logger<a name="line.25"></a>
<span class="sourceLineNo">026</span> * names.<a name="line.26"></a>
<span class="sourceLineNo">027</span> */<a name="line.27"></a>
<span class="sourceLineNo">028</span>public final class LogParser implements Iterable&lt;LogParser.Entry&gt;, Iterator&lt;LogParser.Entry&gt;, Closeable {<a name="line.28"></a>
<span class="sourceLineNo">029</span> private BufferedReader br;<a name="line.29"></a>
<span class="sourceLineNo">030</span> LogEntryFormatter formatter;<a name="line.30"></a>
<span class="sourceLineNo">031</span> Date start, end;<a name="line.31"></a>
<span class="sourceLineNo">032</span> Set&lt;String&gt; loggerFilter, severityFilter;<a name="line.32"></a>
<span class="sourceLineNo">033</span> String threadFilter;<a name="line.33"></a>
<span class="sourceLineNo">034</span> private Entry next;<a name="line.34"></a>
<span class="sourceLineNo">035</span><a name="line.35"></a>
<span class="sourceLineNo">036</span> /**<a name="line.36"></a>
<span class="sourceLineNo">037</span> * Constructor.<a name="line.37"></a>
<span class="sourceLineNo">038</span> *<a name="line.38"></a>
<span class="sourceLineNo">039</span> * @param formatter The log entry formatter.<a name="line.39"></a>
<span class="sourceLineNo">040</span> * @param f The log file.<a name="line.40"></a>
<span class="sourceLineNo">041</span> * @param start Don't return rows before this date. If &lt;jk&gt;null&lt;/jk&gt;, start from the beginning of the file.<a name="line.41"></a>
<span class="sourceLineNo">042</span> * @param end Don't return rows after this date. If &lt;jk&gt;null&lt;/jk&gt;, go to the end of the file.<a name="line.42"></a>
<span class="sourceLineNo">043</span> * @param thread Only return log entries with this thread name.<a name="line.43"></a>
<span class="sourceLineNo">044</span> * @param loggers Only return log entries produced by these loggers (simple class names).<a name="line.44"></a>
<span class="sourceLineNo">045</span> * @param severity Only return log entries with the specified severity.<a name="line.45"></a>
<span class="sourceLineNo">046</span> * @throws IOException Thrown by underlying stream.<a name="line.46"></a>
<span class="sourceLineNo">047</span> */<a name="line.47"></a>
<span class="sourceLineNo">048</span> public LogParser(LogEntryFormatter formatter, File f, Date start, Date end, String thread, String[] loggers, String[] severity) throws IOException {<a name="line.48"></a>
<span class="sourceLineNo">049</span> br = new BufferedReader(new InputStreamReader(new FileInputStream(f), Charset.defaultCharset()));<a name="line.49"></a>
<span class="sourceLineNo">050</span> this.formatter = formatter;<a name="line.50"></a>
<span class="sourceLineNo">051</span> this.start = start;<a name="line.51"></a>
<span class="sourceLineNo">052</span> this.end = end;<a name="line.52"></a>
<span class="sourceLineNo">053</span> this.threadFilter = thread;<a name="line.53"></a>
<span class="sourceLineNo">054</span> if (loggers != null)<a name="line.54"></a>
<span class="sourceLineNo">055</span> this.loggerFilter = new LinkedHashSet&lt;&gt;(Arrays.asList(loggers));<a name="line.55"></a>
<span class="sourceLineNo">056</span> if (severity != null)<a name="line.56"></a>
<span class="sourceLineNo">057</span> this.severityFilter = new LinkedHashSet&lt;&gt;(Arrays.asList(severity));<a name="line.57"></a>
<span class="sourceLineNo">058</span><a name="line.58"></a>
<span class="sourceLineNo">059</span> // Find the first line.<a name="line.59"></a>
<span class="sourceLineNo">060</span> String line;<a name="line.60"></a>
<span class="sourceLineNo">061</span> while (next == null &amp;&amp; (line = br.readLine()) != null) {<a name="line.61"></a>
<span class="sourceLineNo">062</span> Entry e = new Entry(line);<a name="line.62"></a>
<span class="sourceLineNo">063</span> if (e.matches())<a name="line.63"></a>
<span class="sourceLineNo">064</span> next = e;<a name="line.64"></a>
<span class="sourceLineNo">065</span> }<a name="line.65"></a>
<span class="sourceLineNo">066</span> }<a name="line.66"></a>
<span class="sourceLineNo">067</span><a name="line.67"></a>
<span class="sourceLineNo">068</span> @Override /* Iterator */<a name="line.68"></a>
<span class="sourceLineNo">069</span> public boolean hasNext() {<a name="line.69"></a>
<span class="sourceLineNo">070</span> return next != null;<a name="line.70"></a>
<span class="sourceLineNo">071</span> }<a name="line.71"></a>
<span class="sourceLineNo">072</span><a name="line.72"></a>
<span class="sourceLineNo">073</span> @Override /* Iterator */<a name="line.73"></a>
<span class="sourceLineNo">074</span> public Entry next() {<a name="line.74"></a>
<span class="sourceLineNo">075</span> Entry current = next;<a name="line.75"></a>
<span class="sourceLineNo">076</span> Entry prev = next;<a name="line.76"></a>
<span class="sourceLineNo">077</span> try {<a name="line.77"></a>
<span class="sourceLineNo">078</span> next = null;<a name="line.78"></a>
<span class="sourceLineNo">079</span> String line = null;<a name="line.79"></a>
<span class="sourceLineNo">080</span> while (next == null &amp;&amp; (line = br.readLine()) != null) {<a name="line.80"></a>
<span class="sourceLineNo">081</span> Entry e = new Entry(line);<a name="line.81"></a>
<span class="sourceLineNo">082</span> if (e.isRecord) {<a name="line.82"></a>
<span class="sourceLineNo">083</span> if (e.matches())<a name="line.83"></a>
<span class="sourceLineNo">084</span> next = e;<a name="line.84"></a>
<span class="sourceLineNo">085</span> prev = null;<a name="line.85"></a>
<span class="sourceLineNo">086</span> } else {<a name="line.86"></a>
<span class="sourceLineNo">087</span> if (prev != null)<a name="line.87"></a>
<span class="sourceLineNo">088</span> prev.addText(e.line);<a name="line.88"></a>
<span class="sourceLineNo">089</span> }<a name="line.89"></a>
<span class="sourceLineNo">090</span> }<a name="line.90"></a>
<span class="sourceLineNo">091</span> } catch (IOException e) {<a name="line.91"></a>
<span class="sourceLineNo">092</span> throw new RuntimeException(e);<a name="line.92"></a>
<span class="sourceLineNo">093</span> }<a name="line.93"></a>
<span class="sourceLineNo">094</span> return current;<a name="line.94"></a>
<span class="sourceLineNo">095</span> }<a name="line.95"></a>
<span class="sourceLineNo">096</span><a name="line.96"></a>
<span class="sourceLineNo">097</span> @Override /* Iterator */<a name="line.97"></a>
<span class="sourceLineNo">098</span> public void remove() {<a name="line.98"></a>
<span class="sourceLineNo">099</span> throw new NoSuchMethodError();<a name="line.99"></a>
<span class="sourceLineNo">100</span> }<a name="line.100"></a>
<span class="sourceLineNo">101</span><a name="line.101"></a>
<span class="sourceLineNo">102</span> @Override /* Iterable */<a name="line.102"></a>
<span class="sourceLineNo">103</span> public Iterator&lt;Entry&gt; iterator() {<a name="line.103"></a>
<span class="sourceLineNo">104</span> return this;<a name="line.104"></a>
<span class="sourceLineNo">105</span> }<a name="line.105"></a>
<span class="sourceLineNo">106</span><a name="line.106"></a>
<span class="sourceLineNo">107</span> @Override /* Closeable */<a name="line.107"></a>
<span class="sourceLineNo">108</span> public void close() throws IOException {<a name="line.108"></a>
<span class="sourceLineNo">109</span> br.close();<a name="line.109"></a>
<span class="sourceLineNo">110</span> }<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> * Serializes the contents of the parsed log file to the specified writer and then closes the underlying reader.<a name="line.113"></a>
<span class="sourceLineNo">114</span> *<a name="line.114"></a>
<span class="sourceLineNo">115</span> * @param w The writer to write the log file to.<a name="line.115"></a>
<span class="sourceLineNo">116</span> * @throws IOException Thrown by underlying stream.<a name="line.116"></a>
<span class="sourceLineNo">117</span> */<a name="line.117"></a>
<span class="sourceLineNo">118</span> public void writeTo(Writer w) throws IOException {<a name="line.118"></a>
<span class="sourceLineNo">119</span> try {<a name="line.119"></a>
<span class="sourceLineNo">120</span> if (! hasNext())<a name="line.120"></a>
<span class="sourceLineNo">121</span> w.append("[EMPTY]");<a name="line.121"></a>
<span class="sourceLineNo">122</span> else for (LogParser.Entry le : this)<a name="line.122"></a>
<span class="sourceLineNo">123</span> le.append(w);<a name="line.123"></a>
<span class="sourceLineNo">124</span> } finally {<a name="line.124"></a>
<span class="sourceLineNo">125</span> close();<a name="line.125"></a>
<span class="sourceLineNo">126</span> }<a name="line.126"></a>
<span class="sourceLineNo">127</span> }<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> * Represents a single line from the log file.<a name="line.130"></a>
<span class="sourceLineNo">131</span> */<a name="line.131"></a>
<span class="sourceLineNo">132</span> @SuppressWarnings("javadoc")<a name="line.132"></a>
<span class="sourceLineNo">133</span> public final class Entry {<a name="line.133"></a>
<span class="sourceLineNo">134</span> public Date date;<a name="line.134"></a>
<span class="sourceLineNo">135</span> public String severity, logger;<a name="line.135"></a>
<span class="sourceLineNo">136</span> protected String line, text;<a name="line.136"></a>
<span class="sourceLineNo">137</span> protected String thread;<a name="line.137"></a>
<span class="sourceLineNo">138</span> protected List&lt;String&gt; additionalText;<a name="line.138"></a>
<span class="sourceLineNo">139</span> protected boolean isRecord;<a name="line.139"></a>
<span class="sourceLineNo">140</span><a name="line.140"></a>
<span class="sourceLineNo">141</span> Entry(String line) throws IOException {<a name="line.141"></a>
<span class="sourceLineNo">142</span> try {<a name="line.142"></a>
<span class="sourceLineNo">143</span> this.line = line;<a name="line.143"></a>
<span class="sourceLineNo">144</span> Matcher m = formatter.getLogEntryPattern().matcher(line);<a name="line.144"></a>
<span class="sourceLineNo">145</span> if (m.matches()) {<a name="line.145"></a>
<span class="sourceLineNo">146</span> isRecord = true;<a name="line.146"></a>
<span class="sourceLineNo">147</span> String s = formatter.getField("date", m);<a name="line.147"></a>
<span class="sourceLineNo">148</span> if (s != null)<a name="line.148"></a>
<span class="sourceLineNo">149</span> date = formatter.getDateFormat().parse(s);<a name="line.149"></a>
<span class="sourceLineNo">150</span> thread = formatter.getField("thread", m);<a name="line.150"></a>
<span class="sourceLineNo">151</span> severity = formatter.getField("level", m);<a name="line.151"></a>
<span class="sourceLineNo">152</span> logger = formatter.getField("logger", m);<a name="line.152"></a>
<span class="sourceLineNo">153</span> text = formatter.getField("msg", m);<a name="line.153"></a>
<span class="sourceLineNo">154</span> if (logger != null &amp;&amp; logger.indexOf('.') &gt; -1)<a name="line.154"></a>
<span class="sourceLineNo">155</span> logger = logger.substring(logger.lastIndexOf('.')+1);<a name="line.155"></a>
<span class="sourceLineNo">156</span> }<a name="line.156"></a>
<span class="sourceLineNo">157</span> } catch (ParseException e) {<a name="line.157"></a>
<span class="sourceLineNo">158</span> throw new IOException(e);<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><a name="line.161"></a>
<span class="sourceLineNo">162</span> void addText(String t) {<a name="line.162"></a>
<span class="sourceLineNo">163</span> if (additionalText == null)<a name="line.163"></a>
<span class="sourceLineNo">164</span> additionalText = new LinkedList&lt;&gt;();<a name="line.164"></a>
<span class="sourceLineNo">165</span> additionalText.add(t);<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> public String getText() {<a name="line.168"></a>
<span class="sourceLineNo">169</span> if (additionalText == null)<a name="line.169"></a>
<span class="sourceLineNo">170</span> return text;<a name="line.170"></a>
<span class="sourceLineNo">171</span> int i = text.length();<a name="line.171"></a>
<span class="sourceLineNo">172</span> for (String s : additionalText)<a name="line.172"></a>
<span class="sourceLineNo">173</span> i += s.length() + 1;<a name="line.173"></a>
<span class="sourceLineNo">174</span> StringBuilder sb = new StringBuilder(i);<a name="line.174"></a>
<span class="sourceLineNo">175</span> sb.append(text);<a name="line.175"></a>
<span class="sourceLineNo">176</span> for (String s : additionalText)<a name="line.176"></a>
<span class="sourceLineNo">177</span> sb.append('\n').append(s);<a name="line.177"></a>
<span class="sourceLineNo">178</span> return sb.toString();<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> public String getThread() {<a name="line.181"></a>
<span class="sourceLineNo">182</span> return thread;<a name="line.182"></a>
<span class="sourceLineNo">183</span> }<a name="line.183"></a>
<span class="sourceLineNo">184</span><a name="line.184"></a>
<span class="sourceLineNo">185</span> public Writer appendHtml(Writer w) throws IOException {<a name="line.185"></a>
<span class="sourceLineNo">186</span> w.append(toHtml(line)).append("&lt;br&gt;");<a name="line.186"></a>
<span class="sourceLineNo">187</span> if (additionalText != null)<a name="line.187"></a>
<span class="sourceLineNo">188</span> for (String t : additionalText)<a name="line.188"></a>
<span class="sourceLineNo">189</span> w.append(toHtml(t)).append("&lt;br&gt;");<a name="line.189"></a>
<span class="sourceLineNo">190</span> return w;<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> protected Writer append(Writer w) throws IOException {<a name="line.193"></a>
<span class="sourceLineNo">194</span> w.append(line).append('\n');<a name="line.194"></a>
<span class="sourceLineNo">195</span> if (additionalText != null)<a name="line.195"></a>
<span class="sourceLineNo">196</span> for (String t : additionalText)<a name="line.196"></a>
<span class="sourceLineNo">197</span> w.append(t).append('\n');<a name="line.197"></a>
<span class="sourceLineNo">198</span> return w;<a name="line.198"></a>
<span class="sourceLineNo">199</span> }<a name="line.199"></a>
<span class="sourceLineNo">200</span><a name="line.200"></a>
<span class="sourceLineNo">201</span> boolean matches() {<a name="line.201"></a>
<span class="sourceLineNo">202</span> if (! isRecord)<a name="line.202"></a>
<span class="sourceLineNo">203</span> return false;<a name="line.203"></a>
<span class="sourceLineNo">204</span> if (start != null &amp;&amp; date.before(start))<a name="line.204"></a>
<span class="sourceLineNo">205</span> return false;<a name="line.205"></a>
<span class="sourceLineNo">206</span> if (end != null &amp;&amp; date.after(end))<a name="line.206"></a>
<span class="sourceLineNo">207</span> return false;<a name="line.207"></a>
<span class="sourceLineNo">208</span> if (threadFilter != null &amp;&amp; ! threadFilter.equals(thread))<a name="line.208"></a>
<span class="sourceLineNo">209</span> return false;<a name="line.209"></a>
<span class="sourceLineNo">210</span> if (loggerFilter != null &amp;&amp; ! loggerFilter.contains(logger))<a name="line.210"></a>
<span class="sourceLineNo">211</span> return false;<a name="line.211"></a>
<span class="sourceLineNo">212</span> if (severityFilter != null &amp;&amp; ! severityFilter.contains(severity))<a name="line.212"></a>
<span class="sourceLineNo">213</span> return false;<a name="line.213"></a>
<span class="sourceLineNo">214</span> return true;<a name="line.214"></a>
<span class="sourceLineNo">215</span> }<a name="line.215"></a>
<span class="sourceLineNo">216</span> }<a name="line.216"></a>
<span class="sourceLineNo">217</span><a name="line.217"></a>
<span class="sourceLineNo">218</span> static final String toHtml(String s) {<a name="line.218"></a>
<span class="sourceLineNo">219</span> if (s.indexOf('&lt;') != -1)<a name="line.219"></a>
<span class="sourceLineNo">220</span> return s.replaceAll("&lt;", "&amp;lt;");//$NON-NLS-2$<a name="line.220"></a>
<span class="sourceLineNo">221</span> return s;<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><a name="line.224"></a>
</pre>
</div>
</body>
</html>