NES::Monitoring::MetricCollector Class Reference

#include <MetricCollector.hpp>

Public Member Functions
virtual	~MetricCollector ()=default
virtual MetricCollectorType	getType ()=0
	Returns the type of metric collector. More...
virtual bool	fillBuffer (Runtime::TupleBuffer &tupleBuffer)=0
	Fill a buffer with a given metric. More...
virtual SchemaPtr	getSchema ()=0
	Return the schema representing the metrics gathered by the collector. More...
virtual const MetricPtr	readMetric () const =0
	Fill a buffer with a given metric. More...
WorkerId	getWorkerId () const
void	setNodeId (const WorkerId nodeId)

Protected Member Functions
	MetricCollector ()
	MetricCollector (WorkerId workerId)
	MetricCollector (const MetricCollector &)=default
	MetricCollector (MetricCollector &&)=default
MetricCollector &	operator= (const MetricCollector &)=default
MetricCollector &	operator= (MetricCollector &&)=default

Detailed Description

The metric collector base class. Metric collectors are required for the integration with data sources.

Constructor & Destructor Documentation

MetricCollector() [1/4]

NES::Monitoring::MetricCollector::MetricCollector ( )

protected

MetricCollector() [2/4]

NES::Monitoring::MetricCollector::MetricCollector ( WorkerId  workerId )

protected

MetricCollector() [3/4]

NES::Monitoring::MetricCollector::MetricCollector ( const MetricCollector &  )

protecteddefault

MetricCollector() [4/4]

NES::Monitoring::MetricCollector::MetricCollector ( MetricCollector &&  )

protecteddefault

~MetricCollector()

virtual NES::Monitoring::MetricCollector::~MetricCollector ( )

virtualdefault

Member Function Documentation

fillBuffer()

virtual bool NES::Monitoring::MetricCollector::fillBuffer ( Runtime::TupleBuffer &  tupleBuffer )

pure virtual

Fill a buffer with a given metric.

Parameters

tupleBuffer

The tuple buffer

Returns

True if successful, else false

Implemented in NES::Monitoring::NetworkCollector, NES::Monitoring::MemoryCollector, NES::Monitoring::DiskCollector, and NES::Monitoring::CpuCollector.

getSchema()

virtual SchemaPtr NES::Monitoring::MetricCollector::getSchema ( )

pure virtual

Return the schema representing the metrics gathered by the collector.

Returns

The schema

Implemented in NES::Monitoring::NetworkCollector, NES::Monitoring::MemoryCollector, NES::Monitoring::DiskCollector, and NES::Monitoring::CpuCollector.

getType()

virtual MetricCollectorType NES::Monitoring::MetricCollector::getType ( )

pure virtual

Returns the type of metric collector.

Returns

the metric collector type

Implemented in NES::Monitoring::NetworkCollector, NES::Monitoring::MemoryCollector, NES::Monitoring::DiskCollector, and NES::Monitoring::CpuCollector.

getWorkerId()

WorkerId NES::Monitoring::MetricCollector::getWorkerId

(

)

const

Getter for workerId

Returns

the workerId

Referenced by NES::Monitoring::CpuCollector::fillBuffer(), NES::Monitoring::DiskCollector::fillBuffer(), NES::Monitoring::MemoryCollector::fillBuffer(), NES::Monitoring::NetworkCollector::fillBuffer(), NES::Monitoring::CpuCollector::readMetric(), NES::Monitoring::DiskCollector::readMetric(), NES::Monitoring::MemoryCollector::readMetric(), and NES::Monitoring::NetworkCollector::readMetric().

Here is the caller graph for this function:

operator=() [1/2]

MetricCollector& NES::Monitoring::MetricCollector::operator= ( const MetricCollector &  )

protecteddefault

operator=() [2/2]

MetricCollector& NES::Monitoring::MetricCollector::operator= ( MetricCollector &&  )

protecteddefault

readMetric()

virtual const MetricPtr NES::Monitoring::MetricCollector::readMetric ( ) const

pure virtual

Fill a buffer with a given metric.

Parameters

tupleBuffer

The tuple buffer

Returns

True if successful, else false

Implemented in NES::Monitoring::NetworkCollector, NES::Monitoring::MemoryCollector, NES::Monitoring::DiskCollector, and NES::Monitoring::CpuCollector.

setNodeId()

void NES::Monitoring::MetricCollector::setNodeId

(

const WorkerId

nodeId

)

Setter for nodeId

Parameters

NodeId

References nodeId.

---

The documentation for this class was generated from the following files:

• /nebulastream/nes-runtime/include/Monitoring/MetricCollectors/MetricCollector.hpp
• /nebulastream/nes-runtime/src/Monitoring/MetricCollectors/MetricCollector.cpp