Package io.deephaven.engine.table.impl.perf

Class QueryPerformanceRecorderImpl

java.lang.Object

io.deephaven.engine.table.impl.perf.QueryPerformanceRecorderImpl

All Implemented Interfaces:

QueryPerformanceRecorder

public class QueryPerformanceRecorderImpl
extends Object
implements QueryPerformanceRecorder

Query performance instrumentation implementation. Manages a hierarchy of QueryPerformanceNugget instances.

Many methods are synchronized to 1) support external abort of query and 2) for scenarios where the query is suspended and resumed on another thread.

Nested Class Summary

Nested classes/interfaces inherited from interface io.deephaven.engine.table.impl.perf.QueryPerformanceRecorder

QueryPerformanceRecorder.QueryDataConsumer

Field Summary

Fields inherited from interface io.deephaven.engine.table.impl.perf.QueryPerformanceRecorder

UNINSTRUMENTED_CODE_DESCRIPTION

Method Summary

Modifier and Type	Method	Description
void	abortQuery()	Abort a query.
void	accumulate(@NotNull QueryPerformanceRecorder subQuery)	Accumulate performance information from another recorder into this one.
boolean	endQuery()	End a query.
QueryPerformanceNugget	getCompilationNugget(@NotNull String name)	Create a nugget at the top of the user stack for a compilation task.
QueryPerformanceNugget	getEnclosingNugget()	This is the nugget enclosing the current operation.
QueryPerformanceNugget	getNugget(@NotNull String name, long inputSize)	Create a nugget at the top of the user stack.
List<QueryPerformanceNugget>	getOperationLevelPerformanceData()	This getter should be called by exclusive owners of the recorder, and never concurrently with mutators.
QueryPerformanceNugget	getQueryLevelPerformanceData()
QueryState	getState()	Return the query's current state
boolean	hasSubQueries()
SafeCloseable	resumeQuery()	Resumes a suspend query.
SafeCloseable	startQuery()	Starts a query.
void	supplyQueryData(@NotNull QueryPerformanceRecorder.QueryDataConsumer consumer)	Provide current query data via the consumer.
void	suspendQuery()	Suspends a query.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.deephaven.engine.table.impl.perf.QueryPerformanceRecorder

getNugget

Method Details

abortQuery

public void abortQuery()

Description copied from interface: QueryPerformanceRecorder

Abort a query.

A query is RUNNING if it has been started or resumed without a subsequent end, suspend, or abort.

Note that this method is invoked out-of-band and does not throw if the query has been completed.

Specified by:

abortQuery in interface QueryPerformanceRecorder

getState

public QueryState getState()

Return the query's current state

Specified by:

getState in interface QueryPerformanceRecorder

Returns:

the query's state or null if it isn't initialized yet

startQuery

public SafeCloseable startQuery()

Description copied from interface: QueryPerformanceRecorder

Starts a query.

A query is RUNNING if it has been started or resumed without a subsequent end, suspend, or abort.

Specified by:

startQuery in interface QueryPerformanceRecorder

endQuery

public boolean endQuery()

Description copied from interface: QueryPerformanceRecorder

End a query.

A query is RUNNING if it has been started or resumed without a subsequent end, suspend, or abort.

Specified by:

endQuery in interface QueryPerformanceRecorder

Returns:

whether the query should be logged

suspendQuery

public void suspendQuery()

Suspends a query.

This resets the thread local and assumes that this performance nugget may be resumed on another thread.

Specified by:

suspendQuery in interface QueryPerformanceRecorder

resumeQuery

public SafeCloseable resumeQuery()

Resumes a suspend query.

It is an error to resume a query while another query is running on this thread.

Specified by:

resumeQuery in interface QueryPerformanceRecorder

Returns:

this

getNugget

public QueryPerformanceNugget getNugget(@NotNull
 @NotNull String name,
 long inputSize)

Description copied from interface: QueryPerformanceRecorder

Create a nugget at the top of the user stack. May return a QueryPerformanceNugget.DUMMY_NUGGET if no recorder is installed.

Specified by:

getNugget in interface QueryPerformanceRecorder

Parameters:

name - the nugget name

inputSize - the nugget's input size

Returns:

A new QueryPerformanceNugget to encapsulate user query operations. QueryPerformanceNugget.close() must be called on the nugget.

getCompilationNugget

public QueryPerformanceNugget getCompilationNugget(@NotNull
 @NotNull String name)

Description copied from interface: QueryPerformanceRecorder

Create a nugget at the top of the user stack for a compilation task. May return a QueryPerformanceNugget.DUMMY_NUGGET if no recorder is installed.

Specified by:

getCompilationNugget in interface QueryPerformanceRecorder

Parameters:

name - the nugget name

Returns:

A new QueryPerformanceNugget to encapsulate the compilation. QueryPerformanceNugget.close() must be called on the nugget.

getEnclosingNugget

public QueryPerformanceNugget getEnclosingNugget()

Description copied from interface: QueryPerformanceRecorder

This is the nugget enclosing the current operation. It may belong to the dummy recorder, or a real one.

Specified by:

getEnclosingNugget in interface QueryPerformanceRecorder

Returns:

Either a "catch-all" nugget, or the top of the user nugget stack.

supplyQueryData

public void supplyQueryData(@NotNull
 @NotNull QueryPerformanceRecorder.QueryDataConsumer consumer)

Description copied from interface: QueryPerformanceRecorder

Provide current query data via the consumer.

Specified by:

supplyQueryData in interface QueryPerformanceRecorder

Parameters:

consumer - a callback to receive query data

getQueryLevelPerformanceData

public QueryPerformanceNugget getQueryLevelPerformanceData()

Specified by:

getQueryLevelPerformanceData in interface QueryPerformanceRecorder

Returns:

the query level performance data

getOperationLevelPerformanceData

public List<QueryPerformanceNugget> getOperationLevelPerformanceData()

Description copied from interface: QueryPerformanceRecorder

This getter should be called by exclusive owners of the recorder, and never concurrently with mutators.

Specified by:

getOperationLevelPerformanceData in interface QueryPerformanceRecorder

Returns:

A list of loggable operation performance data.

accumulate

public void accumulate(@NotNull
 @NotNull QueryPerformanceRecorder subQuery)

Description copied from interface: QueryPerformanceRecorder

Accumulate performance information from another recorder into this one. The provided recorder will not be mutated.

Specified by:

accumulate in interface QueryPerformanceRecorder

Parameters:

subQuery - the recorder to accumulate into this

hasSubQueries

public boolean hasSubQueries()

Specified by:

hasSubQueries in interface QueryPerformanceRecorder

Returns:

whether a sub-query was ever accumulated into this recorder