Package org.apache.pinot.spi.trace

Class Tracing.DefaultThreadResourceUsageAccountant

java.lang.Object

org.apache.pinot.spi.trace.Tracing.DefaultThreadResourceUsageAccountant

All Implemented Interfaces:

ThreadResourceUsageAccountant

Enclosing class:

Tracing

public static class Tracing.DefaultThreadResourceUsageAccountant
extends Object
implements ThreadResourceUsageAccountant

Default accountant that is used to enable worker thread cancellation upon runner thread's interruption

Constructor Summary

Constructors

Constructor	Description
DefaultThreadResourceUsageAccountant()

Method Summary

Modifier and Type	Method	Description
void	clear()	clear thread accounting info when a task finishes execution on a thread
void	createExecutionContext(String queryId, int taskId, ThreadExecutionContext parentContext)	Task tracking info
void	createExecutionContextInner(String queryId, int taskId, ThreadExecutionContext parentContext)
Exception	getErrorStatus()	get error status if the query is preempted
ThreadExecutionContext	getThreadExecutionContext()	get the executon context of current thread
boolean	isAnchorThreadInterrupted()	check if the corresponding anchor thread of current thread is interrupted so that when we preempt a task we only call interrupt on the anchor thread
void	sampleUsage()	call to sample usage
void	setThreadResourceUsageProvider(ThreadResourceUsageProvider threadResourceUsageProvider)	set resource usage provider
void	startWatcherTask()	start the periodical task

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultThreadResourceUsageAccountant

public DefaultThreadResourceUsageAccountant()

Method Detail

isAnchorThreadInterrupted

public boolean isAnchorThreadInterrupted()

Description copied from interface: ThreadResourceUsageAccountant

check if the corresponding anchor thread of current thread is interrupted so that when we preempt a task we only call interrupt on the anchor thread

Specified by:

isAnchorThreadInterrupted in interface ThreadResourceUsageAccountant

clear

public void clear()

Description copied from interface: ThreadResourceUsageAccountant

clear thread accounting info when a task finishes execution on a thread

Specified by:

clear in interface ThreadResourceUsageAccountant

setThreadResourceUsageProvider

public void setThreadResourceUsageProvider(ThreadResourceUsageProvider threadResourceUsageProvider)

Description copied from interface: ThreadResourceUsageAccountant

set resource usage provider

Specified by:

setThreadResourceUsageProvider in interface ThreadResourceUsageAccountant

sampleUsage

public void sampleUsage()

Description copied from interface: ThreadResourceUsageAccountant

call to sample usage

Specified by:

sampleUsage in interface ThreadResourceUsageAccountant

createExecutionContext

public final void createExecutionContext(String queryId,
                                         int taskId,
                                         ThreadExecutionContext parentContext)

Description copied from interface: ThreadResourceUsageAccountant

Task tracking info

Specified by:

createExecutionContext in interface ThreadResourceUsageAccountant

Parameters:

queryId - query id string

taskId - a unique task id

parentContext - the parent execution context, null for root(runner) thread

createExecutionContextInner

public void createExecutionContextInner(String queryId,
                                        int taskId,
                                        ThreadExecutionContext parentContext)

getThreadExecutionContext

public ThreadExecutionContext getThreadExecutionContext()

Description copied from interface: ThreadResourceUsageAccountant

get the executon context of current thread

Specified by:

getThreadExecutionContext in interface ThreadResourceUsageAccountant

startWatcherTask

public void startWatcherTask()

Description copied from interface: ThreadResourceUsageAccountant

start the periodical task

Specified by:

startWatcherTask in interface ThreadResourceUsageAccountant

getErrorStatus

public Exception getErrorStatus()

Description copied from interface: ThreadResourceUsageAccountant

get error status if the query is preempted

Specified by:

getErrorStatus in interface ThreadResourceUsageAccountant

Returns:

empty string if N/A