Package org.apache.pinot.common.metrics

Class ServerMetrics

java.lang.Object

org.apache.pinot.common.metrics.AbstractMetrics<ServerQueryPhase,ServerMeter,ServerGauge,ServerTimer>

org.apache.pinot.common.metrics.ServerMetrics

public class ServerMetrics
extends AbstractMetrics<ServerQueryPhase,ServerMeter,ServerGauge,ServerTimer>

Utility class to centralize all metrics reporting for the Pinot server.

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
ServerMetrics(String prefix, PinotMetricsRegistry metricsRegistry, boolean isTableLevelMetricsEnabled, Collection<String> allowedTables)
ServerMetrics(PinotMetricsRegistry metricsRegistry)
ServerMetrics(PinotMetricsRegistry metricsRegistry, boolean isTableLevelMetricsEnabled, Collection<String> allowedTables)

Method Summary

Modifier and Type	Method	Description
static ServerMetrics	get()	should always call after registration
protected ServerGauge[]	getGauges()
protected ServerMeter[]	getMeters()
protected ServerQueryPhase[]	getQueryPhases()
static boolean	register(ServerMetrics serverMetrics)	register the serverMetrics onto this class, so that we don't need to pass it down as a parameter

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

ServerMetrics

public ServerMetrics(PinotMetricsRegistry metricsRegistry)

ServerMetrics

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

ServerMetrics

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

Method Detail

register

public static boolean register(ServerMetrics serverMetrics)

register the serverMetrics onto this class, so that we don't need to pass it down as a parameter

get

public static ServerMetrics get()

should always call after registration

getQueryPhases

protected ServerQueryPhase[] getQueryPhases()

Specified by:

getQueryPhases in class AbstractMetrics<ServerQueryPhase,ServerMeter,ServerGauge,ServerTimer>

getMeters

protected ServerMeter[] getMeters()

Specified by:

getMeters in class AbstractMetrics<ServerQueryPhase,ServerMeter,ServerGauge,ServerTimer>

getGauges

protected ServerGauge[] getGauges()

Specified by:

getGauges in class AbstractMetrics<ServerQueryPhase,ServerMeter,ServerGauge,ServerTimer>