From 4ccafd90c9f501997f35e3d5d220ba48b0c2cbd3 Mon Sep 17 00:00:00 2001 From: kaiyan-sheng Date: Wed, 27 May 2020 07:26:26 -0600 Subject: [PATCH] [Metricbeat] Update googlecloud stackdriver metricset documentation (#18693) * Update googlecloud stackdriver metricset documentation --- .../stackdriver/_meta/docs.asciidoc | 20 ++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/x-pack/metricbeat/module/googlecloud/stackdriver/_meta/docs.asciidoc b/x-pack/metricbeat/module/googlecloud/stackdriver/_meta/docs.asciidoc index 00cce58cac8c..a803035a3b68 100644 --- a/x-pack/metricbeat/module/googlecloud/stackdriver/_meta/docs.asciidoc +++ b/x-pack/metricbeat/module/googlecloud/stackdriver/_meta/docs.asciidoc @@ -1,7 +1,17 @@ Stackdriver provides visibility into the performance, uptime, and overall health of cloud-powered applications. It collects metrics, events, and metadata from different services from Google Cloud. This metricset is to collect monitoring -metrics from Google Cloud using `ListTimeSeries` API. +metrics from Google Cloud using `ListTimeSeries` API. The full list of metric +types that Google Cloud monitoring supports can be found in +https://cloud.google.com/monitoring/api/metrics_gcp#gcp[Google Cloud Metrics]. + +Each monitoring metric from stackdriver has a sample period and/or ingest delay. +Sample period is the time interval between consecutive data points for metrics +that are written periodically. Ingest delay represents the time for data points +older than this value are guaranteed to be available to read. Sample period and +ingest delay are obtained from making +https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors/list[ListMetricDescriptors API] +call. [float] == Metricset config and parameters @@ -12,8 +22,12 @@ type. Metric type is to used for identifying a specific time series. * *aligner*: A single string with which aggregation operation need to be applied onto time series data for ListTimeSeries API. If it's not given, default aligner -is set to be `ALIGN_NONE`. Sample period of each metric type is obtained from -making https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors/list [ListMetricDescriptors API] call. +is set to be `ALIGN_NONE`. Google Cloud also supports `ALIGN_DELTA`, `ALIGN_RATE`, +`ALIGN_MIN`, `ALIGN_MAX`, `ALIGN_MEAN`, `ALIGN_COUNT`, `ALIGN_SUM` and etc. +Please see +https://cloud.google.com/monitoring/api/ref_v3/rpc/google.monitoring.v3#aligner[Aggregation Aligner] +for the full list of aligners. + [float] === Example Configuration