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

Interface for collecting the metrics. More...

Inherits IEnumerable< IMetricsRecordBuilder >.

Inherited by Org.Apache.REEF.Common.Metrics.MetricsSystem.IMetricsCollectorMutable.

Public Member Functions
IMetricsRecordBuilder	CreateRecord (string name)
	Creates a metric record by name. More...
IMetricsRecordBuilder	CreateRecord (IMetricsInfo info)
	Creates a metric record by meta-data info. More...
IEnumerable< IMetricsRecord >	GetRecords ()
	Creates record from underlying collection of IMetricsRecordBuilder More...

Detailed Description

Interface for collecting the metrics.

This interface is passed to the IMetricsSource to add and fill in the records.

Member Function Documentation

CreateRecord() [1/2]

IMetricsRecordBuilder Org.Apache.REEF.Common.Metrics.Api.IMetricsCollector.CreateRecord

(

string

name

)

Creates a metric record by name.

The exact semantics of what to do if another record of same name exists - (create another with same name, return existing one, or throw exception) is left to the implementation.

Parameters

name	Name of the record.

Returns

Record builder for the record.

CreateRecord() [2/2]

IMetricsRecordBuilder Org.Apache.REEF.Common.Metrics.Api.IMetricsCollector.CreateRecord

(

IMetricsInfo

info

)

Creates a metric record by meta-data info.

The exact semantics of what to do if another record of same name exists - (create another with same name, return existing one, or throw exception) is left to the implementation.

Parameters

info	Meta-data info of the record.

Returns

Record builder for the record.

GetRecords()

IEnumerable<IMetricsRecord> Org.Apache.REEF.Common.Metrics.Api.IMetricsCollector.GetRecords

(

)

Creates record from underlying collection of IMetricsRecordBuilder

Returns

Enumerator over records.

---

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

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