Generate metrics reference docs #2164
Commits on Mar 1, 2024
-
tetra: Add metrics-docs command
This command utilizes github.com/isovalent/metricstool/pkg/metricsmd to generate a metrics reference. Signed-off-by: Anna Kapuscinska <[email protected]>
-
Makefile: Add metrics-docs rule
`make metrics-docs` generates metrics reference documentation page using `tetra metrics-docs` command. Signed-off-by: Anna Kapuscinska <[email protected]>
-
metricsconfig: Split InitMetrics and introduce InitMetricsForDocs
Split InitMetrics function into multiple functions to divide metrics into logical groups. Introduce InitMetricsForDocs function used in `tetra metrics-docs` command. There are no functional changes in this commit. This refactoring is a preparation for further improvements in the generated metrics docs. Signed-off-by: Anna Kapuscinska <[email protected]>
-
tetra: Split metrics reference into sections
Update metrics-docs tetra command and Makefile rule to split metrics reference into three sections: health metrics, resources metrics and events metrics. Signed-off-by: Anna Kapuscinska <[email protected]>
-
eventmetrics: Initialize metrics with example labels for docs
Initialize tetragon_events_total with all possible event types and example process metadata. Initialize tetragon_policy_events_total with example policy and kprobe. Signed-off-by: Anna Kapuscinska <[email protected]>
-
kprobemetrics: Initialize metrics with example labels for docs
Initialize tetragon_generic_kprobe_merge_errors_total with all possible error types and example kprobes. Signed-off-by: Anna Kapuscinska <[email protected]>
-
syscallmetrics: Initialize metrics with example labels for docs
Initialize tetragon_syscalls_total with example syscall and process metadata. Signed-off-by: Anna Kapuscinska <[email protected]>
-
observer: Initialize custom collectors for docs
observer.bpfCollector doesn't report any metrics if Tetragon isn't fully initialized - so also when we generate metrics docs with tetra. To include observer BPF metrics in metrics docs, let's define a "fake" collector - observer.bpfZeroCollector - reporting same metrics as observer.bpfCollector but with hardcoded zero values. Signed-off-by: Anna Kapuscinska <[email protected]>
-
eventmetrics: Initialize custom collectors for docs
eventmetrics.bpfCollector doesn't report any metrics if Tetragon isn't fully initialized - so also when we generate metrics docs with tetra. To include BPF event metrics in metrics docs, let's define a "fake" collector - eventmetrics.bpfZeroCollector - reporting same metrics as eventmetrics.bpfCollector but with hardcoded zero values. Signed-off-by: Anna Kapuscinska <[email protected]>
-
policystatemetrics: Initialize custom collectors for docs
policyStateCollector doesn't report any metrics if Tetragon isn't fully initialized - so also when we generate metrics docs with tetra. To include policy state metrics in metrics docs, let's define a "fake" collector - policyStateZeroCollector - reporting same metrics as policyStateZeroCollector but with hardcoded zero values. Signed-off-by: Anna Kapuscinska <[email protected]>
-
ci: Check generated metrics docs
Signed-off-by: Anna Kapuscinska <[email protected]>
-
docs: Add autogenerated metrics reference page
Signed-off-by: Anna Kapuscinska <[email protected]>
-
Makefile: Document metrics-docs and lint-metrics-md targets
Signed-off-by: Anna Kapuscinska <[email protected]>
-
docs: Improve metrics reference title and frontmatter
Signed-off-by: Anna Kapuscinska <[email protected]>
-
docs: Document how metrics reference is generated
Use a Hugo shortcode so that the comment isn't rendered into the final HTML. Signed-off-by: Anna Kapuscinska <[email protected]>
-
docs: Don't mention github.com/isovalent/metricstool in metrics docs
It looks a bit odd as it's not rendered as a link, especially in the TOC. Signed-off-by: Anna Kapuscinska <[email protected]>
