Org.Apache.REEF.Common.Metrics.MutableMetricsLayer.IMetricsFactory Interface Reference

Factory interface to help users and IMetricsSourcecreate different types of inbuilt metrics. More...

Inherited by Org.Apache.REEF.Common.Metrics.MutableMetricsLayer.DefaultMetricsFactoryImpl.

Public Member Functions
MetricsTag	CreateTag (IMetricsInfo info, string value)
	Creates new tag More...
ICounter	CreateCounter (string name)
	Creates a counter by name. More...
ICounter	CreateCounter (string name, string desc, long initValue=0)
	Creates a counter by name and description. More...
ILongGauge	CreateLongGauge (string name)
	Creates a long gauge by name. More...
ILongGauge	CreateLongGauge (string name, string desc, long initValue=0)
	Creates a long gauge by name and description. More...
IDoubleGauge	CreateDoubleGauge (string name)
	Creates a double gauge by name. More...
IDoubleGauge	CreateDoubleGauge (string name, string desc, double initValue=0)
	Creates a double gauge by name and description. More...
IRate	CreateRateMetric (string name, string desc, bool extendedMetrics=true)
	Creates the rate metric by name and description. More...
IRate	CreateRateMetric (string name)
	Creates the rate metric by name. More...
IStat	CreateStatMetric (string name, string valueName)
	Creates stats metric by name. More...
IStat	CreateStatMetric (string name, string desc, string valueName, bool extendedMetrics=true)
	Creates the stat metric by name and description. More...

Detailed Description

Factory interface to help users and IMetricsSourcecreate different types of inbuilt metrics.

Member Function Documentation

CreateCounter() [1/2]

ICounter Org.Apache.REEF.Common.Metrics.MutableMetricsLayer.IMetricsFactory.CreateCounter

(

string

name

)

Creates a counter by name.

Description is assumed to be same as name. Initial value is assumed to be zero.

Parameters

name	Name of the counter.

Returns

Newly created counter.

CreateCounter() [2/2]

ICounter Org.Apache.REEF.Common.Metrics.MutableMetricsLayer.IMetricsFactory.CreateCounter	(	string	name,
		string	desc,
		long	initValue = 0
	)

Creates a counter by name and description.

Parameters

name	Name of the counter.
desc	Description of the counter
initValue	Initial value of the counter

Returns

Newly created counter.

CreateDoubleGauge() [1/2]

IDoubleGauge Org.Apache.REEF.Common.Metrics.MutableMetricsLayer.IMetricsFactory.CreateDoubleGauge

(

string

name

)

Creates a double gauge by name.

Description is assumed to be same as name. Initial value is assumed to be zero.

Parameters

name	Name of the gauge.

Returns

Newly created gauge.

CreateDoubleGauge() [2/2]

IDoubleGauge Org.Apache.REEF.Common.Metrics.MutableMetricsLayer.IMetricsFactory.CreateDoubleGauge	(	string	name,
		string	desc,
		double	initValue = 0
	)

Creates a double gauge by name and description.

Parameters

name	Name of the gauge.
desc	Description of the gauge
initValue	Initial value of the gauge

Returns

Newly created gauge.

CreateLongGauge() [1/2]

ILongGauge Org.Apache.REEF.Common.Metrics.MutableMetricsLayer.IMetricsFactory.CreateLongGauge

(

string

name

)

Creates a long gauge by name.

Description is assumed to be same as name. Initial value is assumed to be zero.

Parameters

name	Name of the gauge.

Returns

Newly created gauge.

CreateLongGauge() [2/2]

ILongGauge Org.Apache.REEF.Common.Metrics.MutableMetricsLayer.IMetricsFactory.CreateLongGauge	(	string	name,
		string	desc,
		long	initValue = 0
	)

Creates a long gauge by name and description.

Parameters

name	Name of the gauge.
desc	Description of the gauge
initValue	Initial value of the gauge

Returns

Newly created gauge.

CreateRateMetric() [1/2]

IRate Org.Apache.REEF.Common.Metrics.MutableMetricsLayer.IMetricsFactory.CreateRateMetric	(	string	name,
		string	desc,
		bool	extendedMetrics = true
	)

Creates the rate metric by name and description.

Parameters

name	Name of the rate
desc	Description of the rate.
extendedMetrics	if true, stdev, min, max are also generated. Otherwise only mean is computed.

Returns

Newly created rate

CreateRateMetric() [2/2]

IRate Org.Apache.REEF.Common.Metrics.MutableMetricsLayer.IMetricsFactory.CreateRateMetric

(

string

name

)

Creates the rate metric by name.

Description is assumed to be same as name. All metrics - mean, stdev, min , max are generated.

Parameters

name	Name of the rate

Returns

Newly created rate

CreateStatMetric() [1/2]

IStat Org.Apache.REEF.Common.Metrics.MutableMetricsLayer.IMetricsFactory.CreateStatMetric	(	string	name,
		string	valueName
	)

Creates stats metric by name.

Description is assumed to be same as name. All metrics - mean, stdev, min , max are generated.

Parameters

name	Name of the rate
valueName	Value that which this metric represents (for example, Time, Latency etc.

Returns

Newly created stat.

CreateStatMetric() [2/2]

IStat Org.Apache.REEF.Common.Metrics.MutableMetricsLayer.IMetricsFactory.CreateStatMetric	(	string	name,
		string	desc,
		string	valueName,
		bool	extendedMetrics = true
	)

Creates the stat metric by name and description.

Parameters

name	Name of the rate
desc	Description of the rate.
valueName	Value that which this metric represents (for example, Time, Latency etc.
extendedMetrics	if true, stdev, min, max are also generated. Otherwise only mean is computed.

Returns

Newly created stat.

CreateTag()

MetricsTag Org.Apache.REEF.Common.Metrics.MutableMetricsLayer.IMetricsFactory.CreateTag	(	IMetricsInfo	info,
		string	value
	)

Creates new tag

Parameters

info	Meta-data of the tag.
value	Value of the tag.

Returns

The new tag.

---

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

• lang/cs/Org.Apache.REEF.Common/metrics/MutableMetricsLayer/IMetricsFactory.cs