--
-- (C) 2013-22 - ntop.org
--
local dirs = ntop.getDirs()
package.path = dirs.installdir .. "/scripts/lua/modules/pools/?.lua;" .. package.path
require "lua_utils"
require "db_utils"
require "rrd_paths"
local top_talkers_utils = require "top_talkers_utils"
local graph_common = require "graph_common"
local ts_utils = require("ts_utils")
local iface_behavior_update_freq = 300 --Seconds
-- ########################################################
local graph_utils = {}
-- ########################################################
if(ntop.isPro()) then
-- if the version is pro, we include nv_graph_utils as part of this module
package.path = dirs.installdir .. "/pro/scripts/lua/modules/?.lua;" .. package.path
graph_utils = require "nv_graph_utils"
end
-- ########################################################
graph_utils.graph_colors = {
'#1f77b4',
'#ff7f0e',
'#2ca02c',
'#d62728',
'#9467bd',
'#8c564b',
'#e377c2',
'#7f7f7f',
'#bcbd22',
'#17becf',
-- https://github.com/mbostock/d3/wiki/Ordinal-Scales
'#ff7f0e',
'#ffbb78',
'#1f77b4',
'#aec7e8',
'#2ca02c',
'#98df8a',
'#d62728',
'#ff9896',
'#9467bd',
'#c5b0d5',
'#8c564b',
'#c49c94',
'#e377c2',
'#f7b6d2',
'#7f7f7f',
'#c7c7c7',
'#bcbd22',
'#dbdb8d',
'#17becf',
'#9edae5'
}
-- ########################################################
function graph_utils.get_html_color(index)
return graph_utils.graph_colors[(index % #graph_utils.graph_colors) + 1]
end
-- ########################################################
-- @brief Ensure that the provided series have the same number of points. This is a
-- requirement for the charts.
-- @param series a list of series to fix. The format of each serie is the one
-- returned by ts_utils.query
-- @note the series are modified in place
function graph_utils.normalizeSeriesPoints(series)
-- local format_utils = require "format_utils"
-- for idx, data in ipairs(series) do
-- for _, s in ipairs(data.series) do
-- if not s.tags.protocol then
-- tprint({step = data.step, num = #s.data, start = format_utils.formatEpoch(data.start), count = s.count, label = s.label})
-- end
-- end
-- end
local max_count = 0
local min_step = math.huge
local ts_common = require("ts_common")
for _, serie in pairs(series) do
max_count = math.max(max_count, #serie.series[1].data)
min_step = math.min(min_step, serie.step)
end
if max_count > 0 then
for _, serie in pairs(series) do
local count = #serie.series[1].data
if count ~= max_count then
serie.count = max_count
for _, serie_data in pairs(serie.series) do
-- The way this function perform the upsampling is partial.
-- Only points are upsampled, times are not adjusted.
-- In addition, the max_count is fixed and this causes series
-- with different lengths to be upsampled differently.
-- For example a 240-points timeseries with lenght 1-day
-- and a 10 points timeseris with length 1-hour would result
-- the the 1-hour timeseries being divided into 240 points, actually
-- ending up in having a much smaller step.
-- TODO: adjust timeseries times.
-- TODO: handle series with different start and end times.
serie_data.data = ts_common.upsampleSerie(serie_data.data, max_count)
-- The new step needs to be adjusted as well. The new step is smaller
-- than the new step. To calculate it, multiply the old step by the fraction
-- of old vs new points.
local new_step = round(serie.step * count / max_count, 0)
serie.step = new_step
serie_data.step = new_step
serie_data.count = max_count
end
end
end
end
end
-- ########################################################
function graph_utils.getProtoVolume(ifName, start_time, end_time, ts_options)
ifId = getInterfaceId(ifName)
local series = ts_utils.listSeries("iface:ndpi", {ifid = ifId}, start_time)
ret = { }
for _, tags in ipairs(series or {}) do
-- NOTE: this could be optimized via a dedicated driver call
local data = ts_utils.query("iface:ndpi", tags, start_time, end_time, ts_options)
if(data ~= nil) and (data.statistics.total > 0) then
ret[tags.protocol] = data.statistics.total
end
end
return(ret)
end
-- ########################################################
function graph_utils.breakdownBar(sent, sentLabel, rcvd, rcvdLabel, thresholdLow, thresholdHigh)
if((sent+rcvd) > 0) then
sent2rcvd = round((sent * 100) / (sent+rcvd), 0)
-- io.write("****>> "..sent.."/"..rcvd.."/"..sent2rcvd.."\n")
if((thresholdLow == nil) or (thresholdLow < 0)) then thresholdLow = 0 end
if((thresholdHigh == nil) or (thresholdHigh > 100)) then thresholdHigh = 100 end
if(sent2rcvd < thresholdLow) then sentLabel = ' '..sentLabel
elseif(sent2rcvd > thresholdHigh) then rcvdLabel = ' '..rcvdLabel end
print('
'..sentLabel)
print('
' .. rcvdLabel .. '
')
else
print(' ')
end
end
-- ########################################################
function graph_utils.percentageBar(total, value, valueLabel)
-- io.write("****>> "..total.."/"..value.."\n")
if((total ~= nil) and (total > 0)) then
pctg = round((value * 100) / total, 0)
print('
'..valueLabel)
print('
')
else
print(' ')
end
end
-- ########################################################
function graph_utils.makeProgressBar(percentage)
-- nan check
if percentage ~= percentage then
return ""
end
local perc_int = round(percentage)
return '
'..
round(percentage, 1) ..' %'
end
-- ########################################################
--! @brief Prints stacked progress bars with a legend
--! @total the raw total value (associated to full bar width)
--! @param bars a table with elements in the following format:
--! - title: the item legend title
--! - value: the item raw value
--! - class: the bootstrap color class, usually: "default", "info", "danger", "warning", "success"
--! @param other_label optional name for the "other" part of the bar. If nil, it will not be shown.
--! @param formatter an optional item value formatter
--! @param css_class an optional css class to apply to the progress div
--! @skip_zero_values don't display values containing only zero
--! @return html for the bar
function graph_utils.stackedProgressBars(total, bars, other_label, formatter, css_class, skip_zero_values)
local res = {}
local cumulative = 0
local cumulative_perc = 0
local skip_zero_values = skip_zero_values or false
formatter = formatter or (function(x) return x end)
-- The bars
res[#res + 1] = [[
]]
for _, bar in ipairs(bars) do cumulative = cumulative + bar.value end
if cumulative > total then total = cumulative end
for _, bar in ipairs(bars) do
local percentage = round(bar.value * 100 / total, 2)
if cumulative_perc + percentage > 100 then percentage = 100 - cumulative_perc end
cumulative_perc = cumulative_perc + percentage
if bar.class == nil then bar.class = "primary" end
if bar.style == nil then bar.style = "" end
if bar.link ~= nil then
res[#res + 1] = [[]]
else
res[#res + 1] = [[
]]
end
if bar.link ~= nil then res[#res + 1] = [[]] end
end
res[#res + 1] = [[
]]
-- The legend
res[#res + 1] = [[
]]
local legend_items = bars
if other_label ~= nil then
legend_items = bars
legend_items[#legend_items + 1] = {
title = other_label,
class = "empty",
style = "",
value = math.max(total - cumulative, 0),
}
end
num = 0
for _, bar in ipairs(legend_items) do
if skip_zero_values and bar.value == 0 then goto continue end
res[#res + 1] = [[]]
if(num > 0) then res[#res + 1] = [[ ]] end
if bar.link ~= nil then res[#res + 1] = [[]] end
res[#res + 1] = [[]]
if bar.link ~= nil then res[#res + 1] = [[]] end
res[#res + 1] = [[ ]] .. bar.title .. " (".. formatter(bar.value) ..")"
num = num + 1
::continue::
end
res[#res + 1] = [[ - ]] .. i18n("total") .. ": ".. formatter(total) ..""
return table.concat(res)
end
-- ########################################################
local function getMinZoomResolution(schema)
local schema_obj = ts_utils.getSchema(schema)
if schema_obj then
if schema_obj.options.step >= 300 then
return '30m'
elseif schema_obj.options.step >= 60 then
return '5m'
end
end
return '1m'
end
-- #################################################
function graph_utils.drawNewGraphs(source_value_object)
if source_value_object == nil then
source_value_object = {}
end
local ifstats = interface.getStats()
local json = require ("dkjson")
local ifid = interface.getId()
local enable_new_timeseries = ntop.getPref("ntopng.enable_new_timeseries")
local recording_utils = require "recording_utils"
local traffic_extraction_permitted = recording_utils.isActive(ifid) or recording_utils.isExtractionActive(ifid)
local template_utils = require "template_utils"
local interface_ts_enabled = ntop.getCache("ntopng.prefs.interface_ndpi_timeseries_creation")
local interface_has_top_protocols = interface_ts_enabled == "both" or interface_ts_enabled == "per_protocol" or interface_ts_enabled ~= "0"
local interface_has_top_categories = interface_ts_enabled == "both" or interface_ts_enabled == "per_category"
local host_ts_creation = ntop.getPref("ntopng.prefs.hosts_ts_creation")
local host_ts_enabled = ntop.getCache("ntopng.prefs.host_ndpi_timeseries_creation")
local host_has_top_protocols = host_ts_enabled == "both" or host_ts_enabled == "per_protocol" or host_ts_enabled ~= "0"
local host_has_top_categories = host_ts_enabled == "both" or host_ts_enabled == "per_category"
local sources_types_enabled = {
interface = interface_ts_enabled,
host = host_ts_creation,
mac = ntop.getPref("ntopng.prefs.l2_device_rrd_creation") == "1",
network = ntop.getPref("ntopng.prefs.asn_rrd_creation") == "1",
as = ntop.getPref("ntopng.prefs.asn_rrd_creation") == "1",
country = ntop.getPref("ntopng.prefs.country_rrd_creation") == "1",
os = ntop.getPref("ntopng.prefs.os_rrd_creation") == "1",
vlan = ntop.getPref("ntopng.prefs.vlan_rrd_creation") == "1",
pool = ntop.getPref("ntopng.prefs.host_pools_rrd_creation") == "1",
system = ntop.getPref("ntopng.prefs.system_probes_timeseries") == "1",
profile = ntop.isPro() and ifstats.profiles,
redis = ntop.getPref("ntopng.prefs.timeseries_driver") ~= "influxdb",
influx = ntop.getPref("ntopng.prefs.timeseries_driver") == "influxdb",
active_monitoring = ntop.getPref("ntopng.prefs.system_probes_timeseries") == "1",
pod = ifstats.has_seen_pods,
container = ifstats.has_seen_containers,
snmp_interface = ntop.getPref("ntopng.prefs.snmp_devices_rrd_creation") == "1",
snmp_device = ntop.getPref("ntopng.prefs.snmp_devices_rrd_creation") == "1",
flow_device = false,
flow_interface = false,
sflow_device = false,
sflow_interface = false,
}
local sources_types_top_enabled = {
interface = {
top_protocols = interface_has_top_protocols,
top_categories = interface_has_top_categories,
top_senders = ntop.getPref("ntopng.prefs.topk_heuristic_precision") ~= "disabled",
top_receivers = ntop.getPref("ntopng.prefs.topk_heuristic_precision") ~= "disabled",
},
host = {
top_protocols = host_has_top_protocols,
},
snmp = {
top_snmp_ifaces = true,
},
}
local context = {
traffic_extraction_permitted = traffic_extraction_permitted,
sources_types_enabled = json.encode(sources_types_enabled),
source_value_object = json.encode(source_value_object),
sources_types_top_enabled = json.encode(sources_types_top_enabled),
}
template_utils.render("pages/components/historical_interface.template", context)
end
-- #################################################
function graph_utils.drawGraphs(ifid, schema, tags, zoomLevel, baseurl, selectedEpoch, options, show_graph, render_new_chart)
local page_utils =require("page_utils") -- Do not require at the top as it could conflict with script_manager.getMenuEntries
local debug_rrd = false
local is_system_interface = page_utils.is_system_view()
options = options or {}
if((selectedEpoch == nil) or (selectedEpoch == "")) then
-- Refresh the page every minute unless:
-- ** a specific epoch has been selected or
-- ** the user is browsing historical top talkers and protocols
print[[
]]
end
local min_zoom = getMinZoomResolution(schema)
local min_zoom_k = 1
if(zoomLevel == nil) then zoomLevel = min_zoom end
if graph_utils.drawProGraph then
local enable_new_timeseries = ntop.getPref("ntopng.enable_new_timeseries")
enable_new_timeseries = "1"
local recording_utils = require "recording_utils"
local traffic_extraction_permitted = recording_utils.isActive(ifid) or recording_utils.isExtractionActive(ifid)
if render_new_chart and render_new_chart == true and enable_new_timeseries == "1" then
local template_utils = require "template_utils"
template_utils.render("pages/components/historical_interface.template", { traffic_extraction_permitted = traffic_extraction_permitted })
return
end
graph_utils.drawProGraph(ifid, schema, tags, zoomLevel, baseurl, options, show_graph)
return
end
nextZoomLevel = zoomLevel;
epoch = tonumber(selectedEpoch);
for k,v in ipairs(graph_common.zoom_vals) do
if graph_common.zoom_vals[k][1] == min_zoom then
min_zoom_k = k
end
if(graph_common.zoom_vals[k][1] == zoomLevel) then
if(k > 1) then
nextZoomLevel = graph_common.zoom_vals[math.max(k-1, min_zoom_k)][1]
end
if(epoch ~= nil) then
start_time = epoch - math.floor(graph_common.zoom_vals[k][3] / 2)
end_time = epoch + math.floor(graph_common.zoom_vals[k][3] / 2)
else
end_time = os.time()
start_time = end_time - graph_common.zoom_vals[k][3]
end
end
end
if options.tskey then
-- this can contain a MAC address for local broadcast domain hosts
-- table.clone needed to modify some parameters while keeping the original unchanged
tags = table.clone(tags)
tags.host = options.tskey
end
local data = ts_utils.query(schema, tags, start_time, end_time)
if(data) then
print [[
\n')
for k,v in ipairs(graph_common.zoom_vals) do
-- display 1 minute button only for networks and interface stats
-- but exclude applications. Application statistics are gathered
-- every 5 minutes
if graph_common.zoom_vals[k][1] == '1m' and min_zoom ~= '1m' then
goto continue
elseif graph_common.zoom_vals[k][1] == '5m' and min_zoom ~= '1m' and min_zoom ~= '5m' then
goto continue
end
local params = table.merge(page_params, {zoom=graph_common.zoom_vals[k][1]})
-- Additional parameters
if tags.protocol ~= nil then
params["protocol"] = tags.protocol
end
if tags.category ~= nil then
params["category"] = tags.category
end
local url = getPageUrl(baseurl, params)
print('')
if(graph_common.zoom_vals[k][1] == zoomLevel) then
print([[]])
else
print([[]])
end
::continue::
end
print [[
]]
local format_as_bps = true
local format_as_bytes = false
local formatter_fctn
local label = data.series[1].label
-- Attempt at reading the formatter from the options using the schema
local formatter
if options and options.timeseries then
for _, cur_ts in pairs(options.timeseries or {}) do
if cur_ts.schema == schema and cur_ts.value_formatter then
formatter = cur_ts.value_formatter[1] or cur_ts.value_formatter
break
end
end
end
if label == "load_percentage" then
formatter_fctn = "NtopUtils.ffloat"
format_as_bps = false
elseif label == "resident_bytes" then
formatter_fctn = "NtopUtils.bytesToSize"
format_as_bytes = true
elseif string.contains(label, "pct") then
formatter_fctn = "NtopUtils.fpercent"
format_as_bps = false
format_as_bytes = false
elseif schema == "process:num_alerts" then
formatter_fctn = "NtopUtils.falerts"
format_as_bps = false
format_as_bytes = false
elseif label:contains("millis") or label:contains("_ms") then
formatter_fctn = "NtopUtils.fmillis"
format_as_bytes = false
format_as_bps = false
elseif string.contains(label, "packets") or string.contains(label, "flows") or label:starts("num_") or label:contains("alerts") or label:contains("score") then
formatter_fctn = "NtopUtils.fint"
format_as_bytes = false
format_as_bps = false
elseif formatter then
-- The formatter specified in the options
formatter_fctn = formatter
format_as_bytes = false
format_as_bps = false
else
formatter_fctn = (is_system_interface and "NtopUtils.fnone" or "NtopUtils.fbits")
end
print [[
]]
print('
Time
Value
\n')
local stats = data.statistics
if(stats ~= nil) then
local minval_time = stats.min_val_idx and (data.start + data.step * stats.min_val_idx) or 0
local maxval_time = stats.max_val_idx and (data.start + data.step * stats.max_val_idx) or 0
local lastval_time = data.start + data.step * (data.count-1)
local lastval = 0
for _, serie in pairs(data.series) do
lastval = lastval + (serie.data[data.count] or 0)
end
if format_as_bytes then
if(minval_time > 0) then print('
\n')
-- hide Minute Interface Top Talker if we are in system interface
if top_talkers_utils.areTopEnabled(ifid) and not is_system_interface then
print('
Minute Interface Top Talkers
\n')
end
print [[
]]
print[[
]]
print[[
]]
local ui_utils = require("ui_utils")
print(ui_utils.render_notes(options.notes))
print[[
]]
else
print("
No data found
")
end -- if(data)
end
-- #################################################
--
-- proto table should contain the following information:
-- string traffic_quota
-- string time_quota
-- string protoName
--
-- ndpi_stats or category_stats can be nil if they are not relevant for the proto
--
-- quotas_to_show can contain:
-- bool traffic
-- bool time
--
function graph_utils.printProtocolQuota(proto, ndpi_stats, category_stats, quotas_to_show, show_td, hide_limit)
local total_bytes = 0
local total_duration = 0
local output = {}
if ndpi_stats ~= nil then
-- This is a single protocol
local proto_stats = ndpi_stats[proto.protoName]
if proto_stats ~= nil then
total_bytes = proto_stats["bytes.sent"] + proto_stats["bytes.rcvd"]
total_duration = proto_stats["duration"]
end
else
-- This is a category
local cat_stats = category_stats[proto.protoName]
if cat_stats ~= nil then
total_bytes = cat_stats["bytes"]
total_duration = cat_stats["duration"]
end
end
if quotas_to_show.traffic then
local bytes_exceeded = ((proto.traffic_quota ~= "0") and (total_bytes >= tonumber(proto.traffic_quota)))
local lb_bytes = bytesToSize(total_bytes)
local lb_bytes_quota = ternary(proto.traffic_quota ~= "0", bytesToSize(tonumber(proto.traffic_quota)), i18n("unlimited"))
local traffic_taken = ternary(proto.traffic_quota ~= "0", math.min(total_bytes, tonumber(proto.traffic_quota)), 0)
local traffic_remaining = math.max(tonumber(proto.traffic_quota) - traffic_taken, 0)
local traffic_quota_ratio = round(traffic_taken * 100 / (traffic_taken + traffic_remaining), 0) or 0
if not traffic_quota_ratio then traffic_quota_ratio = 0 end
if show_td then
output[#output + 1] = [[
") end
end
if quotas_to_show.time then
local time_exceeded = ((proto.time_quota ~= "0") and (total_duration >= tonumber(proto.time_quota)))
local lb_duration = secondsToTime(total_duration)
local lb_duration_quota = ternary(proto.time_quota ~= "0", secondsToTime(tonumber(proto.time_quota)), i18n("unlimited"))
local duration_taken = ternary(proto.time_quota ~= "0", math.min(total_duration, tonumber(proto.time_quota)), 0)
local duration_remaining = math.max(proto.time_quota - duration_taken, 0)
local duration_quota_ratio = round(duration_taken * 100 / (duration_taken+duration_remaining), 0) or 0
if show_td then
output[#output + 1] = [[
") end
end
return table.concat(output, '')
end
-- #################################################
function graph_utils.poolDropdown(ifId, pool_id, exclude)
local host_pools = require "host_pools"
local host_pools_instance = host_pools:create()
pool_id = tostring(pool_id)
local output = {}
exclude = exclude or {}
for _,pool in ipairs(host_pools_instance:get_all_pools()) do
pool.pool_id = tostring(pool.pool_id)
if (not exclude[pool.pool_id]) or (pool.pool_id == pool_id) then
output[#output + 1] = ''
end
end
return table.concat(output, '')
end
-- #################################################
function graph_utils.printPoolChangeDropdown(ifId, pool_id, have_nedge)
local output = {}
output[#output + 1] = [[
]]
print(table.concat(output, ''))
end
-- #################################################
function graph_utils.printCategoryDropdownButton(by_id, cat_id_or_name, base_url, page_params, count_callback, skip_unknown)
local function count_all(cat_id, cat_name)
local cat_protos = interface.getnDPIProtocols(tonumber(cat_id))
return table.len(cat_protos)
end
cat_id_or_name = cat_id_or_name or ""
count_callback = count_callback or count_all
-- 'Category' button
print('\'
')
-- 'Category' dropdown menu
local entries = { {text=i18n("all"), id="", cat_id=""} }
entries[#entries + 1] = ""
for cat_name, cat_id in pairsByKeys(interface.getnDPICategories()) do
local cat_count = count_callback(cat_id, cat_name)
if(skip_unknown and (cat_id == "0") and (cat_count > 0)) then
-- Do not count the Unknown protocol in the Unspecified category
cat_count = cat_count - 1
end
local cat_title = getCategoryLabel(cat_name, cat_id)
if cat_count > 0 then
entries[#entries + 1] = {text=cat_title.." ("..cat_count..")", id=cat_name, cat_id=cat_id}
end
end
for _, entry in pairs(entries) do
if entry ~= "" then
page_params["category"] = ternary(by_id, ternary(entry.cat_id ~= "", "cat_" .. entry.cat_id, ""), entry.id)
print('