zeek/scripts/base/frameworks/sumstats/non-cluster.zeek
Arne Welzel 91f5945f92 sumstat/non-cluster: Move last epoch processing to zeek_done()
@Sheco reported that standalone epoch processing may exclude scheduled
events when the final sumstat epoch runs before. For example, this easily
happens when attempting to do sumstat observations within connection_state_remove().

Delay final epoch processing to zeek_done() instead.

This doesn't deal with the clustered version - this would need something
more elaborate and potentially a mechanism to delay the shutdown of
other cluster nodes until/after sumstat processing completed.
2024-11-18 15:58:01 +01:00

100 lines
2.2 KiB
Text

@load ./main
module SumStats;
event SumStats::process_epoch_result(ss: SumStat, now: time, data: ResultTable)
{
# TODO: is this the right processing group size?
local i = 50;
local keys_to_delete: vector of SumStats::Key = vector();
for ( key, res in data )
{
ss$epoch_result(now, key, res);
keys_to_delete += key;
if ( --i == 0 )
break;
}
for ( idx in keys_to_delete )
delete data[keys_to_delete[idx]];
if ( |data| > 0 )
# TODO: is this the right interval?
schedule 0.01 secs { SumStats::process_epoch_result(ss, now, data) };
else if ( ss?$epoch_finished )
ss$epoch_finished(now);
}
function do_finish_epoch(ss: SumStat)
{
if ( ss$name !in result_store || ! ss?$epoch_result )
return;
local data = result_store[ss$name];
local now = network_time();
if ( zeek_is_terminating() )
{
for ( key, val in data )
ss$epoch_result(now, key, val);
if ( ss?$epoch_finished )
ss$epoch_finished(now);
}
else
{
if ( |data| > 0 )
event SumStats::process_epoch_result(ss, now, copy(data));
else
{
if ( ss?$epoch_finished )
ss$epoch_finished(now);
}
}
# We can reset here because we know that the reference to the
# data will be maintained by the process_epoch_result event.
reset(ss);
if ( ss$epoch != 0secs )
schedule ss$epoch { SumStats::finish_epoch(ss) };
}
event SumStats::finish_epoch(ss: SumStat)
{
if ( zeek_is_terminating() )
return; # runs during zeek_done() instead
do_finish_epoch(ss);
}
# Run non-manual SumStats entries as late as possible, but a bit
# earlier than a user's zeek_done() handler in case they end up
# doing something curious in zeek_done().
event zeek_done() &priority=10
{
for ( name, ss in stats_store )
{
if ( ss$epoch != 0sec ) # skip SumStats with manual epochs.
do_finish_epoch(ss);
}
}
function data_added(ss: SumStat, key: Key, result: Result)
{
if ( check_thresholds(ss, key, result, 1.0) )
threshold_crossed(ss, key, result);
}
function request_key(ss_name: string, key: Key): Result
{
# This only needs to be implemented this way for cluster compatibility.
return when [ss_name, key] ( T )
{
if ( ss_name in result_store && key in result_store[ss_name] )
return result_store[ss_name][key];
else
return table();
}
}