org.apache.hadoop.metrics2

接口 MetricsSystem

所有超级接口:

MetricsSystemMXBean

所有已知实现类:

DefaultMetricsSystem, MetricsSystemImpl

public interface MetricsSystem
extends MetricsSystemMXBean

The metrics system interface

嵌套类概要

嵌套类

限定符和类型	接口和说明
static class	MetricsSystem.AbstractCallback Convenient abstract class for implementing callback interface
static interface	MetricsSystem.Callback The metrics system callback interface

方法概要

方法

限定符和类型	方法和说明
void	publishMetricsNow() Requests an immediate publish of all metrics from sources to sinks.
void	register(MetricsSystem.Callback callback) Register a callback interface for JMX events
<T extends MetricsSink> T	register(String name, String desc, T sink) Register a metrics sink
<T extends MetricsSource> T	register(String name, String desc, T source) Register a metrics source
void	shutdown() Shutdown the metrics system completely (usually during server shutdown.)

从接口继承的方法 org.apache.hadoop.metrics2.MetricsSystemMXBean

currentConfig, refreshMBeans, start, stop

方法详细资料

register

<T extends MetricsSource> T register(String name,
                                   String desc,
                                   T source)

Register a metrics source

类型参数:

T - the type of the source

参数:

source - to register

name - of the source. Must be unique.

desc - the description of the source.

返回:

the source

抛出:

MetricsException

register

<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

void register(MetricsSystem.Callback callback)

Register a callback interface for JMX events

参数:

callback - the callback object implementing the MBean interface.

publishMetricsNow

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

void shutdown()

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