Mirror/zeek
1
0
Fork 0
mirror of https://github.com/zeek/zeek.git synced 2025-10-13 03:58:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

telemetry: Run callbacks at collect time

Browse source 
Calling collect_metrics() from a script would not invoke metric
callbacks, resulting in most of the process metrics to be zero
when a Zeek process isn't scraped via Prometheus.

Fixes #4309
This commit is contained in:
Arne Welzel 2025-03-26 11:42:52 +01:00
parent 33d7e5a7bf
commit c3c6ee5a2b
4 changed files with 58 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

17
src/telemetry/Manager.cc
View file

@ -278,6 +278,14 @@ void Manager::InvokeTelemetrySyncHook() {
in_sync_hook = false;
}
void Manager::UpdateMetrics() {
InvokeTelemetrySyncHook();
for ( const auto& [name, f] : families )
f->RunCallbacks();
}
ValPtr Manager::CollectMetrics(std::string_view prefix_pattern, std::string_view name_pattern) {
static auto metrics_vector_type = zeek::id::find_type<VectorType>("Telemetry::MetricVector");
static auto string_vec_type = zeek::id::find_type<zeek::VectorType>("string_vec");
@ -290,7 +298,7 @@ ValPtr Manager::CollectMetrics(std::string_view prefix_pattern, std::string_view
static auto metric_opts_type = zeek::id::find_type<zeek::RecordType>("Telemetry::MetricOpts");
static auto metric_type_idx = metric_opts_type->FieldOffset("metric_type");
InvokeTelemetrySyncHook();
UpdateMetrics();
VectorValPtr ret_val = make_intrusive<VectorVal>(metrics_vector_type);
@ -369,7 +377,7 @@ ValPtr Manager::CollectHistogramMetrics(std::string_view prefix_pattern, std::st
static auto metric_opts_type = zeek::id::find_type<zeek::RecordType>("Telemetry::MetricOpts");
static auto metric_type_idx = metric_opts_type->FieldOffset("metric_type");
InvokeTelemetrySyncHook();
UpdateMetrics();
VectorValPtr ret_val = make_intrusive<VectorVal>(metrics_vector_type);
@ -597,10 +605,7 @@ void Manager::ProcessFd(int fd, int flags) {
collector_flare.Extinguish();
for ( const auto& [name, f] : families )
f->RunCallbacks();
InvokeTelemetrySyncHook();
UpdateMetrics();
collector_response_idx = collector_request_idx;

5
src/telemetry/Manager.h
View file

@ -264,6 +264,11 @@ private:
*/
void InvokeTelemetrySyncHook();
/**
* Runs the telemetry sync hooks and metric callbacks.
*/
void UpdateMetrics();
bool in_sync_hook = false;
std::map<std::string, std::shared_ptr<MetricFamily>> families;

13
testing/btest/Baseline/scripts.base.frameworks.telemetry.process-collect/out Normal file
View file

@ -0,0 +1,13 @@
### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.
zeek_init
process_cpu_user_seconds_total, [], >0.0, good
process_cpu_system_seconds_total, [], >0.0, good
process_resident_memory_bytes, [], >0.0, good
process_virtual_memory_bytes, [], >0.0, good
process_open_fds, [], >0.0, good
zeek_done
process_cpu_user_seconds_total, [], >0.0, good
process_cpu_system_seconds_total, [], >0.0, good
process_resident_memory_bytes, [], >0.0, good
process_virtual_memory_bytes, [], >0.0, good
process_open_fds, [], >0.0, good

29
testing/btest/scripts/base/frameworks/telemetry/process-collect.zeek Normal file
View file

@ -0,0 +1,29 @@
# @TEST-DOC: Calling collect_metrics() invokes callbacks for process (and other) metrics.
# Not compilable to C++ due to globals being initialized to a record that
# has an opaque type as a field.
# @TEST-REQUIRES: test "${ZEEK_USE_CPP}" != "1"
#
# @TEST-EXEC: zeek -r $TRACES/http/get.trace -b %INPUT >out
# @TEST-EXEC: btest-diff out
@load base/frameworks/telemetry
function print_metrics(ms: vector of Telemetry::Metric) {
for (_, m in ms)
print m$opts$name, m$label_values, m$value > 0.0 ? ">0.0, good" : "0.0, bad";
}
event zeek_init()
{
print "zeek_init";
local ms = Telemetry::collect_metrics("process");
print_metrics(ms);
}
event zeek_done()
{
print "zeek_done";
local ms = Telemetry::collect_metrics("process");
print_metrics(ms);
}