mirror of
https://github.com/ntop/ntopng.git
synced 2026-05-03 09:20:10 +00:00
57 lines
2.3 KiB
Lua
57 lines
2.3 KiB
Lua
--
|
|
-- (C) 2019 - ntop.org
|
|
--
|
|
|
|
local alert_consts = require("alert_consts")
|
|
|
|
-- This file defines a new flow status, with key "status_example" (the file name).
|
|
-- A flows status can set/unset by the user scripts located into the "user_scripts"
|
|
-- directory of the plugin.
|
|
|
|
-- #################################################################
|
|
|
|
-- @brief This function is called each time this status should be formatted
|
|
-- @param status the status_id
|
|
-- @param flowstatus_info: the data passed in flow.triggerStatus by
|
|
-- the triggering user_script (user_scripts/flow/example.lua in this plugin).
|
|
-- @return a descriptive string of the flow status
|
|
local function formatExampleStatus(status, flowstatus_info)
|
|
local bad_port = flowstatus_info.bad_port
|
|
|
|
return i18n("example.status_invalid_port", {port_number = bad_port})
|
|
end
|
|
|
|
-- #################################################################
|
|
|
|
return {
|
|
-- The unique status ID. Currently used/available IDs can be reviewed by visiting
|
|
-- http://127.0.0.1:3000/lua/defs_overview.lua .
|
|
-- Third party users can safely use the dedicated IDs in range 59-63 .
|
|
status_id = 62,
|
|
|
|
-- The relevance of this status, used to calculate a score
|
|
-- prio: when a flow has multiple status set, the most important status is the one with highest priority
|
|
-- alert_type: the alert type associated to this status
|
|
-- alert_severity: the alert severity associated to this status
|
|
-- i18n_title: a localization string for the status
|
|
-- i18n_description (optional): a localization string / function for the description
|
|
relevance = 100,
|
|
|
|
-- A flow can have multiple statuses set. The predominant status is the one with the
|
|
-- histest "prio"
|
|
prio = 310,
|
|
|
|
-- A label to associate to this status
|
|
i18n_title = "example.status_title",
|
|
|
|
-- A descriptive message of the status. Can be either a simple localized string
|
|
-- e.g. "example.simple_status" or, as in this case, a formatter function.
|
|
i18n_description = formatExampleStatus,
|
|
|
|
-- The severity of the alert triggered based on this status
|
|
alert_severity = alert_consts.alert_severities.error,
|
|
|
|
-- The alert associated to this status. "alert_example" here corresponds
|
|
-- to the alert key of example/alert_definitions/alert_example.lua
|
|
alert_type = alert_consts.alert_types.alert_example,
|
|
}
|