From 1d1ac66ff106309486203803a0ae5a0b76a93a52 Mon Sep 17 00:00:00 2001 From: Tetiana Kravchenko Date: Tue, 22 Feb 2022 09:19:13 +0100 Subject: [PATCH 1/2] extend documentation about setting orchestrator.cluster fields Signed-off-by: Tetiana Kravchenko --- CHANGELOG.next.asciidoc | 1 + metricbeat/docs/modules/kubernetes.asciidoc | 11 ++++++++++- metricbeat/module/kubernetes/_meta/docs.asciidoc | 11 ++++++++++- 3 files changed, 21 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.next.asciidoc b/CHANGELOG.next.asciidoc index a07654b6e34..e3ee2e4743b 100644 --- a/CHANGELOG.next.asciidoc +++ b/CHANGELOG.next.asciidoc @@ -136,6 +136,7 @@ https://github.com/elastic/beats/compare/v7.0.0-alpha2...main[Check the HEAD dif - Add gcp firestore metricset. {pull}29918[29918] - Remove strict parsing on RabbitMQ module {pull}30090[30090] - Add `kubernetes.container.status.last.reason` metric {pull}30306[30306] +- Extend documentation aboour `orchestrator.cluster` fields *Packetbeat* diff --git a/metricbeat/docs/modules/kubernetes.asciidoc b/metricbeat/docs/modules/kubernetes.asciidoc index dc6873daece..bbc11556ee2 100644 --- a/metricbeat/docs/modules/kubernetes.asciidoc +++ b/metricbeat/docs/modules/kubernetes.asciidoc @@ -166,7 +166,16 @@ If you are using HA for those components, be aware that when gathering data from 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. +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/filebeat/current/add-fields.html[add_fields processor] to set `orchestrator.cluster.name` fields and utilize it in the `cluster overview` dashboard: +[source,yaml] +---- +processors: + - add_fields: + target: orchestrator.cluster + fields: + name: clusterName + url: clusterURL +---- Kubernetes cluster overview example: diff --git a/metricbeat/module/kubernetes/_meta/docs.asciidoc b/metricbeat/module/kubernetes/_meta/docs.asciidoc index 8e8e8419523..e2c2ac82ecf 100644 --- a/metricbeat/module/kubernetes/_meta/docs.asciidoc +++ b/metricbeat/module/kubernetes/_meta/docs.asciidoc @@ -157,7 +157,16 @@ If you are using HA for those components, be aware that when gathering data from 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. +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/filebeat/current/add-fields.html[add_fields processor] to set `orchestrator.cluster.name` fields and utilize it in the `cluster overview` dashboard: +[source,yaml] +---- +processors: + - add_fields: + target: orchestrator.cluster + fields: + name: clusterName + url: clusterURL +---- Kubernetes cluster overview example: From 48c24f3461cdb6ef0d8b0e2edf3087e3da5b0a1c Mon Sep 17 00:00:00 2001 From: Tetiana Kravchenko Date: Tue, 22 Feb 2022 12:07:09 +0100 Subject: [PATCH 2/2] changelog: fix typo; add pr link Signed-off-by: Tetiana Kravchenko --- CHANGELOG.next.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.next.asciidoc b/CHANGELOG.next.asciidoc index e3ee2e4743b..2da927c128d 100644 --- a/CHANGELOG.next.asciidoc +++ b/CHANGELOG.next.asciidoc @@ -136,7 +136,7 @@ https://github.com/elastic/beats/compare/v7.0.0-alpha2...main[Check the HEAD dif - Add gcp firestore metricset. {pull}29918[29918] - Remove strict parsing on RabbitMQ module {pull}30090[30090] - Add `kubernetes.container.status.last.reason` metric {pull}30306[30306] -- Extend documentation aboour `orchestrator.cluster` fields +- Extend documentation about `orchestrator.cluster` fields {pull}30518[30518] *Packetbeat*