Merge pull request #1745 from b-ehlers/2.2

Implement a minimum interval between cpu_percent() calls. Fixes #1738

gns3server/handlers/api/compute/project_handler.py

@@ -19,12 +19,13 @@ import aiohttp
 import asyncio
 import json
 import os
+import psutil
 import tempfile
 
 from gns3server.web.route import Route
 from gns3server.compute.project_manager import ProjectManager
 from gns3server.compute import MODULES
-from gns3server.utils.ping_stats import PingStats
+from gns3server.utils.cpu_percent import CpuPercent
 
 from gns3server.schemas.project import (
     PROJECT_OBJECT_SCHEMA,
@@ -206,7 +207,11 @@ class ProjectHandler:
 
         :returns: hash
         """
-        return {"action": "ping", "event": PingStats.get()}
+        stats = {}
+        # Non blocking call in order to get cpu usage. First call will return 0
+        stats["cpu_usage_percent"] = CpuPercent.get(interval=None)
+        stats["memory_usage_percent"] = psutil.virtual_memory().percent
+        return {"action": "ping", "event": stats}
 
     @Route.get(
         r"/projects/{project_id}/files",

gns3server/handlers/api/compute/server_handler.py

@@ -23,6 +23,7 @@ from gns3server.config import Config
 from gns3server.schemas.version import VERSION_SCHEMA
 from gns3server.schemas.server_statistics import SERVER_STATISTICS_SCHEMA
 from gns3server.compute.port_manager import PortManager
+from gns3server.utils.cpu_percent import CpuPercent
 from gns3server.version import __version__
 from aiohttp.web import HTTPConflict
 from psutil._common import bytes2human
@@ -57,7 +58,7 @@ class ServerHandler:
             swap_total = psutil.swap_memory().total
             swap_free = psutil.swap_memory().free
             swap_used = psutil.swap_memory().used
-            cpu_percent = int(psutil.cpu_percent())
+            cpu_percent = int(CpuPercent.get())
             load_average_percent = [int(x / psutil.cpu_count() * 100) for x in psutil.getloadavg()]
             memory_percent = int(psutil.virtual_memory().percent)
             swap_percent = int(psutil.swap_memory().percent)

gns3server/notification_queue.py

@@ -17,8 +17,9 @@
 
 import asyncio
 import json
+import psutil
 
-from gns3server.utils.ping_stats import PingStats
+from gns3server.utils.cpu_percent import CpuPercent
 
 
 class NotificationQueue(asyncio.Queue):
@@ -38,14 +39,24 @@ class NotificationQueue(asyncio.Queue):
         # At first get we return a ping so the client immediately receives data
         if self._first:
             self._first = False
-            return ("ping", PingStats.get(), {})
+            return ("ping", self._getPing(), {})
 
         try:
             (action, msg, kwargs) = await asyncio.wait_for(super().get(), timeout)
         except asyncio.TimeoutError:
-            return ("ping", PingStats.get(), {})
+            return ("ping", self._getPing(), {})
         return (action, msg, kwargs)
 
+    def _getPing(self):
+        """
+        Return the content of the ping notification
+        """
+        msg = {}
+        # Non blocking call in order to get cpu usage. First call will return 0
+        msg["cpu_usage_percent"] = CpuPercent.get(interval=None)
+        msg["memory_usage_percent"] = psutil.virtual_memory().percent
+        return msg
+
     async def get_json(self, timeout):
         """
         Get a message as a JSON

gns3server/utils/cpu_percent.py

@@ -0,0 +1,48 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2020 GNS3 Technologies Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+import psutil
+import time
+
+
+class CpuPercent:
+    """
+    Ensures a minumum interval between two cpu_percent() calls
+    """
+
+    _last_measurement = None		# time of last measurement
+    _last_cpu_percent = 0.0		# last cpu_percent
+
+    @classmethod
+    def get(cls, interval=None):
+        """
+        Get CPU utilization as a percentage
+
+        :returns: float
+        """
+
+        if interval:
+            cls._last_cpu_percent = psutil.cpu_percent(interval=interval)
+            cls._last_measurement = time.monotonic()
+        else:
+            cur_time = time.monotonic()
+            if cls._last_measurement is None or \
+               (cur_time - cls._last_measurement) >= 1.9:
+                cls._last_cpu_percent = psutil.cpu_percent(interval=None)
+                cls._last_measurement = cur_time
+
+        return cls._last_cpu_percent

gns3server/utils/ping_stats.py

@@ -1,58 +0,0 @@
-# -*- coding: utf-8 -*-
-#
-# Copyright (C) 2018 GNS3 Technologies Inc.
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
-
-import psutil
-import time
-
-
-class PingStats:
-    """
-    Ping messages are regularly sent to the client to keep the connection open.
-    We send with it some information about server load.
-    """
-
-    _last_measurement = 0.0		# time of last measurement
-    _last_cpu_percent = 0.0		# last cpu_percent
-    _last_mem_percent = 0.0		# last virtual_memory().percent
-
-    @classmethod
-    def get(cls):
-        """
-        Get ping statistics
-
-        :returns: hash
-        """
-        stats = {}
-        cur_time = time.time()
-        # minimum interval for getting CPU and memory statistics
-        if cur_time < cls._last_measurement or \
-           cur_time > cls._last_measurement + 1.9:
-            cls._last_measurement = cur_time
-            # Non blocking call to get cpu usage. First call will return 0
-            try:
-                cls._last_cpu_percent = psutil.cpu_percent(interval=None)
-                cls._last_mem_percent = psutil.virtual_memory().percent
-            except RuntimeError:
-                # ignore the following error:
-                # RuntimeError: host_statistics(HOST_CPU_LOAD_INFO) syscall failed: (ipc/send) invalid reply port
-                pass
-            except PermissionError:
-                # [Errno 13] Permission denied: '/proc/stat'
-                pass
-        stats["cpu_usage_percent"] = cls._last_cpu_percent
-        stats["memory_usage_percent"] = cls._last_mem_percent
-        return stats