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

Inherits IObservable< IMetricsRecord >.

Public Member Functions
void	Start ()
	(Re)Start the whole Metrics system. More...
void	Stop ()
	Stop the metrics system. More...
IMetricsSource	RegisterSource (string name, string desc, IMetricsSource source)
	Register the metrics source. More...
void	UnRegisterSource (string name)
	Unregister the metrics source. More...
IMetricsSource	GetSource (string name)
	Gets the metrics source. More...
void	PublishMetricsNow ()
	Requests an immediate publish of all metrics from sources to sinks. More...
bool	ShutDown ()
	Completely shuts down the metrics system. More...

Member Function Documentation

GetSource()

IMetricsSource Org.Apache.REEF.Common.Metrics.Api.IMetricsSystem.GetSource

(

string

name

)

Gets the metrics source.

Parameters

name	Name of the metrics source.

Returns

Metrics source.

PublishMetricsNow()

void Org.Apache.REEF.Common.Metrics.Api.IMetricsSystem.PublishMetricsNow

(

)

Requests an immediate publish of all metrics from sources to sinks.

Best effort will be done to push metrics from source to sink synchronously before returning. However, if it cannot be done in reasonable time it is ok to return to the caller before everything is done.

RegisterSource()

IMetricsSource Org.Apache.REEF.Common.Metrics.Api.IMetricsSystem.RegisterSource	(	string	name,
		string	desc,
		IMetricsSource	source
	)

Register the metrics source.

Parameters

name	Name of the source. Must be unique.
desc	Description of the source.
source	Metrics source to register.

Returns

Metrics source

ShutDown()

bool Org.Apache.REEF.Common.Metrics.Api.IMetricsSystem.ShutDown

(

)

Completely shuts down the metrics system.

Returns

True if proper shutdown happened.

Start()

void Org.Apache.REEF.Common.Metrics.Api.IMetricsSystem.Start

(

)

(Re)Start the whole Metrics system.

This along with Stop can be called multiple times to start and stop the metrics system. Exact logic of what to do if function is called multiple times before Stop is called is left to the underlying implementation.

Stop()

void Org.Apache.REEF.Common.Metrics.Api.IMetricsSystem.Stop

(

)

Stop the metrics system.

The system can be started and stopped again. Exact logic of what to do if function is called multiple times before Start is called is left to the underlying implementation.

UnRegisterSource()

void Org.Apache.REEF.Common.Metrics.Api.IMetricsSystem.UnRegisterSource

(

string

name

)

Unregister the metrics source.

Parameters

name	Name of the source.

---

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

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