ntopng/scripts/plugins/active_monitoring/measurements/cicmp.lua

--
-- (C) 2020 - ntop.org
--

--
-- This module implements the ICMP probe.
--

local ts_utils = require("ts_utils_core")

local do_trace = false

-- #################################################################

-- This is the script state, which must be manually cleared in the check
-- function. Can be then used in the collect_results function to match the
-- probe requests with probe replies.
local am_hosts = {}
local resolved_hosts = {}

-- #################################################################

-- 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 (am_utils.key2host for the details on such format).
local function check_icmp_continuous(hosts, granularity)
  local plugins_utils = require("plugins_utils")
  local am_utils = plugins_utils.loadModule("active_monitoring", "am_utils")

  am_hosts = {}
  resolved_hosts = {}

  for key, host in pairs(hosts) do
    local domain_name = host.host
    local is_v6 = (host.measurement == "icmp6")
    local ip_address = am_utils.resolveHost(domain_name, is_v6)

    if not ip_address then
      goto continue
    end

    if do_trace then
      print("[ActiveMonitoring] Pinging "..ip_address.."/"..domain_name.."\n")
    end

    -- ICMP results are retrieved in batch (see below ntop.collectPingResults)
    ntop.pingHost(ip_address, is_v6, true --[[ continuous ICMP]])

    am_hosts[ip_address] = {
      key = key,
      info = host,
    }
    resolved_hosts[key] = {
      resolved_addr = ip_address,
    }

    ::continue::
  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: (optional) the measurement numeric value. If unspecified, the host is still considered unreachable.
local function collect_icmp_continuous(granularity)
  -- Collect possible ICMP results
  local res = ntop.collectPingResults(true --[[ continuous ICMP]])

  for host, measurement in pairs(res or {}) do
    local h = am_hosts[host]

    if(do_trace) then
      print("[ActiveMonitoring] Reading ICMP response for host ".. host .."\n")
    end

    if h and resolved_hosts[h.key] then
      -- Report the host as reachable with its measurement value
      resolved_hosts[h.key].value = measurement.response_rate

      if((measurement.min_rtt ~= nil) and (measurement.max_rtt ~= nil)) then
        ts_utils.append("am_host:cicmp_stats_" .. granularity, {
          ifid = getSystemInterfaceId(),
          host = h.info.host,
          metric = h.info.measurement,
          min_rtt = measurement.min_rtt,
          max_rtt = measurement.max_rtt,
        })
      end
    end
  end

  -- NOTE: unreachable hosts can still be reported in order to properly
  -- display their resolved address
  return resolved_hosts
end

-- #################################################################

local function check_icmp_available()
  return(ntop.isPingAvailable())
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 Active Monitoring timeseries are automatically
  -- generated by active_monitoring.lua . The timeseries are saved in the following schemas:
  -- "am_host:val_min", "am_host:val_5mins", "am_host:val_hour".
  measurements = {
    {
      -- The unique key for the measurement
      key = "cicmp",
      -- The localization string for this measurement
      i18n_label = "active_monitoring_stats.icmp_continuous",
      -- The function called periodically to send the host probes
      check = check_icmp_continuous,
      -- The function responsible for collecting the results
      collect_results = collect_icmp_continuous,
      -- The granularities allowed for the probe. See supported_granularities in active_monitoring.lua
      granularities = {"min"},
      -- The localization string for the measurement unit (e.g. "ms", "Mbits")
      i18n_unit = "field_units.percentage",
      -- The localization string for the Active Monitoring timeseries menu entry
      i18n_am_ts_label = "active_monitoring_stats.response_rate",
      -- 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:val_* 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 = {{
        schema="am_host:cicmp_stats",
        label=i18n("flow_details.round_trip_time"),
        metrics_labels = { i18n("graphs.min_rtt"), i18n("graphs.max_rtt") },
        value_formatter = {"fmillis", "fmillis"},
        split_directions = true,
      }},
      -- Js function to call to format the measurement value. See ntopng_utils.js .
      value_js_formatter = "fpercent",
      -- The raw measurement value is multiplied by this factor before being written into the chart
      chart_scaling_value = 1,
      -- The localization string for the Active Monitoring metric in the chart
      i18n_am_ts_metric = "active_monitoring_stats.response_rate",
      -- 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 = nil,
      -- An alternative localization string for the unrachable alert message
      unreachable_alert_i18n = nil,
    }, {
      key = "cicmp6",
      i18n_label = "active_monitoring_stats.icmp_continuous_v6",
      check = check_icmp_continuous,
      collect_results = collect_icmp_continuous,
      granularities = {"min"},
      i18n_unit = "field_units.percentage",
      i18n_am_ts_label = "active_monitoring_stats.response_rate",
      i18n_am_ts_metric = "active_monitoring_stats.response_rate",
      operator = "lt",
      additional_timeseries = {{
        schema="am_host:cicmp_stats",
        label=i18n("flow_details.round_trip_time"),
        metrics_labels = { i18n("graphs.min_rtt"), i18n("graphs.max_rtt") },
        value_formatter = {"fmillis", "fmillis"},
        split_directions = true,
      }},
      value_js_formatter = "fpercent",
      chart_scaling_value = 1,
      i18n_chart_notes = {},
      force_host = nil,
      unreachable_alert_i18n = nil,
    },
  },

  -- A setup function to possibly disable the plugin
  setup = check_icmp_available,
}