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