org.apache.hadoop.metrics2.lib

枚举 DefaultMetricsSystem

java.lang.Object

java.lang.Enum<DefaultMetricsSystem>

org.apache.hadoop.metrics2.lib.DefaultMetricsSystem

所有已实现的接口:

Serializable, Comparable<DefaultMetricsSystem>, MetricsSystem, MetricsSystemMXBean

public enum DefaultMetricsSystem
extends Enum<DefaultMetricsSystem>
implements MetricsSystem

The default metrics system singleton

嵌套类概要

从接口继承的嵌套类/接口 org.apache.hadoop.metrics2.MetricsSystem

MetricsSystem.AbstractCallback, MetricsSystem.Callback

枚举常量概要

枚举常量

枚举常量和说明
INSTANCE The singleton instance

方法概要

方法

限定符和类型	方法和说明
String	currentConfig()
static MetricsSystem	initialize(String prefix) Common static convenience method to initialize the metrics system
void	publishMetricsNow() Requests an immediate publish of all metrics from sources to sinks.
void	refreshMBeans() Force a refresh of MBeans
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
static <T extends MetricsSource> T	registerSource(String name, String desc, T source) Common static method to register a source
void	shutdown() Shutdown the metrics system completely (usually during server shutdown.)
void	start() Start the metrics system
void	stop() Stop the metrics system
static DefaultMetricsSystem	valueOf(String name) 返回带有指定名称的该类型的枚举常量。
static DefaultMetricsSystem[]	values() 按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。

从类继承的方法 java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

从类继承的方法 java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

枚举常量详细资料

INSTANCE

public static final DefaultMetricsSystem INSTANCE

The singleton instance

方法详细资料

values

public static DefaultMetricsSystem[] values()

按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。该方法可用于迭代 常量, 如下所示:

for (DefaultMetricsSystem c : DefaultMetricsSystem.values())
    System.out.println(c);

valueOf

public static DefaultMetricsSystem valueOf(String name)

返回带有指定名称的该类型的枚举常量。 字符串必须与用于声明该类型的枚举常量的 标识符完全匹配。(不允许有多余 的空格字符。)

参数:

name - 要返回的枚举常量的名称。

initialize

public static MetricsSystem initialize(String prefix)

Common static convenience method to initialize the metrics system

参数:

prefix - for configuration

返回:

the metrics system instance

register

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

从接口复制的说明: MetricsSystem

Register a metrics source

指定者:

register 在接口中 MetricsSystem

类型参数:

T - the type of the source

参数:

name - of the source. Must be unique.

desc - the description of the source.

source - to register

返回:

the source

registerSource

public static <T extends MetricsSource> T registerSource(String name,
                                         String desc,
                                         T source)

Common static method to register a source

类型参数:

T - type of the source

参数:

name - of the source

desc - description

source - the source object to register

返回:

the source object

register

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

从接口复制的说明: MetricsSystem

Register a metrics sink

指定者:

register 在接口中 MetricsSystem

类型参数:

T - the type of the sink

参数:

name - of the sink. Must be unique.

desc - the description of the sink

sink - to register

返回:

the sink

register

public void register(MetricsSystem.Callback callback)

从接口复制的说明: MetricsSystem

Register a callback interface for JMX events

指定者:

register 在接口中 MetricsSystem

参数:

callback - the callback object implementing the MBean interface.

publishMetricsNow

public void publishMetricsNow()

从接口复制的说明: MetricsSystem

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.

指定者:

publishMetricsNow 在接口中 MetricsSystem

start

public void start()

从接口复制的说明: MetricsSystemMXBean

Start the metrics system

指定者:

start 在接口中 MetricsSystemMXBean

stop

public void stop()

从接口复制的说明: MetricsSystemMXBean

Stop the metrics system

指定者:

stop 在接口中 MetricsSystemMXBean

refreshMBeans

public void refreshMBeans()

从接口复制的说明: MetricsSystemMXBean

Force a refresh of MBeans

指定者:

refreshMBeans 在接口中 MetricsSystemMXBean

currentConfig

public String currentConfig()

指定者:

currentConfig 在接口中 MetricsSystemMXBean

返回:

the current config Note, avoid getConfig, as it'll turn it into an attribute, which doesn't support multiple lines in the values.

shutdown

public void shutdown()

从接口复制的说明: MetricsSystem

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

指定者:

shutdown 在接口中 MetricsSystem