Refactors RTT to Active Monitoring

Addresses #3741

Refactors RTT: rtt_utils to active_monitoring_utils

Refactors RTT: rtt_host to am_host schema name

Refactors RTT: import_active_monitoring_config.lua

Refactors RTT: active_monitoring_stats.lua

Refactors RTT: active_monitoring_stats i18n

Refactors RTT: get_active_monitoring_config.lua

Refactors RTT: get_active_monitoring_hosts

Refactors RTT: edit_active_monitoring_host

Refactors RTT: active_monitoring.lua

Refactors RTT: active_monitor

Refactors RTT: active_monitoring_utils.js

Refactors RTT: get_active_monitoring_hosts.lua fixes

Refactors RTT: last_rtt

Refactors RTT: rtt_host to am_host

scripts/plugins/active_monitoring/measurements/speedtest.lua

@@ -0,0 +1,116 @@
+--
+-- (C) 2020 - ntop.org
+--
+
+--
+-- This module implements an internet download bandwidth monitor.
+--
+
+local os_utils = require("os_utils")
+local json = require("dkjson")
+
+local do_trace = false
+local collected_results = {}
+
+-- #################################################################
+
+-- The function called periodically to send the host probes.
+-- hosts contains the list of hosts to probe, The table keys are
+-- the hosts identifiers, whereas the table values contain host information
+-- see (active_monitoring_utils.key2host for the details on such format).
+local function run_speedtest(hosts, granularity)
+   local rsp = ntop.speedtest()
+
+   if(not rsp) then
+      return
+   end
+
+   if do_trace then
+      tprint(hosts)
+   end
+
+   if do_trace then
+      print(rsp)
+   end
+
+   rsp = json.decode(rsp)
+
+   if(not rsp) then
+      return
+   end
+
+   if(rsp["download.speed"] ~= nil) then
+      local isp = nil
+      local download_mbit = rsp["download.speed"]
+      
+      if(type(rsp["client.isp"] == "string")) then
+	 isp = noHtml(rsp["client.isp"])
+      end
+
+      -- NOTE: force_host is set, only a single host will be available
+      for key, host in pairs(hosts) do
+	 collected_results[key] = {
+	    value = download_mbit,
+	    resolved_addr = isp,
+	 }
+      end
+   end
+end
+
+-- #################################################################
+
+-- The function responsible for collecting the results.
+-- It must return a table containing a list of hosts along with their retrieved
+-- measurement. The keys of the table are the host key. The values have the following format:
+--  table
+--	resolved_addr: (optional) the resolved IP address of the host
+--	value: the measurement numeric value
+local function collect_speedtest(granularity)
+   return(collected_results)
+end
+
+-- #################################################################
+
+return {
+   -- Defines a list of measurements implemented by this script.
+   -- The probing logic is implemented into the check() and collect_results().
+   --
+   -- Here is how the probing occurs:
+   --	1. The check function is called with the list of hosts to probe. Ideally this
+   --	   call should not block (e.g. should not wait for the results)
+   --	2. The active_monitoring.lua code sleeps for some seconds
+   --	3. The collect_results function is called. This should retrieve the results
+   --       for the hosts checked in the check() function and return the results.
+   --
+   -- The alerts for non-responding hosts and the RTT timeseries are automatically
+   -- generated by active_monitoring.lua . The timeseries are saved in the following schemas:
+   -- "am_host:rtt_min", "am_host:rtt_5mins", "am_host:rtt_hour".
+   measurements = {
+      {
+	 -- The unique key for the measurement
+	 key = "speedtest",
+	 -- The function called periodically to send the host probes
+	 check = run_speedtest,
+	 -- The function responsible for collecting the results
+	 collect_results = collect_speedtest,
+	 -- The granularities allowed for the probe. See supported_granularities in active_monitoring.lua
+	 granularities = { "5mins", "hour", "daily"},
+	 -- The localization string for the measurement unit (e.g. "ms", "Mbits")
+	 i18n_unit = "field_units.mbits",
+	 -- The operator to use when comparing the measurement with the threshold, "gt" for ">" or "lt" for "<".
+	 operator = "lt",
+	 -- A list of additional timeseries (the am_host:rtt_* is always shown) to show in the charts.
+	 -- See https://www.ntop.org/guides/ntopng/api/timeseries/adding_new_timeseries.html#charting-new-metrics .
+	 additional_timeseries = {},
+	 -- Js function to call to format the am_host:rtt_* chart value. See ntopng_utils.js .
+	 value_js_formatter = "fbits",
+	 -- A list of additional notes (localization strings) to show into the timeseries charts
+	 i18n_chart_notes = {},
+	 -- If set, the user cannot change the host
+	 force_host = "speedtest.net",
+      },
+   },
+
+   -- A setup function to possibly disable the plugin
+   setup = check_binary,
+}