From 8254381dcc150708bf17b3d70993f0e00e9a5e16 Mon Sep 17 00:00:00 2001 From: Chris Cowan Date: Tue, 12 Feb 2019 16:00:16 -0700 Subject: [PATCH 1/5] Adding descriptions for metrics for Infrastructure docs --- docs/en/infraops/installation.asciidoc | 51 +++++++++++++++++++++++++- 1 file changed, 49 insertions(+), 2 deletions(-) diff --git a/docs/en/infraops/installation.asciidoc b/docs/en/infraops/installation.asciidoc index 0a5300140..25f6e60b9 100644 --- a/docs/en/infraops/installation.asciidoc +++ b/docs/en/infraops/installation.asciidoc @@ -50,7 +50,7 @@ image::add-data.png[] * If your data source isn't in the list, or you want to install {beats} the old fashioned way: -** Follow the +** Follow the {metricbeat-ref}/metricbeat-getting-started.html[{metricbeat} getting started] and enable modules for the metrics you want to collect. @@ -64,10 +64,11 @@ learn how to configure inputs. For either approach, you need to enable modules in {filebeat} and {metricbeat} to populate the {infra-ui} UI with data. + [float] ==== Which modules and configuration options do I enable? -To populate the *Hosts* view and add logs, enable: +To populate the *Hosts* view and add logs, enable: * {metricbeat-ref}/metricbeat-module-system.html[{metricbeat} `system` module] (enabled by default) * {filebeat-ref}/filebeat-module-system.html[{filebeat} `system` module] @@ -91,6 +92,52 @@ module] * {filebeat-ref}/filebeat-input-docker.html[{filebeat} `docker` input] * {filebeat-ref}/add-kubernetes-metadata.html[{filebeat} `add_kubernetes_metadata` processor] +[float] +==== Which fields are used for the metrics on the map? + + + +===== Host Metrics + +*CPU Usage*:: Average of `system.cpu.user.pct` added to the average of `system.cpu.system.pct` divided by `system.cpu.cores` + +*Memory Usage*:: Average of `system.memory.actual.used.pct` + +*Load*:: Average of `system.load.5` + +*Inbound Traffic*:: Derivative of the max of `system.netowrk.in.bytes` scaled to a 1 second rate + +*Outbound Traffic*:: Derivative of the max of `system.netowrk.out.bytes` scaled to a 1 second rate + +*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. + + +[float] +===== Docker Container Metrics + +*CPU Usage*:: Average of `docker.cpu.total.pct` + +*Memory Usage*:: Average of `docker.memory.usage.pct` + +*Inbound Traffic*:: Derivative of the max of `docker.network.in.bytes` scaled to a 1 second rate + +*Outbound Traffic*:: Derivative of the max of `docker.network.out.bytes` scaled to a 1 second rate + + + +[float] +===== Docker Container Metrics + +*CPU Usage*:: Average of `kubernetes.pod.cpu.usage.node.pct` + +*Memory Usage*:: Average of `kubernetes.pod.memory.usage.pct` + +*Inbound Traffic*:: Derivative of the max of `kubernetes.pod.network.rx.bytes` scaled to a 1 second rate + +*Outbound Traffic*:: Derivative of the max of `kubernetes.pod.network.tx.bytes` scaled to a 1 second rate + + + [float] ==== More about container monitoring From 09cf9e5b9a37e678f6d812f6a27162d71cbb28db Mon Sep 17 00:00:00 2001 From: Chris Cowan Date: Tue, 12 Feb 2019 16:09:34 -0700 Subject: [PATCH 2/5] Fixing title --- docs/en/infraops/installation.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/infraops/installation.asciidoc b/docs/en/infraops/installation.asciidoc index 25f6e60b9..9a15d8b2e 100644 --- a/docs/en/infraops/installation.asciidoc +++ b/docs/en/infraops/installation.asciidoc @@ -126,7 +126,7 @@ module] [float] -===== Docker Container Metrics +===== Kubernetes Pod Metrics *CPU Usage*:: Average of `kubernetes.pod.cpu.usage.node.pct` From 358665b9732dfd33130da828006bd4feef49dc53 Mon Sep 17 00:00:00 2001 From: Chris Cowan Date: Wed, 13 Feb 2019 09:37:08 -0700 Subject: [PATCH 3/5] removing floats --- docs/en/infraops/installation.asciidoc | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs/en/infraops/installation.asciidoc b/docs/en/infraops/installation.asciidoc index 9a15d8b2e..44705712d 100644 --- a/docs/en/infraops/installation.asciidoc +++ b/docs/en/infraops/installation.asciidoc @@ -96,7 +96,6 @@ module] ==== Which fields are used for the metrics on the map? - ===== Host Metrics *CPU Usage*:: Average of `system.cpu.user.pct` added to the average of `system.cpu.system.pct` divided by `system.cpu.cores` @@ -112,7 +111,6 @@ module] *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. -[float] ===== Docker Container Metrics *CPU Usage*:: Average of `docker.cpu.total.pct` @@ -124,8 +122,6 @@ module] *Outbound Traffic*:: Derivative of the max of `docker.network.out.bytes` scaled to a 1 second rate - -[float] ===== Kubernetes Pod Metrics *CPU Usage*:: Average of `kubernetes.pod.cpu.usage.node.pct` From 5e21e75049c520328548cd1d9ea6e3ff1c79d1d7 Mon Sep 17 00:00:00 2001 From: Chris Cowan Date: Wed, 13 Feb 2019 14:24:34 -0700 Subject: [PATCH 4/5] Adding floats and placeholder text --- docs/en/infraops/installation.asciidoc | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/docs/en/infraops/installation.asciidoc b/docs/en/infraops/installation.asciidoc index 44705712d..c85805e2e 100644 --- a/docs/en/infraops/installation.asciidoc +++ b/docs/en/infraops/installation.asciidoc @@ -93,9 +93,16 @@ module] * {filebeat-ref}/add-kubernetes-metadata.html[{filebeat} `add_kubernetes_metadata` processor] [float] -==== Which fields are used for the metrics on the map? +==== Which fields are used for the metrics on the Infrastructue home page? +The metrics listed below are provided by the Beat Shippers above. Each system type also requires their coresponding identy field to be in the same event document.. +* Hosts require `host.name` +* Docker containers require `container.id` +* Kibernetes pods require `kibernetes.pod.uid` + + +[float] ===== Host Metrics *CPU Usage*:: Average of `system.cpu.user.pct` added to the average of `system.cpu.system.pct` divided by `system.cpu.cores` @@ -111,6 +118,7 @@ module] *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. +[float] ===== Docker Container Metrics *CPU Usage*:: Average of `docker.cpu.total.pct` @@ -122,6 +130,7 @@ module] *Outbound Traffic*:: Derivative of the max of `docker.network.out.bytes` scaled to a 1 second rate +[float] ===== Kubernetes Pod Metrics *CPU Usage*:: Average of `kubernetes.pod.cpu.usage.node.pct` From 0fb8539a0cf2044152efc4927d6ced1dcab575ef Mon Sep 17 00:00:00 2001 From: Brandon Morelli Date: Wed, 13 Feb 2019 16:10:48 -0700 Subject: [PATCH 5/5] Apply suggestions from code review Co-Authored-By: simianhacker --- docs/en/infraops/installation.asciidoc | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/en/infraops/installation.asciidoc b/docs/en/infraops/installation.asciidoc index c85805e2e..40571e1dc 100644 --- a/docs/en/infraops/installation.asciidoc +++ b/docs/en/infraops/installation.asciidoc @@ -95,7 +95,7 @@ module] [float] ==== Which fields are used for the metrics on the Infrastructue home page? -The metrics listed below are provided by the Beat Shippers above. Each system type also requires their coresponding identy field to be in the same event document.. +The metrics listed below are provided by the Beats Shippers. Each system type requires their corresponding identity field to be in the same event document: * Hosts require `host.name` * Docker containers require `container.id` @@ -115,7 +115,8 @@ The metrics listed below are provided by the Beat Shippers above. Each system ty *Outbound Traffic*:: Derivative of the max of `system.netowrk.out.bytes` scaled to a 1 second rate -*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. +*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. [float]