From ab51f00b3cae8b73690da9a577bd8ab96848c417 Mon Sep 17 00:00:00 2001 From: ShohamBit Date: Tue, 17 Dec 2024 20:32:39 +0000 Subject: [PATCH] improve metrics=1 docs --- docs/contributing/building/building.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/contributing/building/building.md b/docs/contributing/building/building.md index 0316457800ae..ae5bfb3a4699 100644 --- a/docs/contributing/building/building.md +++ b/docs/contributing/building/building.md @@ -115,13 +115,15 @@ >plugin.Open("/tracee/dist/signatures/builtin.so"): Dynamic loading not supported >``` -8. Build a **debugable binary** with DWARF generation by setting `DEBUG=1` +8. Build a **debuggable binary** with DWARF generation by setting `DEBUG=1` ```bash DEBUG=1 make ``` -9. Build with embedded metrics (pprof) by setting `METRICS=1` +9. Build enabling BPF metrics by setting `METRICS=1`. + + BPF metrics are only available if the BPF object is built with `METRICS` debug flag defined. ```bash METRICS=1 make