EVOLUTION-MANAGER

Edit File: alert_too_many_drops.lua

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

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

local other_alert_keys = require "other_alert_keys"

-- Import the classes library.
local classes = require "classes"
-- Make sure to import the Superclass!
local alert = require "alert"
local alert_entities = require "alert_entities"

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

local alert_too_many_drops = classes.class(alert)

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

alert_too_many_drops.meta = {
  alert_key = other_alert_keys.alert_too_many_drops,
  i18n_title = "alerts_dashboard.too_many_drops",
  icon = "fas fa-fw fa-tint",
  entities = {
    alert_entities.interface
  },
}

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

-- @brief Prepare an alert table used to generate the alert
-- @param drops The number of dropped packets
-- @param drop_perc The percentage of dropped packets with reference to the total number of packets (recevied + dropped)
-- @param threshold A number indicating the threshold compared with `drop_perc`
-- @return A table with the alert built
function alert_too_many_drops:init(drops, drop_perc, threshold)
   -- Call the parent constructor
   self.super:init()

self.alert_type_params = {
    drops = drops, 
    drop_perc = drop_perc, 
    edge = threshold,
   }
end

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

-- @brief Format an alert into a human-readable string
-- @param ifid The integer interface id of the generated alert
-- @param alert The alert description table, including alert data such as the generating entity, timestamp, granularity, type
-- @param alert_type_params Table `alert_type_params` as built in the `:init` method
-- @return A human-readable string
function alert_too_many_drops.format(ifid, alert, alert_type_params)
  local alert_consts = require("alert_consts")
  local entity = alert_consts.formatAlertEntity(ifid, alert_consts.alertEntityRaw(alert["entity_id"]), alert["entity_val"])
  local max_drop_perc = alert_type_params.edge or 0
  local perc_drops = string.format("%.1f", alert_type_params.drop_perc)
  
  return(i18n("alert_messages.too_many_drops", {iface = entity, perc_drops = perc_drops, max_drops = max_drop_perc}))
end

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

return alert_too_many_drops