From 3b15dae166e4c10aa030edff18f9adc86d3b983b Mon Sep 17 00:00:00 2001 From: Tetiana Kravchenko Date: Tue, 22 Feb 2022 13:40:30 +0100 Subject: [PATCH] extend documentation about setting orchestrator.cluster fields (#30518) * extend documentation about setting orchestrator.cluster fields Signed-off-by: Tetiana Kravchenko * changelog: fix typo; add pr link Signed-off-by: Tetiana Kravchenko (cherry picked from commit bc1c6534497da0ebcd222a4fc05133e8d8185dea) --- CHANGELOG.next.asciidoc | 10 ++++++++++ metricbeat/docs/modules/kubernetes.asciidoc | 11 ++++++++++- metricbeat/module/kubernetes/_meta/docs.asciidoc | 11 ++++++++++- 3 files changed, 30 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.next.asciidoc b/CHANGELOG.next.asciidoc index 034e3ad011f..43273cedd63 100644 --- a/CHANGELOG.next.asciidoc +++ b/CHANGELOG.next.asciidoc @@ -92,6 +92,16 @@ https://github.com/elastic/beats/compare/v7.0.0-alpha2...main[Check the HEAD dif *Metricbeat* +- Add `add_resource_metadata` configuration to Kubernetes module. {pull}29133[29133] +- Add `containerd` module with `cpu`, `memory`, `blkio` metricsets. {pull}29247[29247] +- Add `container.id` and `container.runtime` ECS fields in container metricset. {pull}29560[29560] +- Add `memory.workingset.limit.pct` field in Kubernetes container/pod metricset. {pull}29547[29547] +- Add k8s metadata in state_cronjob metricset. {pull}29572[29572] +- Add `xpack.enabled` support for Enterprise Search module. {pull}29871[29871] +- 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 about `orchestrator.cluster` fields {pull}30518[30518] *Packetbeat* diff --git a/metricbeat/docs/modules/kubernetes.asciidoc b/metricbeat/docs/modules/kubernetes.asciidoc index 90b523b4c8d..0d3595c3e4e 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 a6b59e392b8..342b71163cb 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: