Google Git
Sign in
apache / hbase-site / 6be7f1c569b0f0f64151e4687d98bbf050cb369a / . / devapidocs / src-html / org / apache / hadoop / hbase / monitoring / TaskGroup.html
blob: fae17e4da2212d9d578647735b4a47c4c6a48df2 [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<a name="line.2"></a>
<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a>
<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<span class="sourceLineNo">011</span> *<a name="line.11"></a>
<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a>
<span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a>
<span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a>
<span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a>
<span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a>
<span class="sourceLineNo">017</span> */<a name="line.17"></a>
<span class="sourceLineNo">018</span>package org.apache.hadoop.hbase.monitoring;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.util.Collection;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.util.Collections;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.concurrent.ConcurrentLinkedDeque;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.slf4j.Logger;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.slf4j.LoggerFactory;<a name="line.25"></a>
<span class="sourceLineNo">026</span><a name="line.26"></a>
<span class="sourceLineNo">027</span>/**<a name="line.27"></a>
<span class="sourceLineNo">028</span> * The {@link TaskGroup} can be seen as a big {@link MonitoredTask}, which contains a list of sub<a name="line.28"></a>
<span class="sourceLineNo">029</span> * monitored tasks. The monitored tasks in the group are still be managed by the<a name="line.29"></a>
<span class="sourceLineNo">030</span> * {@link TaskMonitor}, but whether to clear/expire the monitored tasks in a task group is optional.<a name="line.30"></a>
<span class="sourceLineNo">031</span> * Since the monitored task already has journals, which mark the phases in a task, we still also<a name="line.31"></a>
<span class="sourceLineNo">032</span> * need a task group to monitor a big task/process because the journals in a task is serial but the<a name="line.32"></a>
<span class="sourceLineNo">033</span> * tasks in the task group can be parallel, then we have more flexible ability to monitor the<a name="line.33"></a>
<span class="sourceLineNo">034</span> * process. Grouping the tasks is not strictly necessary but it is cleaner for presentation to<a name="line.34"></a>
<span class="sourceLineNo">035</span> * operators. We might want to display the tasks in a group in a list view where each task can be<a name="line.35"></a>
<span class="sourceLineNo">036</span> * collapsed (probably by default) or expanded.<a name="line.36"></a>
<span class="sourceLineNo">037</span> */<a name="line.37"></a>
<span class="sourceLineNo">038</span>@InterfaceAudience.Private<a name="line.38"></a>
<span class="sourceLineNo">039</span>public class TaskGroup extends MonitoredTaskImpl {<a name="line.39"></a>
<span class="sourceLineNo">040</span> private static final Logger LOG = LoggerFactory.getLogger(TaskGroup.class);<a name="line.40"></a>
<span class="sourceLineNo">041</span><a name="line.41"></a>
<span class="sourceLineNo">042</span> /** Sub-tasks in the group */<a name="line.42"></a>
<span class="sourceLineNo">043</span> private final ConcurrentLinkedDeque&lt;MonitoredTask&gt; tasks = new ConcurrentLinkedDeque&lt;&gt;();<a name="line.43"></a>
<span class="sourceLineNo">044</span><a name="line.44"></a>
<span class="sourceLineNo">045</span> /** Whether to ignore to track(e.g. show/clear/expire) in the singleton {@link TaskMonitor} */<a name="line.45"></a>
<span class="sourceLineNo">046</span> private boolean ignoreSubTasksInTaskMonitor;<a name="line.46"></a>
<span class="sourceLineNo">047</span><a name="line.47"></a>
<span class="sourceLineNo">048</span> /** Used to track this task group in {@link TaskMonitor} */<a name="line.48"></a>
<span class="sourceLineNo">049</span> private final MonitoredTask delegate;<a name="line.49"></a>
<span class="sourceLineNo">050</span><a name="line.50"></a>
<span class="sourceLineNo">051</span> public TaskGroup(boolean ignoreSubTasksInTaskMonitor, String description) {<a name="line.51"></a>
<span class="sourceLineNo">052</span> super(false, description);<a name="line.52"></a>
<span class="sourceLineNo">053</span> this.ignoreSubTasksInTaskMonitor = ignoreSubTasksInTaskMonitor;<a name="line.53"></a>
<span class="sourceLineNo">054</span> this.delegate = TaskMonitor.get().createStatus(description, false, true);<a name="line.54"></a>
<span class="sourceLineNo">055</span> }<a name="line.55"></a>
<span class="sourceLineNo">056</span><a name="line.56"></a>
<span class="sourceLineNo">057</span> public synchronized MonitoredTask addTask(String description) {<a name="line.57"></a>
<span class="sourceLineNo">058</span> return addTask(description, true);<a name="line.58"></a>
<span class="sourceLineNo">059</span> }<a name="line.59"></a>
<span class="sourceLineNo">060</span><a name="line.60"></a>
<span class="sourceLineNo">061</span> /**<a name="line.61"></a>
<span class="sourceLineNo">062</span> * Add a new task to the group, and before that might complete the last task in the group<a name="line.62"></a>
<span class="sourceLineNo">063</span> * @param description the description of the new task<a name="line.63"></a>
<span class="sourceLineNo">064</span> * @param withCompleteLast whether to complete the last task in the group<a name="line.64"></a>
<span class="sourceLineNo">065</span> * @return the added new task<a name="line.65"></a>
<span class="sourceLineNo">066</span> */<a name="line.66"></a>
<span class="sourceLineNo">067</span> public synchronized MonitoredTask addTask(String description, boolean withCompleteLast) {<a name="line.67"></a>
<span class="sourceLineNo">068</span> if (withCompleteLast) {<a name="line.68"></a>
<span class="sourceLineNo">069</span> MonitoredTask previousTask = this.tasks.peekLast();<a name="line.69"></a>
<span class="sourceLineNo">070</span> if (<a name="line.70"></a>
<span class="sourceLineNo">071</span> previousTask != null &amp;&amp; previousTask.getState() != State.COMPLETE<a name="line.71"></a>
<span class="sourceLineNo">072</span> &amp;&amp; previousTask.getState() != State.ABORTED<a name="line.72"></a>
<span class="sourceLineNo">073</span> ) {<a name="line.73"></a>
<span class="sourceLineNo">074</span> previousTask.markComplete("Completed");<a name="line.74"></a>
<span class="sourceLineNo">075</span> }<a name="line.75"></a>
<span class="sourceLineNo">076</span> }<a name="line.76"></a>
<span class="sourceLineNo">077</span> MonitoredTask task =<a name="line.77"></a>
<span class="sourceLineNo">078</span> TaskMonitor.get().createStatus(description, ignoreSubTasksInTaskMonitor, true);<a name="line.78"></a>
<span class="sourceLineNo">079</span> this.setStatus(description);<a name="line.79"></a>
<span class="sourceLineNo">080</span> this.tasks.addLast(task);<a name="line.80"></a>
<span class="sourceLineNo">081</span> delegate.setStatus(description);<a name="line.81"></a>
<span class="sourceLineNo">082</span> return task;<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> public synchronized Collection&lt;MonitoredTask&gt; getTasks() {<a name="line.85"></a>
<span class="sourceLineNo">086</span> return Collections.unmodifiableCollection(this.tasks);<a name="line.86"></a>
<span class="sourceLineNo">087</span> }<a name="line.87"></a>
<span class="sourceLineNo">088</span><a name="line.88"></a>
<span class="sourceLineNo">089</span> @Override<a name="line.89"></a>
<span class="sourceLineNo">090</span> public synchronized void abort(String msg) {<a name="line.90"></a>
<span class="sourceLineNo">091</span> setStatus(msg);<a name="line.91"></a>
<span class="sourceLineNo">092</span> setState(State.ABORTED);<a name="line.92"></a>
<span class="sourceLineNo">093</span> for (MonitoredTask task : tasks) {<a name="line.93"></a>
<span class="sourceLineNo">094</span> if (task.getState() != State.COMPLETE &amp;&amp; task.getState() != State.ABORTED) {<a name="line.94"></a>
<span class="sourceLineNo">095</span> task.abort(msg);<a name="line.95"></a>
<span class="sourceLineNo">096</span> }<a name="line.96"></a>
<span class="sourceLineNo">097</span> }<a name="line.97"></a>
<span class="sourceLineNo">098</span> delegate.abort(msg);<a name="line.98"></a>
<span class="sourceLineNo">099</span> }<a name="line.99"></a>
<span class="sourceLineNo">100</span><a name="line.100"></a>
<span class="sourceLineNo">101</span> @Override<a name="line.101"></a>
<span class="sourceLineNo">102</span> public synchronized void markComplete(String msg) {<a name="line.102"></a>
<span class="sourceLineNo">103</span> setState(State.COMPLETE);<a name="line.103"></a>
<span class="sourceLineNo">104</span> setStatus(msg);<a name="line.104"></a>
<span class="sourceLineNo">105</span> if (tasks.getLast() != null) {<a name="line.105"></a>
<span class="sourceLineNo">106</span> tasks.getLast().markComplete(msg);<a name="line.106"></a>
<span class="sourceLineNo">107</span> }<a name="line.107"></a>
<span class="sourceLineNo">108</span> delegate.markComplete(msg);<a name="line.108"></a>
<span class="sourceLineNo">109</span> }<a name="line.109"></a>
<span class="sourceLineNo">110</span><a name="line.110"></a>
<span class="sourceLineNo">111</span> @Override<a name="line.111"></a>
<span class="sourceLineNo">112</span> public synchronized void cleanup() {<a name="line.112"></a>
<span class="sourceLineNo">113</span> this.tasks.clear();<a name="line.113"></a>
<span class="sourceLineNo">114</span> }<a name="line.114"></a>
<span class="sourceLineNo">115</span>}<a name="line.115"></a>
</pre>
</div>
</body>
</html>