metricsMessage QML Value Type

A generic metrics message providing statistics for measurements from different sources. For example, measure a system's CPU % for a given window yields the following data points over a window of time:. More...

Properties

• measurementSourceName : string
• metricsSource : string
• statistics : list<statisticDataPoint>
• unit : string
• windowStart : time
• windowStop : time

Detailed Description

• average cpu %
• std deviation
• min
• max
• sample count

These are all represented as different 'StatisticDataPoint's.

metricsMessage is a structured value type usable in QML. It maps directly to the statistics_msgs::msg::MetricsMessage ROS 2 message type.

Construct a metricsMessage in QML by assigning a JavaScript object whose keys are its component properties, or by setting those properties individually.

See also MetricsMessagePublisher and MetricsMessageSubscriber.

Property Documentation

measurementSourceName : string

Name metric measurement source, e.g., node, topic, or process name

metricsSource : string

Name of the metric being measured, e.g. cpu_percentage, free_memory_mb, message_age, etc.

statistics : list<statisticDataPoint>

A list of statistics data point, defined in StatisticDataPoint.msg

unit : string

Unit of measure of the metric, e.g. percent, mb, seconds, etc.

windowStart : time

Measurement window start time

windowStop : time

Measurement window end time