Skip to content

Commit 25f4091

Browse files
author
Akshay Saraswat
authored
Add Cluster filter on Kubernetes Overview ECS dashboard (#26919)
1 parent c99fde1 commit 25f4091

5 files changed

Lines changed: 1659 additions & 1348 deletions

File tree

‎CHANGELOG.next.asciidoc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1000,6 +1000,7 @@ https://github.com/elastic/beats/compare/v7.0.0-alpha2...master[Check the HEAD d
10001000
- Add total CPU to vSphere virtual machine metrics. {pull}26167[26167]
10011001
- Add AWS Kinesis metricset. {pull}25989[25989]
10021002
- Move openmetrics module to oss. {pull}26561[26561]
1003+
- Add Cluster filter on ECS Kubernetes overview dashboard and corresponding section on Kubernetes module documentation page. {pull}26919[26919]
10031004

10041005
*Packetbeat*
10051006

‎metricbeat/docs/images/metricbeat-kubernetes-clusteroverview.png‎

729 KB
Loading

‎metricbeat/docs/modules/kubernetes.asciidoc‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,12 +154,19 @@ The Kubernetes module is tested with the following versions of Kubernetes:
154154
[float]
155155
=== Dashboard
156156

157-
Kubernetes module is shipped including default dashboards for `apiserver`, `controllermanager`, `scheduler` and `proxy`.
157+
Kubernetes module is shipped including default dashboards for `cluster overview`, `apiserver`, `controllermanager`, `scheduler` and `proxy`.
158158

159159
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.
160160

161161
Dashboards for `controllermanager` `scheduler` and `proxy` are not compatible with kibana versions below `7.2.0`
162162

163+
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.
164+
165+
Kubernetes cluster overview example:
166+
167+
image::./images/metricbeat-kubernetes-clusteroverview.png[]
168+
169+
163170
Kubernetes controller manager example:
164171

165172
image::./images/metricbeat-kubernetes-controllermanager.png[]

‎metricbeat/module/kubernetes/_meta/docs.asciidoc‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,12 +147,19 @@ The Kubernetes module is tested with the following versions of Kubernetes:
147147
[float]
148148
=== Dashboard
149149

150-
Kubernetes module is shipped including default dashboards for `apiserver`, `controllermanager`, `scheduler` and `proxy`.
150+
Kubernetes module is shipped including default dashboards for `cluster overview`, `apiserver`, `controllermanager`, `scheduler` and `proxy`.
151151

152152
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.
153153

154154
Dashboards for `controllermanager` `scheduler` and `proxy` are not compatible with kibana versions below `7.2.0`
155155

156+
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.
157+
158+
Kubernetes cluster overview example:
159+
160+
image::./images/metricbeat-kubernetes-clusteroverview.png[]
161+
162+
156163
Kubernetes controller manager example:
157164

158165
image::./images/metricbeat-kubernetes-controllermanager.png[]

0 commit comments

Comments
 (0)