NES::Monitoring::MonitoringPlan Class Reference

The MonitoringPlan is a config class to represent what metrics shall be collected and how. More...

#include <MonitoringPlan.hpp>

Public Member Functions
bool	addMetric (MetricType metric)
	Add a specific metric to the plan. More...
bool	hasMetric (MetricType metric) const
	Checks if a metric is part of the MonitoringPlan. More...
std::string	toString () const
	Returns a string representation of the plan. More...
const std::set< MetricType > &	getMetricTypes () const
	Returns the MetricType objects that represent the plan. More...
const std::set< MetricCollectorType >	getCollectorTypes () const
	Returns the MetricType objects that represent the plan. More...

Static Public Member Functions
static MonitoringPlanPtr	create (const std::set< MetricType > &metrics)
static MonitoringPlanPtr	defaultPlan ()
static std::set< MetricCollectorType >	defaultCollectors ()
	Returns the default collectors of the plan. More...

Friends
std::ostream &	operator<< (std::ostream &, const MonitoringPlan &)

Detailed Description

The MonitoringPlan is a config class to represent what metrics shall be collected and how.

Member Function Documentation

addMetric()

bool NES::Monitoring::MonitoringPlan::addMetric

(

MetricType

metric

)

Add a specific metric to the plan.

Parameters

metric

create()

MonitoringPlanPtr NES::Monitoring::MonitoringPlan::create ( const std::set< MetricType > &  metrics )

static

defaultCollectors()

std::set< MetricCollectorType > NES::Monitoring::MonitoringPlan::defaultCollectors ( )

static

Returns the default collectors of the plan.

Returns

A set of collectors.

defaultPlan()

MonitoringPlanPtr NES::Monitoring::MonitoringPlan::defaultPlan ( )

static

Referenced by NES::Monitoring::MonitoringManager::getMonitoringPlan(), and NES::TEST_F().

Here is the caller graph for this function:

getCollectorTypes()

const std::set< MetricCollectorType > NES::Monitoring::MonitoringPlan::getCollectorTypes

(

)

const

Returns the MetricType objects that represent the plan.

Returns

A set of metric type objects.

getMetricTypes()

const std::set< MetricType > & NES::Monitoring::MonitoringPlan::getMetricTypes

(

)

const

Returns the MetricType objects that represent the plan.

Returns

A set of metric type objects.

hasMetric()

bool NES::Monitoring::MonitoringPlan::hasMetric

(

MetricType

metric

)

const

Checks if a metric is part of the MonitoringPlan.

Parameters

metric

Returns

true if contained, else false

toString()

std::string NES::Monitoring::MonitoringPlan::toString

(

)

const

Returns a string representation of the plan.

Returns

The string representation

Friends And Related Function Documentation

operator<<

std::ostream& operator<< ( std::ostream &  strm, const MonitoringPlan &  plan  )

friend

---

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

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