org.apache.hadoop.metrics

接口 MetricsContext

所有已知实现类:

AbstractMetricsContext, CompositeContext, FileContext, GangliaContext, GangliaContext31, NoEmitMetricsContext, NullContext, NullContextWithUpdateThread

已过时。

in favor of org.apache.hadoop.metrics2 usage.

@Deprecated
@InterfaceAudience.Private
@InterfaceStability.Evolving
public interface MetricsContext

The main interface to the metrics package.

字段概要

字段

限定符和类型	字段和说明
static int	DEFAULT_PERIOD 已过时。 Default period in seconds at which data is sent to the metrics system.

方法概要

方法

限定符和类型	方法和说明
void	close() 已过时。 Stops monitoring and also frees any buffered data, returning this object to its initial state.
MetricsRecord	createRecord(String recordName) 已过时。 Creates a new MetricsRecord instance with the given recordName.
Map<String,Collection<OutputRecord>>	getAllRecords() 已过时。 Retrieves all the records managed by this MetricsContext.
String	getContextName() 已过时。 Returns the context name.
int	getPeriod() 已过时。 Returns the timer period.
void	init(String contextName, ContextFactory factory) 已过时。 Initialize this context.
boolean	isMonitoring() 已过时。 Returns true if monitoring is currently in progress.
void	registerUpdater(Updater updater) 已过时。 Registers a callback to be called at regular time intervals, as determined by the implementation-class specific configuration.
void	startMonitoring() 已过时。 Starts or restarts monitoring, the emitting of metrics records as they are updated.
void	stopMonitoring() 已过时。 Stops monitoring.
void	unregisterUpdater(Updater updater) 已过时。 Removes a callback, if it exists.

字段详细资料

DEFAULT_PERIOD

static final int DEFAULT_PERIOD

已过时。

Default period in seconds at which data is sent to the metrics system.

另请参阅:

常量字段值

方法详细资料

init

void init(String contextName,
        ContextFactory factory)

已过时。

Initialize this context.

参数:

contextName - The given name for this context

factory - The creator of this context

getContextName

String getContextName()

已过时。

Returns the context name.

返回:

the context name

startMonitoring

void startMonitoring()
                     throws IOException

已过时。

Starts or restarts monitoring, the emitting of metrics records as they are updated.

抛出:

IOException

stopMonitoring

void stopMonitoring()

已过时。

Stops monitoring. This does not free any data that the implementation may have buffered for sending at the next timer event. It is OK to call startMonitoring() again after calling this.

另请参阅:

close()

isMonitoring

boolean isMonitoring()

已过时。

Returns true if monitoring is currently in progress.

close

void close()

已过时。

Stops monitoring and also frees any buffered data, returning this object to its initial state.

createRecord

MetricsRecord createRecord(String recordName)

已过时。

Creates a new MetricsRecord instance with the given recordName. Throws an exception if the metrics implementation is configured with a fixed set of record names and recordName is not in that set.

参数:

recordName - the name of the record

抛出:

MetricsException - if recordName conflicts with configuration data

registerUpdater

void registerUpdater(Updater updater)

已过时。

Registers a callback to be called at regular time intervals, as determined by the implementation-class specific configuration.

参数:

updater - object to be run periodically; it should updated some metrics records and then return

unregisterUpdater

void unregisterUpdater(Updater updater)

已过时。

Removes a callback, if it exists.

参数:

updater - object to be removed from the callback list

getPeriod

int getPeriod()

已过时。

Returns the timer period.

getAllRecords

Map<String,Collection<OutputRecord>> getAllRecords()

已过时。

Retrieves all the records managed by this MetricsContext. Useful for monitoring systems that are polling-based.

返回:

A non-null map from all record names to the records managed.