Skip to content

Commit 8254381

Browse files
committed
Adding descriptions for metrics for Infrastructure docs
1 parent 02bf40c commit 8254381

File tree

1 file changed

+49
-2
lines changed

1 file changed

+49
-2
lines changed

docs/en/infraops/installation.asciidoc

Lines changed: 49 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ image::add-data.png[]
5050
* If your data source isn't in the list, or you want to install {beats} the old
5151
fashioned way:
5252

53-
** Follow the
53+
** Follow the
5454
{metricbeat-ref}/metricbeat-getting-started.html[{metricbeat} getting started]
5555
and enable modules for the metrics you want to collect.
5656

@@ -64,10 +64,11 @@ learn how to configure inputs.
6464
For either approach, you need to enable modules in {filebeat} and {metricbeat}
6565
to populate the {infra-ui} UI with data.
6666

67+
6768
[float]
6869
==== Which modules and configuration options do I enable?
6970

70-
To populate the *Hosts* view and add logs, enable:
71+
To populate the *Hosts* view and add logs, enable:
7172

7273
* {metricbeat-ref}/metricbeat-module-system.html[{metricbeat} `system` module] (enabled by default)
7374
* {filebeat-ref}/filebeat-module-system.html[{filebeat} `system` module]
@@ -91,6 +92,52 @@ module]
9192
* {filebeat-ref}/filebeat-input-docker.html[{filebeat} `docker` input]
9293
* {filebeat-ref}/add-kubernetes-metadata.html[{filebeat} `add_kubernetes_metadata` processor]
9394

95+
[float]
96+
==== Which fields are used for the metrics on the map?
97+
98+
99+
100+
===== Host Metrics
101+
102+
*CPU Usage*:: Average of `system.cpu.user.pct` added to the average of `system.cpu.system.pct` divided by `system.cpu.cores`
103+
104+
*Memory Usage*:: Average of `system.memory.actual.used.pct`
105+
106+
*Load*:: Average of `system.load.5`
107+
108+
*Inbound Traffic*:: Derivative of the max of `system.netowrk.in.bytes` scaled to a 1 second rate
109+
110+
*Outbound Traffic*:: Derivative of the max of `system.netowrk.out.bytes` scaled to a 1 second rate
111+
112+
*Log Rate*:: Derivative of the cumulative sum of the document count scaled to a 1 second rate, this metric relies on the same indices as the logs.
113+
114+
115+
[float]
116+
===== Docker Container Metrics
117+
118+
*CPU Usage*:: Average of `docker.cpu.total.pct`
119+
120+
*Memory Usage*:: Average of `docker.memory.usage.pct`
121+
122+
*Inbound Traffic*:: Derivative of the max of `docker.network.in.bytes` scaled to a 1 second rate
123+
124+
*Outbound Traffic*:: Derivative of the max of `docker.network.out.bytes` scaled to a 1 second rate
125+
126+
127+
128+
[float]
129+
===== Docker Container Metrics
130+
131+
*CPU Usage*:: Average of `kubernetes.pod.cpu.usage.node.pct`
132+
133+
*Memory Usage*:: Average of `kubernetes.pod.memory.usage.pct`
134+
135+
*Inbound Traffic*:: Derivative of the max of `kubernetes.pod.network.rx.bytes` scaled to a 1 second rate
136+
137+
*Outbound Traffic*:: Derivative of the max of `kubernetes.pod.network.tx.bytes` scaled to a 1 second rate
138+
139+
140+
94141
[float]
95142
==== More about container monitoring
96143

0 commit comments

Comments
 (0)