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

Class RootExceptionHistoryEntry

java.lang.Object

org.apache.flink.runtime.executiongraph.ErrorInfo

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

org.apache.flink.runtime.scheduler.exceptionhistory.RootExceptionHistoryEntry

All Implemented Interfaces:

Serializable

@NotThreadSafe
public class RootExceptionHistoryEntry
extends ExceptionHistoryEntry

RootExceptionHistoryEntry extending ExceptionHistoryEntry by providing a list of ExceptionHistoryEntry instances to store concurrently caught failures.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.flink.runtime.scheduler.exceptionhistory.ExceptionHistoryEntry

ExceptionHistoryEntry.ArchivedTaskManagerLocation

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	addConcurrentExceptions(Iterable<Execution> concurrentlyExecutions)
static RootExceptionHistoryEntry	fromExceptionHistoryEntry(ExceptionHistoryEntry entry, Collection<ExceptionHistoryEntry> entries)
static RootExceptionHistoryEntry	fromFailureHandlingResultSnapshot(FailureHandlingResultSnapshot snapshot)	Creates a RootExceptionHistoryEntry based on the passed FailureHandlingResultSnapshot.
static RootExceptionHistoryEntry	fromGlobalFailure(Throwable cause, long timestamp, CompletableFuture<Map<String,String>> failureLabels, Iterable<Execution> executions)	Creates a RootExceptionHistoryEntry representing a global failure from the passed Throwable and timestamp.
static RootExceptionHistoryEntry	fromGlobalFailure(ErrorInfo errorInfo)	Creates a RootExceptionHistoryEntry based on the passed ErrorInfo.
Iterable<ExceptionHistoryEntry>	getConcurrentExceptions()

Methods inherited from class org.apache.flink.runtime.scheduler.exceptionhistory.ExceptionHistoryEntry

create, createGlobal, getFailingTaskName, getFailureLabels, getFailureLabelsFuture, getTaskManagerLocation, 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

RootExceptionHistoryEntry

@VisibleForTesting
public RootExceptionHistoryEntry(Throwable cause,
                                 long timestamp,
                                 CompletableFuture<Map<String,String>> failureLabels,
                                 @Nullable
                                 String failingTaskName,
                                 @Nullable
                                 TaskManagerLocation taskManagerLocation,
                                 Collection<ExceptionHistoryEntry> concurrentExceptions)

Instantiates a RootExceptionHistoryEntry.

Parameters:

cause - The reason for the failure.

timestamp - The time the failure was caught.

failureLabels - 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

fromFailureHandlingResultSnapshot

public static RootExceptionHistoryEntry fromFailureHandlingResultSnapshot(FailureHandlingResultSnapshot snapshot)

Creates a RootExceptionHistoryEntry based on the passed FailureHandlingResultSnapshot.

Parameters:

snapshot - The reason for the failure.

Returns:

The RootExceptionHistoryEntry instance.

Throws:

NullPointerException - if cause or failingTaskName are null.

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

fromGlobalFailure

public static RootExceptionHistoryEntry fromGlobalFailure(Throwable cause,
                                                          long timestamp,
                                                          CompletableFuture<Map<String,String>> failureLabels,
                                                          Iterable<Execution> executions)

Creates a RootExceptionHistoryEntry representing a global failure from the passed Throwable and timestamp. If any of the passed Executions failed, it will be added to the RootExceptionHistoryEntry's concurrently caught failures.

Parameters:

cause - The reason for the failure.

timestamp - The time the failure was caught.

failureLabels - Map of string labels associated with the failure.

executions - The Execution instances that shall be analyzed for failures.

Returns:

The RootExceptionHistoryEntry instance.

Throws:

NullPointerException - if failure is null.

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

fromExceptionHistoryEntry

public static RootExceptionHistoryEntry fromExceptionHistoryEntry(ExceptionHistoryEntry entry,
                                                                  Collection<ExceptionHistoryEntry> entries)

fromGlobalFailure

public static RootExceptionHistoryEntry fromGlobalFailure(ErrorInfo errorInfo)

Creates a RootExceptionHistoryEntry based on the passed ErrorInfo. No concurrent failures will be added.

Parameters:

errorInfo - The failure information that shall be used to initialize the RootExceptionHistoryEntry.

Returns:

The RootExceptionHistoryEntry instance.

Throws:

NullPointerException - if errorInfo is null or the passed info does not contain a Throwable.

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

addConcurrentExceptions

public void addConcurrentExceptions(Iterable<Execution> concurrentlyExecutions)

getConcurrentExceptions

public Iterable<ExceptionHistoryEntry> getConcurrentExceptions()