v0.2.54..v0.2.55 changeset MemoryUsageChecker.cpp

diff --git a/hoot-core/src/main/cpp/hoot/core/util/MemoryUsageChecker.cpp b/hoot-core/src/main/cpp/hoot/core/util/MemoryUsageChecker.cpp
new file mode 100644
index 0000000..48d39df
--- /dev/null
+++ b/hoot-core/src/main/cpp/hoot/core/util/MemoryUsageChecker.cpp
@@ -0,0 +1,100 @@
+/*
+ * This file is part of Hootenanny.
+ *
+ * Hootenanny 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/>.
+ *
+ * --------------------------------------------------------------------
+ *
+ * The following copyright notices are generated automatically. If you
+ * have a new notice to add, please use the format:
+ * " * @copyright Copyright ..."
+ * This will properly maintain the copyright information. DigitalGlobe
+ * copyrights will be updated automatically.
+ *
+ * @copyright Copyright (C) 2020 DigitalGlobe (http://www.digitalglobe.com/)
+ */
+
+#include "MemoryUsageChecker.h"
+
+// Hoot
+#include <hoot/core/util/ConfigOptions.h>
+#include <hoot/core/util/HootException.h>
+#include <hoot/core/util/Log.h>
+
+// tgs
+#include <tgs/System/SystemInfo.h>
+
+namespace hoot
+{
+
+MemoryUsageChecker::MemoryUsageChecker()
+  : _enabled(ConfigOptions().getMemoryUsageCheckerEnabled()),
+    _notificationThreshold(0.95),
+    _loggedPhysicalMemNotification(false),
+    _loggedVirtualMemNotification(false)
+{
+  const int thresholdVal = ConfigOptions().getMemoryUsageCheckerThreshold();
+  if (thresholdVal < 1 || thresholdVal > 100)
+  {
+    //  Use the default 95% and log a warning
+    LOG_WARN("MemoryUsageChecker notification threshold must a percentage value from 1 to 100.");
+  }
+  else
+    _notificationThreshold = (double)thresholdVal / 100.0;
+}
+
+MemoryUsageChecker& MemoryUsageChecker::getInstance()
+{
+  //  Local static singleton instance
+  static MemoryUsageChecker instance;
+  return instance;
+}
+
+void MemoryUsageChecker::check()
+{
+  // Check the amount of memory available that's left in the environment (after what the OS uses,
+  // plus all running hoot jobs, etc.). If its less than the threshold, log a warning and also let
+  // the user know what percentage of the total memory their job was taking up. Only logging once so
+  // the logs don't get cluttered up for jobs whose memory consumption goes repeatedly above and
+  // below the threshold. We may end up really needing to only check physical memory but will check
+  // both it and virtual memory consumption for now.
+
+  if (_enabled && !_loggedPhysicalMemNotification &&
+      Tgs::SystemInfo::getPercentageOfPhysicalMemoryUsed() >= _notificationThreshold)
+  {
+    LOG_WARN(
+      "Total physical memory usage has exceeded a threshold of " <<
+      QString::number(_notificationThreshold * 100) << "% available. This Hootenanny process is " <<
+      "using " <<
+      QString::number(
+        Tgs::SystemInfo::getPercentageOfPhysicalMemoryUsedByCurrentProcess() * 100, 'g', 2) +
+      "% of the total available physical memory.");
+    _loggedPhysicalMemNotification = true;
+  }
+
+  if (_enabled && !_loggedVirtualMemNotification &&
+      Tgs::SystemInfo::getPercentageOfVirtualMemoryUsed() >= _notificationThreshold)
+  {
+    LOG_WARN(
+      "Total virtual memory usage has exceeded a threshold of " <<
+      QString::number(_notificationThreshold * 100) << "% available. This Hootenanny process is " <<
+      "using " <<
+      QString::number(
+        Tgs::SystemInfo::getPercentageOfVirtualMemoryUsedByCurrentProcess() * 100, 'g', 2) +
+      "% of the total available virtual memory.");
+    _loggedVirtualMemNotification = true;
+  }
+}
+
+}