org.apache.hadoop.metrics2

クラス MetricsSystem

java.lang.Object

org.apache.hadoop.metrics2.MetricsSystem

すべての実装されたインタフェース:

MetricsSystemMXBean

@InterfaceAudience.Public
 @InterfaceStability.Evolving
public abstract class MetricsSystem
extends Object
implements MetricsSystemMXBean

The metrics system interface. The following components are used for metrics.

• MetricsSource generate and update metrics information.
• MetricsSink consume the metrics information

MetricsSource and MetricsSink register with the metrics system. Implementations of MetricsSystem polls the MetricsSources periodically and pass the MetricsRecords to MetricsSink.

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
MetricsSystem()

メソッドのサマリー

修飾子とタイプ	メソッドと説明
abstract void	publishMetricsNow() Requests an immediate publish of all metrics from sources to sinks.
abstract void	register(org.apache.hadoop.metrics2.MetricsSystem.Callback callback) Register a callback interface for JMX events
abstract <T> T	register(String name, String desc, T source) Register a metrics source
abstract <T extends MetricsSink> T	register(String name, String desc, T sink) Register a metrics sink
<T> T	register(T source) Register a metrics source (deriving name and description from the object)
abstract boolean	shutdown() Shutdown the metrics system completely (usually during server shutdown.)
abstract void	unregisterSource(String name) Unregister a metrics source

クラスから継承されたメソッド java.lang.Object

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

インタフェースから継承されたメソッド org.apache.hadoop.metrics2.MetricsSystemMXBean

currentConfig, start, startMetricsMBeans, stop, stopMetricsMBeans

コンストラクタの詳細

MetricsSystem

public MetricsSystem()

メソッドの詳細

register

public abstract <T> T register(String name,
                               String desc,
                               T source)

Register a metrics source

型パラメータ:

T - the actual type of the source object

パラメータ:

source - object to register

name - of the source. Must be unique or null (then extracted from the annotations of the source object.)

desc - the description of the source (or null. See above.)

戻り値:

the source object

例外:

MetricsException

unregisterSource

public abstract void unregisterSource(String name)

Unregister a metrics source

パラメータ:

name - of the source. This is the name you use to call register()

register

public <T> T register(T source)

Register a metrics source (deriving name and description from the object)

型パラメータ:

T - the actual type of the source object

パラメータ:

source - object to register

戻り値:

the source object

例外:

MetricsException

register

public abstract <T extends MetricsSink> T register(String name,
                                                   String desc,
                                                   T sink)

Register a metrics sink

型パラメータ:

T - the type of the sink

パラメータ:

sink - to register

name - of the sink. Must be unique.

desc - the description of the sink

戻り値:

the sink

例外:

MetricsException

register

public abstract void register(org.apache.hadoop.metrics2.MetricsSystem.Callback callback)

Register a callback interface for JMX events

パラメータ:

callback - the callback object implementing the MBean interface.

publishMetricsNow

public abstract void publishMetricsNow()

Requests an immediate publish of all metrics from sources to sinks. This is a "soft" request: the expectation is that a best effort will be done to synchronously snapshot the metrics from all the sources and put them in all the sinks (including flushing the sinks) before returning to the caller. If this can't be accomplished in reasonable time it's OK to return to the caller before everything is done.

shutdown

public abstract boolean shutdown()

Shutdown the metrics system completely (usually during server shutdown.) The MetricsSystemMXBean will be unregistered.

戻り値:

true if shutdown completed