| /** |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| |
| package org.apache.hadoop.mapreduce; |
| |
| import java.io.DataInput; |
| import java.io.DataOutput; |
| import java.io.IOException; |
| |
| import org.apache.hadoop.classification.InterfaceAudience; |
| import org.apache.hadoop.classification.InterfaceStability; |
| import org.apache.hadoop.io.Writable; |
| import org.apache.hadoop.io.WritableUtils; |
| |
| /** |
| * This is used to track task completion events on |
| * job tracker. |
| */ |
| @InterfaceAudience.Public |
| @InterfaceStability.Evolving |
| public class TaskCompletionEvent implements Writable{ |
| @InterfaceAudience.Public |
| @InterfaceStability.Evolving |
| /** |
| * Task Completion Statuses |
| */ |
| static public enum Status { |
| /** |
| * Task Event Attempt failed but there are attempts remaining. |
| */ |
| FAILED, |
| /** |
| * Task Event was killed. |
| */ |
| KILLED, |
| /** |
| * Task Event was successful. |
| */ |
| SUCCEEDED, |
| /** |
| * Used to Override a previously successful event status. |
| * Example: Map attempt runs and a SUCCEEDED event is sent. Later a task |
| * is retroactively failed due to excessive fetch failure during shuffle |
| * phase. When the retroactive attempt failure occurs, an OBSOLETE event is |
| * sent for the map attempt indicating the prior event is no longer valid. |
| */ |
| OBSOLETE, |
| /** |
| * Task Event attempt failed and no further attempts exist. |
| * reached MAX attempts. When a reducer receives a TIPFAILED event it |
| * gives up trying to shuffle data from that map task. |
| */ |
| TIPFAILED |
| } |
| |
| private int eventId; |
| private String taskTrackerHttp; |
| private int taskRunTime; // using int since runtime is the time difference |
| private TaskAttemptID taskId; |
| Status status; |
| boolean isMap = false; |
| private int idWithinJob; |
| public static final TaskCompletionEvent[] EMPTY_ARRAY = |
| new TaskCompletionEvent[0]; |
| /** |
| * Default constructor for Writable. |
| * |
| */ |
| public TaskCompletionEvent(){ |
| taskId = new TaskAttemptID(); |
| } |
| |
| /** |
| * Constructor. eventId should be created externally and incremented |
| * per event for each job. |
| * @param eventId event id, event id should be unique and assigned in |
| * incrementally, starting from 0. |
| * @param taskId task id |
| * @param status task's status |
| * @param taskTrackerHttp task tracker's host:port for http. |
| */ |
| public TaskCompletionEvent(int eventId, |
| TaskAttemptID taskId, |
| int idWithinJob, |
| boolean isMap, |
| Status status, |
| String taskTrackerHttp){ |
| |
| this.taskId = taskId; |
| this.idWithinJob = idWithinJob; |
| this.isMap = isMap; |
| this.eventId = eventId; |
| this.status =status; |
| this.taskTrackerHttp = taskTrackerHttp; |
| } |
| /** |
| * Returns event Id. |
| * @return event id |
| */ |
| public int getEventId() { |
| return eventId; |
| } |
| |
| /** |
| * Returns task id. |
| * @return task id |
| */ |
| public TaskAttemptID getTaskAttemptId() { |
| return taskId; |
| } |
| |
| /** |
| * Returns {@link Status} |
| * @return task completion status |
| */ |
| public Status getStatus() { |
| return status; |
| } |
| /** |
| * http location of the tasktracker where this task ran. |
| * @return http location of tasktracker user logs |
| */ |
| public String getTaskTrackerHttp() { |
| return taskTrackerHttp; |
| } |
| |
| /** |
| * Returns time (in millisec) the task took to complete. |
| */ |
| public int getTaskRunTime() { |
| return taskRunTime; |
| } |
| |
| /** |
| * Set the task completion time |
| * @param taskCompletionTime time (in millisec) the task took to complete |
| */ |
| protected void setTaskRunTime(int taskCompletionTime) { |
| this.taskRunTime = taskCompletionTime; |
| } |
| |
| /** |
| * set event Id. should be assigned incrementally starting from 0. |
| * @param eventId |
| */ |
| protected void setEventId(int eventId) { |
| this.eventId = eventId; |
| } |
| |
| /** |
| * Sets task id. |
| * @param taskId |
| */ |
| protected void setTaskAttemptId(TaskAttemptID taskId) { |
| this.taskId = taskId; |
| } |
| |
| /** |
| * Set task status. |
| * @param status |
| */ |
| protected void setTaskStatus(Status status) { |
| this.status = status; |
| } |
| |
| /** |
| * Set task tracker http location. |
| * @param taskTrackerHttp |
| */ |
| protected void setTaskTrackerHttp(String taskTrackerHttp) { |
| this.taskTrackerHttp = taskTrackerHttp; |
| } |
| |
| @Override |
| public String toString(){ |
| StringBuffer buf = new StringBuffer(); |
| buf.append("Task Id : "); |
| buf.append(taskId); |
| buf.append(", Status : "); |
| buf.append(status.name()); |
| return buf.toString(); |
| } |
| |
| @Override |
| public boolean equals(Object o) { |
| if(o == null) |
| return false; |
| if(o.getClass().equals(this.getClass())) { |
| TaskCompletionEvent event = (TaskCompletionEvent) o; |
| return this.isMap == event.isMapTask() |
| && this.eventId == event.getEventId() |
| && this.idWithinJob == event.idWithinJob() |
| && this.status.equals(event.getStatus()) |
| && this.taskId.equals(event.getTaskAttemptId()) |
| && this.taskRunTime == event.getTaskRunTime() |
| && this.taskTrackerHttp.equals(event.getTaskTrackerHttp()); |
| } |
| return false; |
| } |
| |
| @Override |
| public int hashCode() { |
| return toString().hashCode(); |
| } |
| |
| public boolean isMapTask() { |
| return isMap; |
| } |
| |
| public int idWithinJob() { |
| return idWithinJob; |
| } |
| ////////////////////////////////////////////// |
| // Writable |
| ////////////////////////////////////////////// |
| public void write(DataOutput out) throws IOException { |
| taskId.write(out); |
| WritableUtils.writeVInt(out, idWithinJob); |
| out.writeBoolean(isMap); |
| WritableUtils.writeEnum(out, status); |
| WritableUtils.writeString(out, taskTrackerHttp); |
| WritableUtils.writeVInt(out, taskRunTime); |
| WritableUtils.writeVInt(out, eventId); |
| } |
| |
| public void readFields(DataInput in) throws IOException { |
| taskId.readFields(in); |
| idWithinJob = WritableUtils.readVInt(in); |
| isMap = in.readBoolean(); |
| status = WritableUtils.readEnum(in, Status.class); |
| taskTrackerHttp = WritableUtils.readString(in); |
| taskRunTime = WritableUtils.readVInt(in); |
| eventId = WritableUtils.readVInt(in); |
| } |
| } |