EVOLUTION-MANAGER

Edit File: influxdb_monitor.lua

--
-- (C) 2019-20 - ntop.org
--

local user_scripts = require("user_scripts")
local ts_utils = require("ts_utils_core")
local alerts_api = require("alerts_api")
local alert_consts = require("alert_consts")

local script = {
  -- Script category
  category = user_scripts.script_categories.system,

-- This module is enabled by default
  default_enabled = true,

-- No default configuration is provided
  default_value = {},

gui = {
    i18n_title = "alerts_dashboard.influxdb_monitor",
    i18n_description = "alerts_dashboard.influxdb_monitor_description",
  },

-- See below
  hooks = {},
}

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

function script.setup()
  -- Only enabled if InfluxDB is active
  return(ts_utils.getDriverName() == "influxdb")
end

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

-- Defines an hook which is executed every 5 minutes
script.hooks["5mins"] = function(params)
  if params.ts_enabled then
    local influxdb = ts_utils.getQueryDriver()
    local when = params.when

script._exportStats(when, influxdb)
    script._measureRtt(when, influxdb)
    script._exportStorageSize(when, influxdb)
  end
end

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

-- Defines an hook which is executed every minute
script.hooks["min"] = function(params)
  local last_error = ntop.getCache("ntopng.cache.influxdb.last_error")

-- Note: last_error is automatically cleared once the error is gone
   if(not isEmptyString(last_error)) then
      local influxdb = ts_utils.getQueryDriver()

alerts_api.store(
         alerts_api.influxdbEntity(influxdb.url), {
            alert_type = alert_consts.alert_types.alert_influxdb_error,
            alert_severity = alert_consts.alert_severities.error,
            alert_granularity = alert_consts.alerts_granularities.min,
            alert_type_params = {error_msg = last_error},
      }, params.when)
   end
end

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

function script.getExportStats()
   local points_exported
   local points_dropped
   local exports
   local ifnames = interface.getIfNames()

local influxdb = ts_utils.getQueryDriver()

points_exported = influxdb:get_exported_points()
   points_dropped = influxdb:get_dropped_points()
   exports = influxdb:get_exports()

local res = {
      health = influxdb:get_health(),
      points_exported = points_exported,
      points_dropped = points_dropped,
      exports = exports,
   }

return(res)
end

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

function script._measureRtt(when, influxdb)
   local start_ms = ntop.gettimemsec()
   local res = influxdb:getInfluxdbVersion()
   local ifid = getSystemInterfaceId()

if res ~= nil then
      local end_ms = ntop.gettimemsec()

ts_utils.append("influxdb:rtt", {ifid = ifid, millis_rtt = ((end_ms-start_ms)*1000)}, when)
   end
end

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

function script._exportStats(when, influxdb)
   local stats = script.getExportStats()
   local ifid = getSystemInterfaceId()

ts_utils.append("influxdb:exported_points", {ifid = ifid, points = stats.points_exported}, when)
   ts_utils.append("influxdb:dropped_points", {ifid = ifid, points = stats.points_dropped}, when)
   ts_utils.append("influxdb:exports", {ifid = ifid, num_exports = stats.exports}, when)
end

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

function script._exportStorageSize(when, influxdb)
   local disk_bytes = influxdb:getDiskUsage()
   local ifid = getSystemInterfaceId()

if(disk_bytes ~= nil) then
      ts_utils.append("influxdb:storage_size", {ifid = ifid, disk_bytes = disk_bytes}, when)
   end
end

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

return(script)