org.apache.hadoop.metrics.spi

类 AbstractMetricsContext

java.lang.Object

org.apache.hadoop.metrics.spi.AbstractMetricsContext

所有已实现的接口:

MetricsContext

直接已知子类:

CompositeContext, FileContext, GangliaContext, NoEmitMetricsContext, NullContext, NullContextWithUpdateThread

已过时。

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

@Deprecated
@InterfaceAudience.Public
@InterfaceStability.Evolving
public abstract class AbstractMetricsContext
extends Object
implements MetricsContext

The main class of the Service Provider Interface. This class should be extended in order to integrate the Metrics API with a specific metrics client library.

This class implements the internal table of metric data, and the timer on which data is to be sent to the metrics system. Subclasses must override the abstract emitRecord method in order to transmit the data.

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	AbstractMetricsContext.MetricMap 已过时。
static class	AbstractMetricsContext.TagMap 已过时。

字段概要

从接口继承的字段 org.apache.hadoop.metrics.MetricsContext

DEFAULT_PERIOD

构造器概要

构造器

限定符	构造器和说明
protected	AbstractMetricsContext() 已过时。 Creates a new instance of AbstractMetricsContext

方法概要

方法

限定符和类型	方法和说明
void	close() 已过时。 Stops monitoring and frees buffered data, returning this object to its initial state.
MetricsRecord	createRecord(String recordName) 已过时。 Creates a new AbstractMetricsRecord instance with the given recordName.
protected abstract void	emitRecord(String contextName, String recordName, OutputRecord outRec) 已过时。 Sends a record to the metrics system.
protected void	flush() 已过时。 Called each period after all records have been emitted, this method does nothing.
Map<String,Collection<OutputRecord>>	getAllRecords() 已过时。 Retrieves all the records managed by this MetricsContext.
protected String	getAttribute(String attributeName) 已过时。 Convenience method for subclasses to access factory attributes.
protected Map<String,String>	getAttributeTable(String tableName) 已过时。 Returns an attribute-value map derived from the factory attributes by finding all factory attributes that begin with contextName.
ContextFactory	getContextFactory() 已过时。 Returns the factory by which this context was created.
String	getContextName() 已过时。 Returns the context name.
int	getPeriod() 已过时。 Returns the timer period.
void	init(String contextName, ContextFactory factory) 已过时。 Initializes the context.
boolean	isMonitoring() 已过时。 Returns true if monitoring is currently in progress.
protected MetricsRecord	newRecord(String recordName) 已过时。 Subclasses should override this if they subclass MetricsRecordImpl.
protected void	parseAndSetPeriod(String attributeName) 已过时。 If a period is set in the attribute passed in, override the default with it.
void	registerUpdater(Updater updater) 已过时。 Registers a callback to be called at time intervals determined by the configuration.
protected void	remove(MetricsRecordImpl record) 已过时。 Called by MetricsRecordImpl.remove().
protected void	setPeriod(int period) 已过时。 Sets the timer period
void	startMonitoring() 已过时。 Starts or restarts monitoring, the emitting of metrics records.
void	stopMonitoring() 已过时。 Stops monitoring.
void	unregisterUpdater(Updater updater) 已过时。 Removes a callback, if it exists.
protected void	update(MetricsRecordImpl record) 已过时。 Called by MetricsRecordImpl.update().

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

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

构造器详细资料

AbstractMetricsContext

protected AbstractMetricsContext()

已过时。

Creates a new instance of AbstractMetricsContext

方法详细资料

init

public void init(String contextName,
        ContextFactory factory)

已过时。

Initializes the context.

指定者:

init 在接口中 MetricsContext

参数:

contextName - The given name for this context

factory - The creator of this context

getAttribute

protected String getAttribute(String attributeName)

已过时。

Convenience method for subclasses to access factory attributes.

getAttributeTable

protected Map<String,String> getAttributeTable(String tableName)

已过时。

Returns an attribute-value map derived from the factory attributes by finding all factory attributes that begin with contextName.tableName. The returned map consists of those attributes with the contextName and tableName stripped off.

getContextName

public String getContextName()

已过时。

Returns the context name.

指定者:

getContextName 在接口中 MetricsContext

返回:

the context name

getContextFactory

public ContextFactory getContextFactory()

已过时。

Returns the factory by which this context was created.

startMonitoring

public void startMonitoring()
                     throws IOException

已过时。

Starts or restarts monitoring, the emitting of metrics records.

指定者:

startMonitoring 在接口中 MetricsContext

抛出:

IOException

stopMonitoring

public void stopMonitoring()

已过时。

Stops monitoring. This does not free buffered data.

指定者:

stopMonitoring 在接口中 MetricsContext

另请参阅:

close()

isMonitoring

public boolean isMonitoring()

已过时。

Returns true if monitoring is currently in progress.

指定者:

isMonitoring 在接口中 MetricsContext

close

public void close()

已过时。

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

指定者:

close 在接口中 MetricsContext

createRecord

public final MetricsRecord createRecord(String recordName)

已过时。

Creates a new AbstractMetricsRecord 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.

指定者:

createRecord 在接口中 MetricsContext

参数:

recordName - the name of the record

抛出:

MetricsException - if recordName conflicts with configuration data

newRecord

protected MetricsRecord newRecord(String recordName)

已过时。

Subclasses should override this if they subclass MetricsRecordImpl.

参数:

recordName - the name of the record

返回:

newly created instance of MetricsRecordImpl or subclass

registerUpdater

public void registerUpdater(Updater updater)

已过时。

Registers a callback to be called at time intervals determined by the configuration.

指定者:

registerUpdater 在接口中 MetricsContext

参数:

updater - object to be run periodically; it should update some metrics records

unregisterUpdater

public void unregisterUpdater(Updater updater)

已过时。

Removes a callback, if it exists.

指定者:

unregisterUpdater 在接口中 MetricsContext

参数:

updater - object to be removed from the callback list

getAllRecords

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

已过时。

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

指定者:

getAllRecords 在接口中 MetricsContext

返回:

A non-null collection of all monitoring records.

emitRecord

protected abstract void emitRecord(String contextName,
              String recordName,
              OutputRecord outRec)
                            throws IOException

已过时。

Sends a record to the metrics system.

抛出:

IOException

flush

protected void flush()
              throws IOException

已过时。

Called each period after all records have been emitted, this method does nothing. Subclasses may override it in order to perform some kind of flush.

抛出:

IOException

update

protected void update(MetricsRecordImpl record)

已过时。

Called by MetricsRecordImpl.update(). Creates or updates a row in the internal table of metric data.

remove

protected void remove(MetricsRecordImpl record)

已过时。

Called by MetricsRecordImpl.remove(). Removes all matching rows in the internal table of metric data. A row matches if it has the same tag names and values as record, but it may also have additional tags.

getPeriod

public int getPeriod()

已过时。

Returns the timer period.

指定者:

getPeriod 在接口中 MetricsContext

setPeriod

protected void setPeriod(int period)

已过时。

Sets the timer period

parseAndSetPeriod

protected void parseAndSetPeriod(String attributeName)

已过时。

If a period is set in the attribute passed in, override the default with it.