Package org.apache.pinot.common.metrics

Class BrokerMetrics

java.lang.Object

org.apache.pinot.common.metrics.AbstractMetrics<BrokerQueryPhase,BrokerMeter,BrokerGauge,BrokerTimer>

org.apache.pinot.common.metrics.BrokerMetrics

public class BrokerMetrics
extends AbstractMetrics<BrokerQueryPhase,BrokerMeter,BrokerGauge,BrokerTimer>

Broker metrics utility class, which provides facilities to log the execution performance of queries.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.pinot.common.metrics.AbstractMetrics

AbstractMetrics.Gauge, AbstractMetrics.Meter, AbstractMetrics.QueryPhase, AbstractMetrics.Timer

Field Summary

Fields inherited from class org.apache.pinot.common.metrics.AbstractMetrics

_metricPrefix, _metricsRegistry

Constructor Summary

Constructors

Constructor	Description
BrokerMetrics(String prefix, PinotMetricsRegistry metricsRegistry, boolean isTableLevelMetricsEnabled, Collection<String> allowedTables)
BrokerMetrics(PinotMetricsRegistry metricsRegistry)	Constructs the broker metrics.
BrokerMetrics(PinotMetricsRegistry metricsRegistry, boolean isTableLevelMetricsEnabled, Collection<String> allowedTables)

Method Summary

Modifier and Type	Method	Description
protected BrokerGauge[]	getGauges()
protected BrokerMeter[]	getMeters()
protected BrokerQueryPhase[]	getQueryPhases()

Methods inherited from class org.apache.pinot.common.metrics.AbstractMetrics

addCallbackGauge, addCallbackGaugeIfNeeded, addCallbackTableGaugeIfNeeded, addMeteredGlobalValue, addMeteredGlobalValue, addMeteredTableValue, addMeteredTableValue, addOrUpdateGauge, addPhaseTiming, addPhaseTiming, addTimedTableValue, addTimedValue, addValueToGlobalGauge, addValueToTableGauge, containsGauge, getMeteredTableValue, getMetricsRegistry, getTableName, getValueOfGlobalGauge, getValueOfGlobalGauge, getValueOfPartitionGauge, getValueOfTableGauge, initializeGlobalMeters, removeGauge, removeTableGauge, setValueOfGlobalGauge, setValueOfGlobalGauge, setValueOfPartitionGauge, setValueOfTableGauge

Methods inherited from class java.lang.Object

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

Constructor Detail

BrokerMetrics

public BrokerMetrics(PinotMetricsRegistry metricsRegistry)

Constructs the broker metrics.

Parameters:

metricsRegistry - The metric registry used to register timers and meters.

BrokerMetrics

public BrokerMetrics(PinotMetricsRegistry metricsRegistry,
                     boolean isTableLevelMetricsEnabled,
                     Collection<String> allowedTables)

BrokerMetrics

public BrokerMetrics(String prefix,
                     PinotMetricsRegistry metricsRegistry,
                     boolean isTableLevelMetricsEnabled,
                     Collection<String> allowedTables)

Method Detail

getQueryPhases

protected BrokerQueryPhase[] getQueryPhases()

Specified by:

getQueryPhases in class AbstractMetrics<BrokerQueryPhase,BrokerMeter,BrokerGauge,BrokerTimer>

getMeters

protected BrokerMeter[] getMeters()

Specified by:

getMeters in class AbstractMetrics<BrokerQueryPhase,BrokerMeter,BrokerGauge,BrokerTimer>

getGauges

protected BrokerGauge[] getGauges()

Specified by:

getGauges in class AbstractMetrics<BrokerQueryPhase,BrokerMeter,BrokerGauge,BrokerTimer>