Org.Apache.REEF.Common.Metrics.Api.IMetricsVisitor Interface Reference

Metrics visitor interface. More...

Public Member Functions
void	Gauge (IMetricsInfo info, long value)
	Callback for long value gauges More...
void	Gauge (IMetricsInfo info, double value)
	Callback for double value gauges More...
void	Counter (IMetricsInfo info, long value)
	Callback for long value counter More...

Detailed Description

Metrics visitor interface.

The visitor is used to extract metric specific information from the immutable metrics where specfic information is lost. For example, IImmutableMetric loses any information about the derived class but provides a function that takes IMetricsVisitor as input. The specific implementations can then call the appropriate call back functions below that then allows visitor to take appropriate action. This interface can for example be used by observers of IMetricsRecord to get specific information about metrics when it receives the record.

Member Function Documentation

Counter()

void Org.Apache.REEF.Common.Metrics.Api.IMetricsVisitor.Counter	(	IMetricsInfo	info,
		long	value
	)

Callback for long value counter

Parameters

info	Meta-data of the metric.
value	Long value of the counter.

Gauge() [1/2]

void Org.Apache.REEF.Common.Metrics.Api.IMetricsVisitor.Gauge	(	IMetricsInfo	info,
		long	value
	)

Callback for long value gauges

Parameters

info	Meta-data of the metric.
value	Long value of the gauge.

Gauge() [2/2]

void Org.Apache.REEF.Common.Metrics.Api.IMetricsVisitor.Gauge	(	IMetricsInfo	info,
		double	value
	)

Callback for double value gauges

Parameters

info	Meta-data of the metric.
value	Double value of the gauge.

---

The documentation for this interface was generated from the following file:

• lang/cs/Org.Apache.REEF.Common/metrics/Api/IMetricsVisitor.cs