Skip to content

Commit

Permalink
[Docs] Clarify how/when metrics are collected (#40715)
Browse files Browse the repository at this point in the history
  • Loading branch information
kilfoyle authored Sep 9, 2024
1 parent cd51941 commit 815b5b0
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 0 deletions.
15 changes: 15 additions & 0 deletions metricbeat/docs/modules/system.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,21 @@ https://gitlab.com/apparmor/apparmor/wikis/TechnicalDoc_Proc_and_ptrace[AppArmor
and other LSM software], even though the System module doesn't use `ptrace`
directly.

[TIP]
.How and when metrics are collected
====
Certain metrics monitored by the System module require multiple values to be
collected.
For example, the `system.process.cpu.total.norm.pct` field reports the percentage
of CPU time spent by the process since the last event. For this percentage to be
determined, the process needs to appear at least twice so that a performance delta
can be calculated.
Note that in some cases a field like this may be missing from the System module
metricset if the process has not been available long enough to be included in
two periods of metric collection.
====

[float]
=== Dashboard

Expand Down
15 changes: 15 additions & 0 deletions metricbeat/module/system/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,21 @@ https://gitlab.com/apparmor/apparmor/wikis/TechnicalDoc_Proc_and_ptrace[AppArmor
and other LSM software], even though the System module doesn't use `ptrace`
directly.

[TIP]
.How and when metrics are collected
====
Certain metrics monitored by the System module require multiple values to be
collected.
For example, the `system.process.cpu.total.norm.pct` field reports the percentage
of CPU time spent by the process since the last event. For this percentage to be
determined, the process needs to appear at least twice so that a performance delta
can be calculated.

Note that in some cases a field like this may be missing from the System module
metricset if the process has not been available long enough to be included in
two periods of metric collection.
====

[float]
=== Dashboard

Expand Down

0 comments on commit 815b5b0

Please sign in to comment.