org.apache.flink.runtime.rest.messages.job.SubtaskExecutionAttemptInfo Maven / Gradle / Ivy

/*
 * 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.flink.runtime.rest.messages.job;

import org.apache.flink.runtime.clusterframework.types.ResourceID;
import org.apache.flink.runtime.execution.ExecutionState;
import org.apache.flink.runtime.executiongraph.AccessExecution;
import org.apache.flink.runtime.executiongraph.ExecutionAttemptID;
import org.apache.flink.runtime.rest.messages.ResponseBody;
import org.apache.flink.runtime.rest.messages.json.ExecutionAttemptIDDeserializer;
import org.apache.flink.runtime.rest.messages.json.ExecutionAttemptIDSerializer;
import org.apache.flink.runtime.rest.messages.json.ResourceIDDeserializer;
import org.apache.flink.runtime.rest.messages.json.ResourceIDSerializer;
import org.apache.flink.runtime.taskmanager.TaskManagerLocation;
import org.apache.flink.util.Preconditions;

import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.annotation.JsonCreator;
import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.annotation.JsonProperty;
import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import org.apache.flink.shaded.jackson2.com.fasterxml.jackson.databind.annotation.JsonSerialize;

import java.util.Objects;

/**
 * The sub task execution attempt response.
 */
public class SubtaskExecutionAttemptInfo implements ResponseBody {

	public static final String FIELD_NAME_ID = "id";

	public static final String FIELD_NAME_STATUS = "status";

	public static final String FIELD_NAME_ATTEMPT = "attempt";

	public static final String FIELD_NAME_HOST = "host";

	public static final String FIELD_NAME_START_TIME = "start-time";

	public static final String FIELD_NAME_END_TIME = "end-time";

	public static final String FIELD_NAME_DURATION = "duration";

	public static final String FIELD_NAME_FAILURE_CAUSE = "failure-cause";

	public static final String FIELD_NAME_RESOURCE_ID = "resource-id";

	public static final String FIELD_NAME_SUBTASK_INDEX = "subtask-index";

	public static final String FIELD_NAME_VERTERX_ID = "vertex-id";

	public static final String FIELD_NAME_CURRENT_STATE_TIME = "current-start-time";

	@JsonProperty(FIELD_NAME_ID)
	@JsonSerialize(using = ExecutionAttemptIDSerializer.class)
	private final ExecutionAttemptID attemptID;

	@JsonProperty(FIELD_NAME_STATUS)
	private final ExecutionState status;

	@JsonProperty(FIELD_NAME_ATTEMPT)
	private final int attempt;

	@JsonProperty(FIELD_NAME_HOST)
	private final String host;

	@JsonProperty(FIELD_NAME_START_TIME)
	private final long startTime;

	@JsonProperty(FIELD_NAME_END_TIME)
	private final long endTime;

	@JsonProperty(FIELD_NAME_DURATION)
	private final long duration;

	@JsonProperty(FIELD_NAME_FAILURE_CAUSE)
	private final String failureCause;

	@JsonProperty(FIELD_NAME_RESOURCE_ID)
	@JsonSerialize(using = ResourceIDSerializer.class)
	private final ResourceID resourceID;

	@JsonProperty(FIELD_NAME_SUBTASK_INDEX)
	private final int subtaskIndex;

	@JsonProperty(FIELD_NAME_VERTERX_ID)
	private final String vertexId;

	@JsonProperty(FIELD_NAME_CURRENT_STATE_TIME)
	private final long currentStateTime;

	@JsonCreator
	public SubtaskExecutionAttemptInfo(
		@JsonDeserialize(using = ExecutionAttemptIDDeserializer.class)
			@JsonProperty(FIELD_NAME_ID) ExecutionAttemptID attemptID,
		@JsonProperty(FIELD_NAME_STATUS) ExecutionState status,
		@JsonProperty(FIELD_NAME_ATTEMPT) int attempt,
		@JsonProperty(FIELD_NAME_HOST) String host,
		@JsonProperty(FIELD_NAME_START_TIME) long startTime,
		@JsonProperty(FIELD_NAME_END_TIME) long endTime,
		@JsonProperty(FIELD_NAME_DURATION) long duration,
		@JsonProperty(FIELD_NAME_FAILURE_CAUSE) String failureCause,
		@JsonDeserialize(using = ResourceIDDeserializer.class)
			@JsonProperty(FIELD_NAME_RESOURCE_ID) ResourceID resourceID,
		@JsonProperty(FIELD_NAME_SUBTASK_INDEX) int subtaskIndex,
		@JsonProperty(FIELD_NAME_VERTERX_ID) String vertexId,
		@JsonProperty(FIELD_NAME_CURRENT_STATE_TIME) long currentStateTime) {

		this.attemptID = Preconditions.checkNotNull(attemptID);
		this.status = Preconditions.checkNotNull(status);
		this.attempt = attempt;
		this.host = Preconditions.checkNotNull(host);
		this.startTime = startTime;
		this.endTime = endTime;
		this.duration = duration;
		this.failureCause = Preconditions.checkNotNull(failureCause);
		this.resourceID = Preconditions.checkNotNull(resourceID);
		this.subtaskIndex = subtaskIndex;
		this.vertexId = vertexId;
		this.currentStateTime = currentStateTime;
	}

	public ExecutionAttemptID getAttemptID() {
		return attemptID;
	}

	public ExecutionState getStatus() {
		return status;
	}

	public int getAttempt() {
		return attempt;
	}

	public String getHost() {
		return host;
	}

	public long getStartTime() {
		return startTime;
	}

	public long getEndTime() {
		return endTime;
	}

	public long getDuration() {
		return duration;
	}

	public String getFailureCause() {
		return failureCause;
	}

	public ResourceID getResourceID() {
		return resourceID;
	}

	public int getSubtaskIndex() {
		return subtaskIndex;
	}

	public String getVertexId() {
		return vertexId;
	}

	public long getCurrentStateTime() {
		return currentStateTime;
	}

	@Override
	public boolean equals(Object o) {
		if (this == o) {
			return true;
		}
		if (o == null || getClass() != o.getClass()) {
			return false;
		}

		SubtaskExecutionAttemptInfo that = (SubtaskExecutionAttemptInfo) o;

		return Objects.equals(attemptID, that.attemptID) &&
			status == that.status &&
			attempt == that.attempt &&
			Objects.equals(host, that.host) &&
			startTime == that.startTime &&
			endTime == that.endTime &&
			duration == that.duration &&
			Objects.equals(failureCause, that.failureCause) &&
			Objects.equals(resourceID, that.resourceID) &&
			subtaskIndex == that.subtaskIndex &&
			Objects.equals(vertexId, that.vertexId) &&
			currentStateTime == that.currentStateTime;
	}

	@Override
	public int hashCode() {
		return Objects.hash(attemptID, status, attempt, host, startTime,
			endTime, duration, failureCause, resourceID, subtaskIndex, vertexId, currentStateTime);
	}

	public static SubtaskExecutionAttemptInfo create(AccessExecution execution, String vertexId) {
		final ExecutionState status = execution.getState();
		final long now = System.currentTimeMillis();
		final TaskManagerLocation location = execution.getAssignedResourceLocation();
		final String locationString = location == null ? "(unassigned)" : location.getHostname() + ":" + location.dataPort();
		final ResourceID resourceID = location == null ? new ResourceID("(unassigned)") : location.getResourceID();

		long startTime = execution.getStateTimestamp(ExecutionState.DEPLOYING);
		if (startTime == 0) {
			startTime = -1;
		}
		final long endTime = status.isTerminal() ? execution.getStateTimestamp(status) : -1;
		final long duration = startTime > 0 ? ((endTime > 0 ? endTime : now) - startTime) : -1;

		final String failureCause = execution.getFailureCauseAsString();

		return new SubtaskExecutionAttemptInfo(
			execution.getAttemptId(),
			status,
			execution.getAttemptNumber(),
			locationString,
			startTime,
			endTime,
			duration,
			failureCause,
			resourceID,
			execution.getParallelSubtaskIndex(),
			vertexId,
			execution.getStateTimestamp(status)
		);
	}
}