📄 abstracttracker.html
字号:
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"><head><meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>AbstractTracker xref</title><link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" /></head><body><pre><a name="1" href="#1">1</a> <em class="comment">/*<em class="comment"> Copyright (C) 2003 Internet Archive.</em></em><a name="2" href="#2">2</a> <em class="comment"> *</em><a name="3" href="#3">3</a> <em class="comment"> * This file is part of the Heritrix web crawler (crawler.archive.org).</em><a name="4" href="#4">4</a> <em class="comment"> *</em><a name="5" href="#5">5</a> <em class="comment"> * Heritrix is free software; you can redistribute it and/or modify</em><a name="6" href="#6">6</a> <em class="comment"> * it under the terms of the GNU Lesser Public License as published by</em><a name="7" href="#7">7</a> <em class="comment"> * the Free Software Foundation; either version 2.1 of the License, or</em><a name="8" href="#8">8</a> <em class="comment"> * any later version.</em><a name="9" href="#9">9</a> <em class="comment"> *</em><a name="10" href="#10">10</a> <em class="comment"> * Heritrix is distributed in the hope that it will be useful,</em><a name="11" href="#11">11</a> <em class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</em><a name="12" href="#12">12</a> <em class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</em><a name="13" href="#13">13</a> <em class="comment"> * GNU Lesser Public License for more details.</em><a name="14" href="#14">14</a> <em class="comment"> *</em><a name="15" href="#15">15</a> <em class="comment"> * You should have received a copy of the GNU Lesser Public License</em><a name="16" href="#16">16</a> <em class="comment"> * along with Heritrix; if not, write to the Free Software</em><a name="17" href="#17">17</a> <em class="comment"> * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</em><a name="18" href="#18">18</a> <em class="comment"> */</em><a name="19" href="#19">19</a> <strong>package</strong> <a href="../../../../org/archive/crawler/framework/package-summary.html">org.archive.crawler.framework</a>;<a name="20" href="#20">20</a> <a name="21" href="#21">21</a> <strong>import</strong> java.io.Serializable;<a name="22" href="#22">22</a> <strong>import</strong> java.util.Date;<a name="23" href="#23">23</a> <strong>import</strong> java.util.EventObject;<a name="24" href="#24">24</a> <strong>import</strong> java.util.logging.Level;<a name="25" href="#25">25</a> <a name="26" href="#26">26</a> <strong>import</strong> javax.management.AttributeNotFoundException;<a name="27" href="#27">27</a> <a name="28" href="#28">28</a> <strong>import</strong> org.archive.crawler.event.CrawlStatusListener;<a name="29" href="#29">29</a> <strong>import</strong> org.archive.crawler.framework.exceptions.FatalConfigurationException;<a name="30" href="#30">30</a> <strong>import</strong> org.archive.crawler.settings.ModuleType;<a name="31" href="#31">31</a> <strong>import</strong> org.archive.crawler.settings.SimpleType;<a name="32" href="#32">32</a> <strong>import</strong> org.archive.crawler.settings.Type;<a name="33" href="#33">33</a> <strong>import</strong> org.archive.util.ArchiveUtils;<a name="34" href="#34">34</a> <strong>import</strong> org.archive.util.PaddingStringBuffer;<a name="35" href="#35">35</a> <a name="36" href="#36">36</a> <em>/**<em>*</em></em><a name="37" href="#37">37</a> <em> * A partial implementation of the StatisticsTracking interface.</em><a name="38" href="#38">38</a> <em> * <p></em><a name="39" href="#39">39</a> <em> * It covers the thread handling. (Launching, pausing etc.) Included in this is</em><a name="40" href="#40">40</a> <em> * keeping track of the total time spent (actually) crawling. Several methods</em><a name="41" href="#41">41</a> <em> * to access the time started, finished etc. are provided.</em><a name="42" href="#42">42</a> <em> * <p></em><a name="43" href="#43">43</a> <em> * To handle the thread work the class implements the CrawlStatusListener and</em><a name="44" href="#44">44</a> <em> * uses it's events to pause, resume and stop logging of statistics. The run()</em><a name="45" href="#45">45</a> <em> * method will call logActivity() at intervals specified in the crawl order.</em><a name="46" href="#46">46</a> <em> * <p></em><a name="47" href="#47">47</a> <em> * Implementation of logActivity (the actual logging) as well as listening for</em><a name="48" href="#48">48</a> <em> * CrawlURIDisposition events is not addressed.</em><a name="49" href="#49">49</a> <em> *</em><a name="50" href="#50">50</a> <em> * @author Kristinn Sigurdsson</em><a name="51" href="#51">51</a> <em> *</em><a name="52" href="#52">52</a> <em> * @see org.archive.crawler.framework.StatisticsTracking</em><a name="53" href="#53">53</a> <em> * @see org.archive.crawler.admin.StatisticsTracker</em><a name="54" href="#54">54</a> <em> */</em><a name="55" href="#55">55</a> <strong>public</strong> <strong>abstract</strong> <strong>class</strong> <a href="../../../../org/archive/crawler/framework/AbstractTracker.html">AbstractTracker</a> <strong>extends</strong> <a href="../../../../org/archive/crawler/settings/ModuleType.html">ModuleType</a><a name="56" href="#56">56</a> implements StatisticsTracking, CrawlStatusListener, Serializable {<a name="57" href="#57">57</a> <em>/**<em>* Default period between logging stat values */</em></em><a name="58" href="#58">58</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> Integer DEFAULT_STATISTICS_REPORT_INTERVAL =<a name="59" href="#59">59</a> <strong>new</strong> Integer(20);<a name="60" href="#60">60</a> <em>/**<em>* Attribute name for logging interval in seconds setting</em></em><a name="61" href="#61">61</a> <em> */</em><a name="62" href="#62">62</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String ATTR_STATS_INTERVAL = <span class="string">"interval-seconds"</span>;<a name="63" href="#63">63</a> <a name="64" href="#64">64</a> <em>/**<em>* A reference to the CrawlContoller of the crawl that we are to track</em></em><a name="65" href="#65">65</a> <em> * statistics for.</em><a name="66" href="#66">66</a> <em> */</em><a name="67" href="#67">67</a> <strong>protected</strong> <strong>transient</strong> <a href="../../../../org/archive/crawler/framework/CrawlController.html">CrawlController</a> controller;<a name="68" href="#68">68</a> <a name="69" href="#69">69</a> <em class="comment">// Keep track of time.</em><a name="70" href="#70">70</a> <strong>protected</strong> <strong>long</strong> crawlerStartTime;<a name="71" href="#71">71</a> <strong>protected</strong> <strong>long</strong> crawlerEndTime = -1; <em class="comment">// Until crawl ends, this value is -1.</em><a name="72" href="#72">72</a> <strong>protected</strong> <strong>long</strong> crawlerPauseStarted = 0;<a name="73" href="#73">73</a> <strong>protected</strong> <strong>long</strong> crawlerTotalPausedTime = 0;<a name="74" href="#74">74</a> <a name="75" href="#75">75</a> <em>/**<em>* Timestamp of when this logger last wrote something to the log */</em></em><a name="76" href="#76">76</a> <strong>protected</strong> <strong>long</strong> lastLogPointTime;<a name="77" href="#77">77</a> <a name="78" href="#78">78</a> <strong>protected</strong> <strong>boolean</strong> shouldrun = <strong>true</strong>;<a name="79" href="#79">79</a> <a name="80" href="#80">80</a> <em>/**<em>*</em></em><a name="81" href="#81">81</a> <em> * @param name</em><a name="82" href="#82">82</a> <em> * @param description</em><a name="83" href="#83">83</a> <em> */</em><a name="84" href="#84">84</a> <strong>public</strong> <a href="../../../../org/archive/crawler/framework/AbstractTracker.html">AbstractTracker</a>(String name, String description) {<a name="85" href="#85">85</a> <strong>super</strong>(name, description);<a name="86" href="#86">86</a> <a href="../../../../org/archive/crawler/settings/Type.html">Type</a> e = addElementToDefinition(<strong>new</strong> <a href="../../../../org/archive/crawler/settings/SimpleType.html">SimpleType</a>(ATTR_STATS_INTERVAL,<a name="87" href="#87">87</a> <span class="string">"The interval between writing progress information to log."</span>,<a name="88" href="#88">88</a> DEFAULT_STATISTICS_REPORT_INTERVAL));<a name="89" href="#89">89</a> e.setOverrideable(false);<a name="90" href="#90">90</a> }<a name="91" href="#91">91</a> <a name="92" href="#92">92</a> <em>/**<em>*</em></em><a name="93" href="#93">93</a> <em> * Sets up the Logger (including logInterval) and registers with the</em><a name="94" href="#94">94</a> <em> * CrawlController for CrawlStatus and CrawlURIDisposition events.</em><a name="95" href="#95">95</a> <em> *</em><a name="96" href="#96">96</a> <em> * @param c A crawl controller instance.</em><a name="97" href="#97">97</a> <em> * @throws FatalConfigurationException Not thrown here. For overrides that</em><a name="98" href="#98">98</a> <em> * go to settings system for configuration.</em><a name="99" href="#99">99</a> <em> * @see CrawlStatusListener</em><a name="100" href="#100">100</a> <em> * @see org.archive.crawler.event.CrawlURIDispositionListener</em><a name="101" href="#101">101</a> <em> */</em><a name="102" href="#102">102</a> <strong>public</strong> <strong>void</strong> initialize(<a href="../../../../org/archive/crawler/framework/CrawlController.html">CrawlController</a> c)<a name="103" href="#103">103</a> throws <a href="../../../../org/archive/crawler/framework/exceptions/FatalConfigurationException.html">FatalConfigurationException</a> {<a name="104" href="#104">104</a> <strong>this</strong>.controller = c;<a name="105" href="#105">105</a> <a name="106" href="#106">106</a> <em class="comment">// Add listeners</em><a name="107" href="#107">107</a> <strong>this</strong>.controller.addCrawlStatusListener(<strong>this</strong>);<a name="108" href="#108">108</a> }<a name="109" href="#109">109</a> <a name="110" href="#110">110</a> <em>/**<em>*</em></em><a name="111" href="#111">111</a> <em> * Start thread. Will call logActivity() at intervals specified by</em><a name="112" href="#112">112</a> <em> * logInterval</em><a name="113" href="#113">113</a> <em> *</em><a name="114" href="#114">114</a> <em> */</em><a name="115" href="#115">115</a> <strong>public</strong> <strong>void</strong> run() {<a name="116" href="#116">116</a> <em class="comment">// Don't start logging if we have no logger</em><a name="117" href="#117">117</a> <strong>if</strong> (<strong>this</strong>.controller == <strong>null</strong>) {<a name="118" href="#118">118</a> <strong>return</strong>;<a name="119" href="#119">119</a> }<a name="120" href="#120">120</a> <a name="121" href="#121">121</a> shouldrun = <strong>true</strong>; <em class="comment">//If we are starting, this should always be true.</em><a name="122" href="#122">122</a> <a name="123" href="#123">123</a> <em class="comment">// Log the legend</em><a name="124" href="#124">124</a> <strong>this</strong>.controller.logProgressStatistics(progressStatisticsLegend());<a name="125" href="#125">125</a> lastLogPointTime = System.currentTimeMillis(); <em class="comment">// The first interval begins now.</em><a name="126" href="#126">126</a> <a name="127" href="#127">127</a> <em class="comment">// Keep logging until someone calls stop()</em><a name="128" href="#128">128</a> <strong>while</strong> (shouldrun) {<a name="129" href="#129">129</a> <em class="comment">// Pause before writing the first entry (so we have real numbers)</em><a name="130" href="#130">130</a> <em class="comment">// and then pause between entries</em><a name="131" href="#131">131</a> <strong>try</strong> {<a name="132" href="#132">132</a> Thread.sleep(getLogWriteInterval() * 1000);<a name="133" href="#133">133</a> } <strong>catch</strong> (InterruptedException e) {<a name="134" href="#134">134</a> e.printStackTrace();<a name="135" href="#135">135</a> controller.runtimeErrors.log(Level.INFO,<a name="136" href="#136">136</a> <span class="string">"Periodic stat logger interrupted while sleeping."</span>);<a name="137" href="#137">137</a> }<a name="138" href="#138">138</a> <a name="139" href="#139">139</a> <em class="comment">// In case stop() was invoked while the thread was sleeping or we</em><a name="140" href="#140">140</a> <em class="comment">// are paused.</em><a name="141" href="#141">141</a> <strong>if</strong> (shouldrun && getCrawlPauseStartedTime() == 0) {<a name="142" href="#142">142</a> progressStatisticsEvent(<strong>new</strong> EventObject(<strong>this</strong>));<a name="143" href="#143">143</a> }<a name="144" href="#144">144</a> }<a name="145" href="#145">145</a> }<a name="146" href="#146">146</a> <a name="147" href="#147">147</a> <em>/**<em>*</em></em><a name="148" href="#148">148</a> <em> * @return legend for progress-statistics lines/log</em><a name="149" href="#149">149</a> <em> */</em><a name="150" href="#150">150</a> <strong>public</strong> String progressStatisticsLegend() {<a name="151" href="#151">151</a> <strong>return</strong> <span class="string">" timestamp"</span> +<a name="152" href="#152">152</a> <span class="string">" discovered "</span> +<a name="153" href="#153">153</a> <span class="string">" queued downloaded doc/s(avg) KB/s(avg) "</span> +<a name="154" href="#154">154</a> <span class="string">" dl-failures busy-thread mem-use-KB heap-size-KB "</span> +<a name="155" href="#155">155</a> <span class="string">" congestion max-depth avg-depth"</span>;<a name="156" href="#156">156</a> }<a name="157" href="#157">157</a> <a name="158" href="#158">158</a> <em>/**<em>*</em></em><a name="159" href="#159">159</a> <em> * Notify tracker that crawl has begun. Must be called</em><a name="160" href="#160">160</a> <em> * outside tracker's own thread, to ensure it is noted</em><a name="161" href="#161">161</a> <em> * before other threads start interacting with tracker. </em><a name="162" href="#162">162</a> <em> */</em><a name="163" href="#163">163</a> <strong>public</strong> <strong>void</strong> noteStart() {<a name="164" href="#164">164</a> <strong>if</strong> (<strong>this</strong>.crawlerStartTime == 0) {<a name="165" href="#165">165</a> <em class="comment">// Note the time the crawl starts (only if not already set)</em><a name="166" href="#166">166</a> <strong>this</strong>.crawlerStartTime = System.currentTimeMillis();<a name="167" href="#167">167</a> }<a name="168" href="#168">168</a> }<a name="169" href="#169">169</a> <a name="170" href="#170">170</a> <em>/**<em>*</em></em>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -