org.apache.spark.sql.util

Interface QueryExecutionListener

public interface QueryExecutionListener

:: Experimental :: The interface of query execution listener that can be used to analyze execution metrics.

Note that implementations should guarantee thread-safety as they can be invoked by multiple different threads.

Method Summary

Methods

Modifier and Type	Method and Description
void	onFailure(java.lang.String funcName, org.apache.spark.sql.execution.QueryExecution qe, java.lang.Exception exception) A callback function that will be called when a query execution failed.
void	onSuccess(java.lang.String funcName, org.apache.spark.sql.execution.QueryExecution qe, long durationNs) A callback function that will be called when a query executed successfully.

Method Detail

onSuccess

void onSuccess(java.lang.String funcName,
             org.apache.spark.sql.execution.QueryExecution qe,
             long durationNs)

A callback function that will be called when a query executed successfully. Note that this can be invoked by multiple different threads.

Parameters:

funcName - name of the action that triggered this query.

qe - the QueryExecution object that carries detail information like logical plan, physical plan, etc.

durationNs - the execution time for this query in nanoseconds.

onFailure

void onFailure(java.lang.String funcName,
             org.apache.spark.sql.execution.QueryExecution qe,
             java.lang.Exception exception)

A callback function that will be called when a query execution failed. Note that this can be invoked by multiple different threads.

Parameters:

funcName - the name of the action that triggered this query.

qe - the QueryExecution object that carries detail information like logical plan, physical plan, etc.

exception - the exception that failed this query.