This repository has been archived by the owner on Jun 10, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 8
/
linux_memory_measurement_node.hpp
67 lines (58 loc) · 2.26 KB
/
linux_memory_measurement_node.hpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
// Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#ifndef SYSTEM_METRICS_COLLECTOR__LINUX_MEMORY_MEASUREMENT_NODE_HPP_
#define SYSTEM_METRICS_COLLECTOR__LINUX_MEMORY_MEASUREMENT_NODE_HPP_
#include <chrono>
#include <string>
#include "../../src/system_metrics_collector/periodic_measurement_node.hpp"
namespace system_metrics_collector
{
/**
* Node that periodically measures the percentage of RAM used
* by a linux system. Specifically, the values used to make
* this measurement are obtained from /proc/meminfo.
*/
class LinuxMemoryMeasurementNode : public system_metrics_collector::PeriodicMeasurementNode
{
public:
/**
* Construct a LinuxMemoryMeasurementNode
* The following parameters may be set via the rclcpp::NodeOptions:
* `measurement_period`: the period of this node, used to read measurements
* `publish_period`: the period at which metrics are published
*
* @param name the name of this node
* @param options the options (arguments, parameters, etc.) for this node
*/
LinuxMemoryMeasurementNode(
const std::string & name,
const rclcpp::NodeOptions & options = rclcpp::NodeOptions{});
virtual ~LinuxMemoryMeasurementNode() = default;
protected:
/**
* Perform a periodic measurement calculating the percentage of
* RAM used. This reads and parses the /proc/meminfo file
* to calculate memory used.
*
* @return percentage of RAM used
*/
double PeriodicMeasurement() override;
/**
* Return the name to use for this metric
* @return a string of the name for this measured metric
*/
std::string GetMetricName() const override;
};
} // namespace system_metrics_collector
#endif // SYSTEM_METRICS_COLLECTOR__LINUX_MEMORY_MEASUREMENT_NODE_HPP_