org.apache.drill.exec.util.record

Class RecordBatchStats

java.lang.Object

org.apache.drill.exec.util.record.RecordBatchStats

public final class RecordBatchStats
extends Object

Utility class to capture key record batch statistics.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RecordBatchStats.RecordBatchIOType Indicates whether a record batch is Input or Output
static class	RecordBatchStats.RecordBatchStatsContext Helper class which loads contextual record batch logging options

Field Summary

Fields

Modifier and Type	Field and Description
static String	BATCH_STATS_PREFIX A prefix for all batch stats to simplify search

Method Summary

Modifier and Type	Method and Description
static void	logRecordBatchStats(RecordBatchStats.RecordBatchIOType ioType, RecordBatch recordBatch, RecordBatchStats.RecordBatchStatsContext batchStatsContext)
static void	logRecordBatchStats(RecordBatchStats.RecordBatchIOType ioType, RecordBatchSizer recordBatchSizer, RecordBatchStats.RecordBatchStatsContext batchStatsContext)
static void	logRecordBatchStats(RecordBatchStats.RecordBatchIOType ioType, String sourceId, RecordBatch recordBatch, RecordBatchStats.RecordBatchStatsContext batchStatsContext)
static void	logRecordBatchStats(RecordBatchStats.RecordBatchIOType ioType, String sourceId, RecordBatchSizer batchSizer, RecordBatchStats.RecordBatchStatsContext batchStatsContext) Logs record batch statistics for the input record batch (logging happens only when record statistics logging is enabled).
static void	logRecordBatchStats(RecordBatchStats.RecordBatchStatsContext batchStatsContext, String format, Object... args) Logs a generic batch statistics message
static void	logRecordBatchStats(String message, RecordBatchStats.RecordBatchStatsContext batchStatsContext) Logs a generic batch statistics message
static String	printAllocatorStats(BufferAllocator allocator)
static void	printConfiguredBatchSize(RecordBatchStats.RecordBatchStatsContext batchStatsContext, int batchSize) Prints the configured batch size

Methods inherited from class java.lang.Object

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

Field Detail

BATCH_STATS_PREFIX

public static final String BATCH_STATS_PREFIX

A prefix for all batch stats to simplify search

See Also:

Constant Field Values

Method Detail

logRecordBatchStats

public static void logRecordBatchStats(RecordBatchStats.RecordBatchIOType ioType,
                                       String sourceId,
                                       RecordBatch recordBatch,
                                       RecordBatchStats.RecordBatchStatsContext batchStatsContext)

See Also:

RecordBatchStats#logRecordBatchStats(RecordBatchIOType, String, RecordBatch, RecordBatchStatsContext)}

logRecordBatchStats

public static void logRecordBatchStats(RecordBatchStats.RecordBatchIOType ioType,
                                       RecordBatch recordBatch,
                                       RecordBatchStats.RecordBatchStatsContext batchStatsContext)

See Also:

RecordBatchStats#logRecordBatchStats(RecordBatchIOType, RecordBatch, RecordBatchStatsContext)}

logRecordBatchStats

public static void logRecordBatchStats(RecordBatchStats.RecordBatchIOType ioType,
                                       RecordBatchSizer recordBatchSizer,
                                       RecordBatchStats.RecordBatchStatsContext batchStatsContext)

See Also:

RecordBatchStats#logRecordBatchStats(RecordBatchIOType, String, RecordBatchSizer, RecordBatchStatsContext)}

logRecordBatchStats

public static void logRecordBatchStats(RecordBatchStats.RecordBatchIOType ioType,
                                       String sourceId,
                                       RecordBatchSizer batchSizer,
                                       RecordBatchStats.RecordBatchStatsContext batchStatsContext)

Logs record batch statistics for the input record batch (logging happens only when record statistics logging is enabled).

Parameters:

ioType - whether a record batch is an input or/and output

sourceId - optional source identifier for scanners

batchSizer - contains batch sizing information

batchStatsContext - batch stats context object

logRecordBatchStats

public static void logRecordBatchStats(String message,
                                       RecordBatchStats.RecordBatchStatsContext batchStatsContext)

Logs a generic batch statistics message

Parameters:

message - log message

batchStatsContext - batch stats context object

logRecordBatchStats

public static void logRecordBatchStats(RecordBatchStats.RecordBatchStatsContext batchStatsContext,
                                       String format,
                                       Object... args)

Logs a generic batch statistics message

Parameters:

batchStatsContext - batch stats context object

format - a string format as in String.format(java.lang.String, java.lang.Object...) method

args - format's arguments

printAllocatorStats

public static String printAllocatorStats(BufferAllocator allocator)

Parameters:

allocator - dumps allocator statistics

Returns:

string with allocator statistics

printConfiguredBatchSize

public static void printConfiguredBatchSize(RecordBatchStats.RecordBatchStatsContext batchStatsContext,
                                            int batchSize)

Prints the configured batch size

Parameters:

batchStatsContext - batch stats context object

batchSize - contains the configured batch size