Package org.apache.flink.runtime.scheduler.exceptionhistory

Class ExceptionHistoryEntry

java.lang.Object

org.apache.flink.runtime.executiongraph.ErrorInfo

org.apache.flink.runtime.scheduler.exceptionhistory.ExceptionHistoryEntry

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

RootExceptionHistoryEntry

public class ExceptionHistoryEntry
extends ErrorInfo

ExceptionHistoryEntry collects information about a single failure that triggered the scheduler's failure handling.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExceptionHistoryEntry.ArchivedTaskManagerLocation	ArchivedTaskManagerLocation represents a archived (static) version of a TaskManagerLocation.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ExceptionHistoryEntry(Throwable cause, long timestamp, CompletableFuture<Map<String,String>> failureLabels, String failingTaskName, TaskManagerLocation taskManagerLocation)	Instantiates a ExceptionHistoryEntry.

Method Summary

Modifier and Type	Method	Description
static ExceptionHistoryEntry	create(AccessExecution failedExecution, String taskName, CompletableFuture<Map<String,String>> failureLabels)	Creates an ExceptionHistoryEntry based on the provided Execution.
static ExceptionHistoryEntry	createGlobal(Throwable cause, CompletableFuture<Map<String,String>> failureLabels)	Creates an ExceptionHistoryEntry that is not based on an Execution.
String	getFailingTaskName()
Map<String,String>	getFailureLabels()	Returns the labels associated with the failure that is set as soon as failureLabelsFuture is completed.
CompletableFuture<Map<String,String>>	getFailureLabelsFuture()	Returns the labels future associated with the failure.
ExceptionHistoryEntry.ArchivedTaskManagerLocation	getTaskManagerLocation()
boolean	isGlobal()

Methods inherited from class org.apache.flink.runtime.executiongraph.ErrorInfo

createErrorInfoWithNullableCause, getException, getExceptionAsString, getTimestamp, handleMissingThrowable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExceptionHistoryEntry

protected ExceptionHistoryEntry(Throwable cause,
                                long timestamp,
                                CompletableFuture<Map<String,String>> failureLabels,
                                @Nullable
                                String failingTaskName,
                                @Nullable
                                TaskManagerLocation taskManagerLocation)

Instantiates a ExceptionHistoryEntry.

Parameters:

cause - The reason for the failure.

timestamp - The time the failure was caught.

failureLabels - The labels associated with the failure.

failingTaskName - The name of the task that failed.

taskManagerLocation - The host the task was running on.

Throws:

NullPointerException - if cause is null.

IllegalArgumentException - if the passed timestamp is not bigger than 0.

Method Detail

create

public static ExceptionHistoryEntry create(AccessExecution failedExecution,
                                           String taskName,
                                           CompletableFuture<Map<String,String>> failureLabels)

Creates an ExceptionHistoryEntry based on the provided Execution.

Parameters:

failedExecution - the failed Execution.

taskName - the name of the task.

failureLabels - the labels associated with the failure.

Returns:

The ExceptionHistoryEntry.

Throws:

NullPointerException - if null is passed as one of the parameters.

IllegalArgumentException - if the passed Execution does not provide a failureInfo.

createGlobal

public static ExceptionHistoryEntry createGlobal(Throwable cause,
                                                 CompletableFuture<Map<String,String>> failureLabels)

Creates an ExceptionHistoryEntry that is not based on an Execution.

isGlobal

public boolean isGlobal()

getFailingTaskName

@Nullable
public String getFailingTaskName()

getTaskManagerLocation

@Nullable
public ExceptionHistoryEntry.ArchivedTaskManagerLocation getTaskManagerLocation()

getFailureLabels

public Map<String,String> getFailureLabels()

Returns the labels associated with the failure that is set as soon as failureLabelsFuture is completed. When failureLabelsFuture is not completed, it returns an empty map.

Returns:

Map of failure labels

getFailureLabelsFuture

public CompletableFuture<Map<String,String>> getFailureLabelsFuture()

Returns the labels future associated with the failure.

Returns:

CompletableFuture of Map failure labels