From a6e5b49824a76fe5087dd42c473124934a72a5fc Mon Sep 17 00:00:00 2001 From: endorama <526307+endorama@users.noreply.github.com> Date: Thu, 2 Sep 2021 11:58:53 +0200 Subject: [PATCH] [Metricbeat] gcp: add gke metricset documentation (#27613) --- metricbeat/docs/modules/gcp.asciidoc | 17 +++++++++-- metricbeat/docs/modules/gcp/gke.asciidoc | 19 +++++++++++++ metricbeat/docs/modules_list.asciidoc | 3 +- x-pack/metricbeat/metricbeat.reference.yml | 2 +- x-pack/metricbeat/module/gcp/_meta/config.yml | 2 +- .../metricbeat/module/gcp/_meta/docs.asciidoc | 11 +++++++- .../module/gcp/gke/_meta/docs.asciidoc | 28 +++++++++++++++++++ .../module/gcp/metrics/_meta/docs.asciidoc | 2 +- x-pack/metricbeat/modules.d/gcp.yml.disabled | 2 +- 9 files changed, 78 insertions(+), 8 deletions(-) create mode 100644 metricbeat/docs/modules/gcp/gke.asciidoc create mode 100644 x-pack/metricbeat/module/gcp/gke/_meta/docs.asciidoc diff --git a/metricbeat/docs/modules/gcp.asciidoc b/metricbeat/docs/modules/gcp.asciidoc index fbca8e75cc0..8dc8e88ff9f 100644 --- a/metricbeat/docs/modules/gcp.asciidoc +++ b/metricbeat/docs/modules/gcp.asciidoc @@ -149,7 +149,7 @@ For example, if Compute Metricset fetches 14 metrics (which is the number of met [float] == Metricsets -Currently, we have `billing`, `compute`, `loadbalancing`, `pubsub`, `metrics` and +Currently, we have `billing`, `compute`, `gke`, `loadbalancing`, `pubsub`, `metrics` and `storage` metricset in `gcp` module. [float] @@ -176,6 +176,15 @@ The `compute` metricset comes with a predefined dashboard: image::./images/metricbeat-gcp-compute-overview.png[] +[float] +=== `gke` + +This metricset fetches metrics for https://cloud.google.com/kubernetes-engine[Kubernetes Engine]. + +The `gke` metricset contains all GA metrics exported by https://cloud.google.com/monitoring/api/metrics_kubernetes[Cloud Monitoring Kubernetes metrics]. + +Extra labels and metadata are also extracted using the https://cloud.google.com/compute/docs/reference/rest/v1/instances/get[Compute API]. + [float] === `loadbalancing` This metricset fetches metrics from https://cloud.google.com/load-balancing/[Load Balancing] @@ -295,7 +304,7 @@ metricbeat.modules: period: 1m metrics: - aligner: ALIGN_NONE - service: kubernetes + service: gke service_metric_prefix: kubernetes.io/ metric_types: - "container/cpu/core_usage_time" @@ -320,6 +329,8 @@ The following metricsets are available: * <> +* <> + * <> * <> @@ -332,6 +343,8 @@ include::gcp/billing.asciidoc[] include::gcp/compute.asciidoc[] +include::gcp/gke.asciidoc[] + include::gcp/loadbalancing.asciidoc[] include::gcp/metrics.asciidoc[] diff --git a/metricbeat/docs/modules/gcp/gke.asciidoc b/metricbeat/docs/modules/gcp/gke.asciidoc new file mode 100644 index 00000000000..fa3dbe427a5 --- /dev/null +++ b/metricbeat/docs/modules/gcp/gke.asciidoc @@ -0,0 +1,19 @@ +//// +This file is generated! See scripts/mage/docs_collector.go +//// + +[[metricbeat-metricset-gcp-gke]] +[role="xpack"] +=== Google Cloud Platform gke metricset + +beta[] + +include::../../../../x-pack/metricbeat/module/gcp/gke/_meta/docs.asciidoc[] + +This is a default metricset. If the host module is unconfigured, this metricset is enabled by default. + +==== Fields + +For a description of each field in the metricset, see the +<> section. + diff --git a/metricbeat/docs/modules_list.asciidoc b/metricbeat/docs/modules_list.asciidoc index 183170a44b7..2d341b65460 100644 --- a/metricbeat/docs/modules_list.asciidoc +++ b/metricbeat/docs/modules_list.asciidoc @@ -115,8 +115,9 @@ This file is generated! See scripts/mage/docs_collector.go |<> |<> |<> beta[] |image:./images/icon-yes.png[Prebuilt dashboards are available] | -.6+| .6+| |<> beta[] +.7+| .7+| |<> beta[] |<> beta[] +|<> beta[] |<> beta[] |<> beta[] |<> beta[] diff --git a/x-pack/metricbeat/metricbeat.reference.yml b/x-pack/metricbeat/metricbeat.reference.yml index f00787cd1f3..4891b979e22 100644 --- a/x-pack/metricbeat/metricbeat.reference.yml +++ b/x-pack/metricbeat/metricbeat.reference.yml @@ -578,7 +578,7 @@ metricbeat.modules: period: 1m metrics: - aligner: ALIGN_NONE - service: kubernetes + service: gke service_metric_prefix: kubernetes.io/ metric_types: - "container/cpu/core_usage_time" diff --git a/x-pack/metricbeat/module/gcp/_meta/config.yml b/x-pack/metricbeat/module/gcp/_meta/config.yml index f29075b4ca8..00295e795d4 100644 --- a/x-pack/metricbeat/module/gcp/_meta/config.yml +++ b/x-pack/metricbeat/module/gcp/_meta/config.yml @@ -50,7 +50,7 @@ period: 1m metrics: - aligner: ALIGN_NONE - service: kubernetes + service: gke service_metric_prefix: kubernetes.io/ metric_types: - "container/cpu/core_usage_time" diff --git a/x-pack/metricbeat/module/gcp/_meta/docs.asciidoc b/x-pack/metricbeat/module/gcp/_meta/docs.asciidoc index c38894e6dc5..32f53d21475 100644 --- a/x-pack/metricbeat/module/gcp/_meta/docs.asciidoc +++ b/x-pack/metricbeat/module/gcp/_meta/docs.asciidoc @@ -139,7 +139,7 @@ For example, if Compute Metricset fetches 14 metrics (which is the number of met [float] == Metricsets -Currently, we have `billing`, `compute`, `loadbalancing`, `pubsub`, `metrics` and +Currently, we have `billing`, `compute`, `gke`, `loadbalancing`, `pubsub`, `metrics` and `storage` metricset in `gcp` module. [float] @@ -166,6 +166,15 @@ The `compute` metricset comes with a predefined dashboard: image::./images/metricbeat-gcp-compute-overview.png[] +[float] +=== `gke` + +This metricset fetches metrics for https://cloud.google.com/kubernetes-engine[Kubernetes Engine]. + +The `gke` metricset contains all GA metrics exported by https://cloud.google.com/monitoring/api/metrics_kubernetes[Cloud Monitoring Kubernetes metrics]. + +Extra labels and metadata are also extracted using the https://cloud.google.com/compute/docs/reference/rest/v1/instances/get[Compute API]. + [float] === `loadbalancing` This metricset fetches metrics from https://cloud.google.com/load-balancing/[Load Balancing] diff --git a/x-pack/metricbeat/module/gcp/gke/_meta/docs.asciidoc b/x-pack/metricbeat/module/gcp/gke/_meta/docs.asciidoc new file mode 100644 index 00000000000..3e31f4145da --- /dev/null +++ b/x-pack/metricbeat/module/gcp/gke/_meta/docs.asciidoc @@ -0,0 +1,28 @@ +`gke` metricset is designed for collecting metrics from https://cloud.google.com/kubernetes-engine[Google Kubernetes +Engine]. +Google Cloud Monitoring supports Google Kubernetes Engine metrics, as listed in +https://cloud.google.com/monitoring/api/metrics_kubernetes[Google Cloud Monitoring Kubernetes metrics]. + +This metricset collects all GA Kubernetes metrics from Google Cloud Monitoring +APIs. It leverages under the hood the `metrics` metricset. + +We recommend users to define `period: 1m` for this metricset because in Google +Cloud, GKE monitoring metrics are sampled every 60 seconds. +Some of the metrics have an ingest delay up to 240 seconds. + +[float] +=== Metricset-specific configuration notes +None + +[float] +=== Configuration example +[source,yaml] +---- +- module: gcp + metricsets: + - gke + project_id: "your project id" + credentials_file_path: "your JSON credentials file path" + exclude_labels: false + period: 1m +---- diff --git a/x-pack/metricbeat/module/gcp/metrics/_meta/docs.asciidoc b/x-pack/metricbeat/module/gcp/metrics/_meta/docs.asciidoc index 83fb4e1c9c0..157e336e08b 100644 --- a/x-pack/metricbeat/module/gcp/metrics/_meta/docs.asciidoc +++ b/x-pack/metricbeat/module/gcp/metrics/_meta/docs.asciidoc @@ -158,7 +158,7 @@ metric prefix, as for GKE metrics the required prefix is `kubernetes.io/` exclude_labels: false period: 1m metrics: - - service: kubernetes + - service: gke service_metric_prefix: kubernetes.io/ metric_types: - "container/cpu/core_usage_time" diff --git a/x-pack/metricbeat/modules.d/gcp.yml.disabled b/x-pack/metricbeat/modules.d/gcp.yml.disabled index 38428f335fc..d7d873be6d1 100644 --- a/x-pack/metricbeat/modules.d/gcp.yml.disabled +++ b/x-pack/metricbeat/modules.d/gcp.yml.disabled @@ -53,7 +53,7 @@ period: 1m metrics: - aligner: ALIGN_NONE - service: kubernetes + service: gke service_metric_prefix: kubernetes.io/ metric_types: - "container/cpu/core_usage_time"