NES::Monitoring::CpuCollector Class Reference

#include <CpuCollector.hpp>

Collaboration diagram for NES::Monitoring::CpuCollector:

Public Member Functions
	CpuCollector ()
bool	fillBuffer (Runtime::TupleBuffer &tupleBuffer) override
	Fill a buffer with a given metric. More...
MetricCollectorType	getType () override
	Returns the type of metric collector. More...
SchemaPtr	getSchema () override
	Return the schema representing the metrics gathered by the collector. More...
const MetricPtr	readMetric () const override
	Read the CPU metrics based on the underlying utility systems reader and return the metrics. More...
Public Member Functions inherited from NES::Monitoring::MetricCollector
virtual	~MetricCollector ()=default
WorkerId	getWorkerId () const
void	setNodeId (const WorkerId nodeId)

Additional Inherited Members
Protected Member Functions inherited from NES::Monitoring::MetricCollector
	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 class for CPU metrics. Metric collectors are required for the integration with data sources.

Constructor & Destructor Documentation

CpuCollector()

NES::Monitoring::CpuCollector::CpuCollector ( )

explicit

References NES_INFO.

Member Function Documentation

fillBuffer()

bool NES::Monitoring::CpuCollector::fillBuffer ( Runtime::TupleBuffer &  tupleBuffer )

overridevirtual

Fill a buffer with a given metric.

Parameters

tupleBuffer

The tuple buffer

Returns

True if successful, else false

Implements NES::Monitoring::MetricCollector.

References NES::Monitoring::asJson(), NES::Monitoring::MetricCollector::getWorkerId(), NES_ERROR, NES_TRACE, NES::Monitoring::CpuMetricsWrapper::setNodeId(), and NES::Monitoring::writeToBuffer().

Here is the call graph for this function:

getSchema()

SchemaPtr NES::Monitoring::CpuCollector::getSchema ( )

overridevirtual

Return the schema representing the metrics gathered by the collector.

Returns

The schema

Implements NES::Monitoring::MetricCollector.

getType()

MetricCollectorType NES::Monitoring::CpuCollector::getType ( )

overridevirtual

Returns the type of metric collector.

Returns

the metric collector type

Implements NES::Monitoring::MetricCollector.

References NES::Monitoring::CPU_COLLECTOR.

readMetric()

const MetricPtr NES::Monitoring::CpuCollector::readMetric ( ) const

overridevirtual

Read the CPU metrics based on the underlying utility systems reader and return the metrics.

Returns

The metrics object

Implements NES::Monitoring::MetricCollector.

References NES::Monitoring::MetricCollector::getWorkerId(), backward::details::move(), NES::Monitoring::CpuMetricsWrapper::setNodeId(), and NES::Monitoring::WrappedCpuMetrics.

Here is the call graph for this function:

---

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

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