Skip to content

Host Monitor

This class collects CPU, RAM, ROM, and bandwidth usage metrics at a predefined interval for each "vHost" in the simulation. It enables you to monitor the resource utilization of individual hosts over time.

HostMonitor

Source code in PyCloudSim\monitor\host_monitor.py 
 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
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
class HostMonitor:
    _monitored_hosts: Union[PhysicalEntity, List[PhysicalEntity]]
    _df: pd.DataFrame

    def __init__(
        self,
        monitored_host: Optional[PhysicalEntity | List[PhysicalEntity]] = None,
        monitor_interval: Union[int, float] = 0.01,
    ) -> None:
        """Host monitor.

        Args:
            monitored_host (Optional[PhysicalEntity  |  List[PhysicalEntity]], optional): if none, all simulated physical entity will be monitored. Defaults to None.
            monitor_interval (Union[int, float], optional): the sampling interval. Defaults to 0.01.
        """        
        if monitored_host is None:
            self._monitored_hosts = []
            self._monitored_hosts.extend(simulation.HOSTS)
            self._monitored_hosts.extend(simulation.SWITCHES)
            self._monitored_hosts.extend(simulation.ROUTERS)
        else:
            self._monitored_hosts = monitored_host
        self._monitor_interval = monitor_interval

        self._df = pd.DataFrame(
            {
                "host_id": pd.Series(dtype="str"),
                "host_label": pd.Series(dtype="str"),
                "time": pd.Series(dtype="float"),
                "cpu_util": pd.Series(dtype="float"),
                "ram_util": pd.Series(dtype="float"),
                "rom_util": pd.Series(dtype="float"),
                "bw_in_util": pd.Series(dtype="float"),
                "bw_out_util": pd.Series(dtype="float"),
                "num_containers": pd.Series(dtype="int"),
                "num_processes": pd.Series(dtype="int"),
                "power_usage": pd.Series(dtype="float"),
            }
        )

        self._process = Actor(
            at=0,
            step=self.monitor_interval,
            action=self.action,
            priority=MONITOR_PRIORITY,
            label="Host Monitor",
        )

    def action(self):
        """Telemetries collection.
        """
        if isinstance(self._monitored_hosts, list):
            for host in self._monitored_hosts:
                if host.created:
                    host_telemetry = pd.DataFrame(
                        {
                            "host_id": str(host.id),
                            "host_label": host.label,
                            "time": float(simulation.now),
                            "cpu_util": host.cpu.utilization_in_past(
                                self.monitor_interval
                            ),
                            "ram_util": host.ram.utilization_in_past(
                                self.monitor_interval
                            ),
                            "rom_util": host.rom.utilization_in_past(
                                self.monitor_interval
                            ),
                            "bw_in_util": host.uplink_utilization(
                                self.monitor_interval
                            ),
                            "bw_out_util": host.downlink_utilization(
                                self.monitor_interval
                            ),
                            "num_containers": len(host.containers)
                            if type(host) == vHost
                            else 0,
                            "num_processes": len(host.processes),
                            "power_usage": host.power_usage(self.monitor_interval),
                        },
                        index=[0],
                    )
                    self._df = pd.concat([self._df, host_telemetry], ignore_index=True)
        elif isinstance(self.monitored_hosts, vHost):
            if self.monitored_hosts.created:
                host_telemetry = pd.DataFrame(
                    {
                        "host_id": str(self.monitored_hosts.id),
                        "host_label": self.monitored_hosts.label,
                        "time": float(simulation.now),
                        "cpu_util": self.monitored_hosts.cpu.utilization_in_past(
                            self.monitor_interval
                        ),
                        "ram_util": self.monitored_hosts.ram.utilization_in_past(
                            self.monitor_interval
                        ),
                        "rom_util": self.monitored_hosts.rom.utilization_in_past(
                            self.monitor_interval
                        ),
                        "bw_in_util": self.monitored_hosts.uplink_utilization(
                            self.monitor_interval
                        ),
                        "bw_out_util": self.monitored_hosts.downlink_utilization(
                            self.monitor_interval
                        ),
                        "num_containers": len(self.monitored_hosts.containers)
                        if type(self.monitored_hosts) == vHost
                        else 0,
                        "num_processes": len(self.monitored_hosts.processes),
                        "power_usage": self.monitored_hosts.power_usage(
                            self.monitor_interval
                        ),
                    },
                    index=[0],
                )
                self._df = pd.concat([self._df, host_telemetry], ignore_index=True)

    @property
    def df(self):
        """The pandas dataframe containing the telemetry data."""
        return self._df

    @property
    def monitored_hosts(self):
        """The monitored hosts."""
        return self._monitored_hosts

    @property
    def monitor_interval(self) -> Union[int, float]:
        """The sampling interval."""
        return self._monitor_interval

df property

The pandas dataframe containing the telemetry data.

monitor_interval: Union[int, float] property

The sampling interval.

monitored_hosts property

The monitored hosts.

__init__(monitored_host=None, monitor_interval=0.01)

Host monitor.

Parameters:

Name Type Description Default
monitored_host Optional[PhysicalEntity | List[PhysicalEntity]]

if none, all simulated physical entity will be monitored. Defaults to None.

 None
monitor_interval Union[int, float]

the sampling interval. Defaults to 0.01.

 0.01
Source code in PyCloudSim\monitor\host_monitor.py 
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
def __init__(
    self,
    monitored_host: Optional[PhysicalEntity | List[PhysicalEntity]] = None,
    monitor_interval: Union[int, float] = 0.01,
) -> None:
    """Host monitor.

    Args:
        monitored_host (Optional[PhysicalEntity  |  List[PhysicalEntity]], optional): if none, all simulated physical entity will be monitored. Defaults to None.
        monitor_interval (Union[int, float], optional): the sampling interval. Defaults to 0.01.
    """        
    if monitored_host is None:
        self._monitored_hosts = []
        self._monitored_hosts.extend(simulation.HOSTS)
        self._monitored_hosts.extend(simulation.SWITCHES)
        self._monitored_hosts.extend(simulation.ROUTERS)
    else:
        self._monitored_hosts = monitored_host
    self._monitor_interval = monitor_interval

    self._df = pd.DataFrame(
        {
            "host_id": pd.Series(dtype="str"),
            "host_label": pd.Series(dtype="str"),
            "time": pd.Series(dtype="float"),
            "cpu_util": pd.Series(dtype="float"),
            "ram_util": pd.Series(dtype="float"),
            "rom_util": pd.Series(dtype="float"),
            "bw_in_util": pd.Series(dtype="float"),
            "bw_out_util": pd.Series(dtype="float"),
            "num_containers": pd.Series(dtype="int"),
            "num_processes": pd.Series(dtype="int"),
            "power_usage": pd.Series(dtype="float"),
        }
    )

    self._process = Actor(
        at=0,
        step=self.monitor_interval,
        action=self.action,
        priority=MONITOR_PRIORITY,
        label="Host Monitor",
    )

action()

Telemetries collection.

Source code in PyCloudSim\monitor\host_monitor.py 
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
def action(self):
    """Telemetries collection.
    """
    if isinstance(self._monitored_hosts, list):
        for host in self._monitored_hosts:
            if host.created:
                host_telemetry = pd.DataFrame(
                    {
                        "host_id": str(host.id),
                        "host_label": host.label,
                        "time": float(simulation.now),
                        "cpu_util": host.cpu.utilization_in_past(
                            self.monitor_interval
                        ),
                        "ram_util": host.ram.utilization_in_past(
                            self.monitor_interval
                        ),
                        "rom_util": host.rom.utilization_in_past(
                            self.monitor_interval
                        ),
                        "bw_in_util": host.uplink_utilization(
                            self.monitor_interval
                        ),
                        "bw_out_util": host.downlink_utilization(
                            self.monitor_interval
                        ),
                        "num_containers": len(host.containers)
                        if type(host) == vHost
                        else 0,
                        "num_processes": len(host.processes),
                        "power_usage": host.power_usage(self.monitor_interval),
                    },
                    index=[0],
                )
                self._df = pd.concat([self._df, host_telemetry], ignore_index=True)
    elif isinstance(self.monitored_hosts, vHost):
        if self.monitored_hosts.created:
            host_telemetry = pd.DataFrame(
                {
                    "host_id": str(self.monitored_hosts.id),
                    "host_label": self.monitored_hosts.label,
                    "time": float(simulation.now),
                    "cpu_util": self.monitored_hosts.cpu.utilization_in_past(
                        self.monitor_interval
                    ),
                    "ram_util": self.monitored_hosts.ram.utilization_in_past(
                        self.monitor_interval
                    ),
                    "rom_util": self.monitored_hosts.rom.utilization_in_past(
                        self.monitor_interval
                    ),
                    "bw_in_util": self.monitored_hosts.uplink_utilization(
                        self.monitor_interval
                    ),
                    "bw_out_util": self.monitored_hosts.downlink_utilization(
                        self.monitor_interval
                    ),
                    "num_containers": len(self.monitored_hosts.containers)
                    if type(self.monitored_hosts) == vHost
                    else 0,
                    "num_processes": len(self.monitored_hosts.processes),
                    "power_usage": self.monitored_hosts.power_usage(
                        self.monitor_interval
                    ),
                },
                index=[0],
            )
            self._df = pd.concat([self._df, host_telemetry], ignore_index=True)