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

Class UpdatePerformanceTracker

java.lang.Object

io.deephaven.engine.table.impl.perf.UpdatePerformanceTracker

public class UpdatePerformanceTracker
extends Object

This tool is meant to track periodic update events that take place in an UpdateGraph. This generally includes:

1. Update source run() invocations
2. Table ShiftObliviousListener notifications (see ShiftObliviousInstrumentedListener)
3. Table TableUpdateListener notifications (see InstrumentedTableUpdateListener)

(1)

ApiNote:

Regarding thread safety, this class interacts with a singleton PeriodicUpdateGraph and expects all calls to getEntry(String), PerformanceEntry.onUpdateStart(), and PerformanceEntry.onUpdateEnd() to be performed while protected by the UGP's lock.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UpdatePerformanceTracker.IntervalLevelDetails	Holder for logging details that are the same for every Entry in an interval

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	LOG_ALL_ENTRIES_ONCE	Should all UpdatePerformanceTracker entries be logged once, to permit ancestor discovery even if they would otherwise not qualify for logging based on the log threshold.
static final long	REPORT_INTERVAL_MILLIS

Constructor Summary

Constructors

Constructor	Description
UpdatePerformanceTracker(UpdateGraph updateGraph)

Method Summary

Modifier and Type	Method	Description
void	enableUnitTestMode()
void	flush()	Flush this UpdatePerformanceTracker to the downstream publisher and logger, and begin its next interval.
static @NotNull QueryTable	getAncestorTable()
final PerformanceEntry	getEntry(String description)	Get a new entry to track the performance characteristics of a single recurring update event.
static @NotNull QueryTable	getQueryTable()
void	logAncestors(String updateGraphName, PerformanceEntry entry, Supplier<long[]> ancestors)	Log an array of ancestors for the provided entry.
static void	resetForUnitTests()
void	start()	Start this UpdatePerformanceTracker, by beginning its first interval.

Methods inherited from class java.lang.Object

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

Field Details

REPORT_INTERVAL_MILLIS

public static final long REPORT_INTERVAL_MILLIS

LOG_ALL_ENTRIES_ONCE

public static final boolean LOG_ALL_ENTRIES_ONCE

Should all UpdatePerformanceTracker entries be logged once, to permit ancestor discovery even if they would otherwise not qualify for logging based on the log threshold.

Constructor Details

UpdatePerformanceTracker

public UpdatePerformanceTracker(UpdateGraph updateGraph)

Method Details

start

public void start()

Start this UpdatePerformanceTracker, by beginning its first interval.

flush

public void flush()

Flush this UpdatePerformanceTracker to the downstream publisher and logger, and begin its next interval.

logAncestors

public void logAncestors(String updateGraphName,
 PerformanceEntry entry,
 Supplier<long[]> ancestors)

Log an array of ancestors for the provided entry.

Parameters:

entry - entry of entry to log for

ancestors - array of ancestor ids

enableUnitTestMode

public void enableUnitTestMode()

getEntry

public final PerformanceEntry getEntry(String description)

Get a new entry to track the performance characteristics of a single recurring update event.

Parameters:

description - log entry description

Returns:

UpdatePerformanceTracker.Entry

getQueryTable

@NotNull
public static @NotNull QueryTable getQueryTable()

getAncestorTable

@NotNull
public static @NotNull QueryTable getAncestorTable()

resetForUnitTests

@TestUseOnly
public static void resetForUnitTests()