[7.14](backport #26919) Add Cluster filter on Kubernetes Overview ECS…

… dashboard (#26946) * Add Cluster filter on Kubernetes Overview ECS dashboard (#26919) (cherry picked from commit 25f4091) * Update CHANGELOG.next.asciidoc Co-authored-by: Akshay Saraswat <[email protected]> Co-authored-by: Chris Mark <[email protected]>
elastic · Jul 19, 2021 · 72faf0e · 72faf0e
1 parent aa8714c
commit 72faf0e
Show file tree

Hide file tree

Showing 5 changed files with 1,659 additions and 1,348 deletions.
diff --git a/CHANGELOG.next.asciidoc b/CHANGELOG.next.asciidoc
@@ -702,6 +702,7 @@ https://github.com/elastic/beats/compare/v7.0.0-alpha2...master[Check the HEAD d
 - Collect linked account information in AWS billing. {pull}26285[26285]
 - Add total CPU to vSphere virtual machine metrics. {pull}26167[26167]
 - Add AWS Kinesis metricset. {pull}25989[25989]
+- Add Cluster filter on ECS Kubernetes overview dashboard and corresponding section on Kubernetes module documentation page. {pull}26919[26919]
 
 *Packetbeat*
 

diff --git a/metricbeat/docs/images/metricbeat-kubernetes-clusteroverview.png b/metricbeat/docs/images/metricbeat-kubernetes-clusteroverview.png
diff --git a/metricbeat/docs/modules/kubernetes.asciidoc b/metricbeat/docs/modules/kubernetes.asciidoc
@@ -150,12 +150,19 @@ The Kubernetes module is tested with the following versions of Kubernetes:
 [float]
 === Dashboard
 
-Kubernetes module is shipped including default dashboards for `apiserver`, `controllermanager`, `scheduler` and `proxy`.
+Kubernetes module is shipped including default dashboards for `cluster overview`, `apiserver`, `controllermanager`, `scheduler` and `proxy`.
 
 If you are using HA for those components, be aware that when gathering data from all instances the dashboard will usually show and average of the metrics. For those scenarios filtering by hosts or service address is possible.
 
 Dashboards for `controllermanager` `scheduler` and `proxy` are not compatible with kibana versions below `7.2.0`
 
+Cluster selector in `cluster overview` dashboard helps in distinguishing and filtering metrics collected from multiple clusters. If you want to focus on a subset of the Kubernetes clusters for monitoring a specific scenario, this cluster selector could be a handy tool. Note that this selector gets populated from the `orchestrator.cluster.name` field that may not always be available. This field gets its value from sources like `kube_config`, `kubeadm-config` configMap, and Google Cloud's meta API for GKE. If the sources mentioned above don't provide this value, metricbeat will not report it. However, you can always use https://www.elastic.co/guide/en/beats/metricbeat/current/defining-processors.html[processors] to set this field and utilize it in the `cluster overview` dashboard.
+
+Kubernetes cluster overview example:
+
+image::./images/metricbeat-kubernetes-clusteroverview.png[]
+
+
 Kubernetes controller manager example:
 
 image::./images/metricbeat-kubernetes-controllermanager.png[]

diff --git a/metricbeat/module/kubernetes/_meta/docs.asciidoc b/metricbeat/module/kubernetes/_meta/docs.asciidoc
@@ -143,12 +143,19 @@ The Kubernetes module is tested with the following versions of Kubernetes:
 [float]
 === Dashboard
 
-Kubernetes module is shipped including default dashboards for `apiserver`, `controllermanager`, `scheduler` and `proxy`.
+Kubernetes module is shipped including default dashboards for `cluster overview`, `apiserver`, `controllermanager`, `scheduler` and `proxy`.
 
 If you are using HA for those components, be aware that when gathering data from all instances the dashboard will usually show and average of the metrics. For those scenarios filtering by hosts or service address is possible.
 
 Dashboards for `controllermanager` `scheduler` and `proxy` are not compatible with kibana versions below `7.2.0`
 
+Cluster selector in `cluster overview` dashboard helps in distinguishing and filtering metrics collected from multiple clusters. If you want to focus on a subset of the Kubernetes clusters for monitoring a specific scenario, this cluster selector could be a handy tool. Note that this selector gets populated from the `orchestrator.cluster.name` field that may not always be available. This field gets its value from sources like `kube_config`, `kubeadm-config` configMap, and Google Cloud's meta API for GKE. If the sources mentioned above don't provide this value, metricbeat will not report it. However, you can always use https://www.elastic.co/guide/en/beats/metricbeat/current/defining-processors.html[processors] to set this field and utilize it in the `cluster overview` dashboard.
+
+Kubernetes cluster overview example:
+
+image::./images/metricbeat-kubernetes-clusteroverview.png[]
+
+
 Kubernetes controller manager example:
 
 image::./images/metricbeat-kubernetes-controllermanager.png[]