Public Member Functions | Private Attributes | List of all members
ros_monitoring_msgs::MetricManager Class Reference

Create, aggregate and publish metrics to ros topic. More...

#include <metric_manager.h>

Inheritance diagram for ros_monitoring_msgs::MetricManager:
Inheritance graph
[legend]

Public Member Functions

virtual void AddDimension (const std::string &name, const std::string &value) override final
 add global dimension (applies to all metrics). More...
 
virtual void AddMetric (MetricData md) override final
 add a metric to list of metrics to be published. More...
 
virtual MetricData CreateMetric () const override final
 create a metric. More...
 
 MetricManager (ros::Publisher &p)
 
virtual void Publish () override final
 publishes all metrics and then discards them. More...
 
- Public Member Functions inherited from ros_monitoring_msgs::MetricManagerInterface
virtual ~MetricManagerInterface ()
 destructor. More...
 

Private Attributes

ros_monitoring_msgs::MetricData dimensions_
 
MetricList mlist_
 
ros::Publisherpublisher_
 

Detailed Description

Create, aggregate and publish metrics to ros topic.

Definition at line 62 of file metric_manager.h.

Constructor & Destructor Documentation

◆ MetricManager()

ros_monitoring_msgs::MetricManager::MetricManager ( ros::Publisher p)
inline

Definition at line 65 of file metric_manager.h.

Member Function Documentation

◆ AddDimension()

void ros_monitoring_msgs::MetricManager::AddDimension ( const std::string &  name,
const std::string &  value 
)
finaloverridevirtual

add global dimension (applies to all metrics).

Implements ros_monitoring_msgs::MetricManagerInterface.

Definition at line 31 of file metric_manager.cpp.

◆ AddMetric()

void ros_monitoring_msgs::MetricManager::AddMetric ( MetricData  md)
finaloverridevirtual

add a metric to list of metrics to be published.

Parameters
mda metric.

Implements ros_monitoring_msgs::MetricManagerInterface.

Definition at line 40 of file metric_manager.cpp.

◆ CreateMetric()

MetricData ros_monitoring_msgs::MetricManager::CreateMetric ( ) const
finaloverridevirtual

create a metric.

Implements ros_monitoring_msgs::MetricManagerInterface.

Definition at line 22 of file metric_manager.cpp.

◆ Publish()

void ros_monitoring_msgs::MetricManager::Publish ( )
finaloverridevirtual

publishes all metrics and then discards them.

Implements ros_monitoring_msgs::MetricManagerInterface.

Definition at line 42 of file metric_manager.cpp.

Member Data Documentation

◆ dimensions_

ros_monitoring_msgs::MetricData ros_monitoring_msgs::MetricManager::dimensions_
private

Definition at line 78 of file metric_manager.h.

◆ mlist_

MetricList ros_monitoring_msgs::MetricManager::mlist_
private

Definition at line 77 of file metric_manager.h.

◆ publisher_

ros::Publisher& ros_monitoring_msgs::MetricManager::publisher_
private

Definition at line 76 of file metric_manager.h.


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


health_metric_collector
Author(s): AWS RoboMaker
autogenerated on Mon Feb 28 2022 22:27:45