[Metricbeat GCP] Rename stackdriver metricset to metrics (elastic#19718)

* rename stackdriver metricset to metrics * Fix release highlights 7.8.0 doc
melchiormoulin · Oct 14, 2020 · 7efbc92 · 7efbc92
1 parent 43eda76
commit 7efbc92
Show file tree

Hide file tree

Showing 41 changed files with 149 additions and 150 deletions.
diff --git a/CHANGELOG.next.asciidoc b/CHANGELOG.next.asciidoc
@@ -71,6 +71,7 @@ https://github.com/elastic/beats/compare/v7.0.0-alpha2...master[Check the HEAD d
 - Add Tomcat overview dashboard {pull}14026[14026]
 - Move service config under metrics and simplify metric types. {pull}18691[18691]
 - Fix ECS compliance of user.id field in system/users  metricset {pull}19019[19019]
+- Rename googlecloud stackdriver metricset to metrics. {pull}19718[19718]
 
 *Packetbeat*
 

diff --git a/libbeat/docs/release-notes/highlights/highlights-7.8.0.asciidoc b/libbeat/docs/release-notes/highlights/highlights-7.8.0.asciidoc
@@ -4,10 +4,10 @@
 <titleabbrev>7.8</titleabbrev>
 ++++
 
-Each release of {beats} brings new features and product improvements. 
+Each release of {beats} brings new features and product improvements.
 Following are the most notable features and enhancements in 7.8.
 
-For a complete list of related highlights, see the 
+For a complete list of related highlights, see the
 https://www.elastic.co/blog/elastic-observability-7-7-0-released[Observability 7.8 release blog].
 
 For a list of bug fixes and other changes, see the {beats}
@@ -25,7 +25,7 @@ For a list of bug fixes and other changes, see the {beats}
 
 In this release, we've added support for monitoring Google Cloud operations
 suite (formerly Stackdriver). The new
-{metricbeat-ref}/metricbeat-metricset-googlecloud-stackdriver.html[stackdriver]
+{metricbeat-ref}/metricbeat-metricset-googlecloud-metrics.html[metrics]
 metricset in the Google Cloud Platform module collects any service metrics from
 Google Cloud by using the `ListTimeSeries` API call.
 

diff --git a/metricbeat/docs/fields.asciidoc b/metricbeat/docs/fields.asciidoc
@@ -18398,10 +18398,10 @@ type: object
 
 --
 
-*`googlecloud.stackdriver.*.*.*.*`*::
+*`googlecloud.metrics.*.*.*.*`*::
 +
 --
-Metrics that returned from StackDriver API query.
+Metrics that returned from Google Cloud API query.
 
 
 type: object

diff --git a/metricbeat/docs/modules/googlecloud.asciidoc b/metricbeat/docs/modules/googlecloud.asciidoc
@@ -145,7 +145,7 @@ For example, if Compute Metricset fetches 14 metrics (which is the number of met
 
 [float]
 == Metricsets
-Currently, we have `compute`, `loadbalancing`, `pubsub`, `stackdriver` and
+Currently, we have `compute`, `loadbalancing`, `pubsub`, `metrics` and
 `storage` metricset in `googlecloud` module.
 
 [float]
@@ -196,10 +196,11 @@ The `pubsub` metricset comes with a predefined dashboard:
 image::./images/metricbeat-googlecloud-pubsub-overview.png[]
 
 [float]
-=== `stackdriver`
-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.
+=== `metrics`
+`metrics` metricset uses Google Cloud Operations/Stackdriver, which 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 https://cloud.google.com/monitoring/api/metrics_gcp[monitoring metrics]
 from Google Cloud using `ListTimeSeries` API.
 
@@ -256,7 +257,7 @@ metricbeat.modules:
 
 - module: googlecloud
   metricsets:
-    - stackdriver
+    - metrics
   project_id: "your project id"
   credentials_file_path: "your JSON credentials file path"
   exclude_labels: false
@@ -280,19 +281,19 @@ The following metricsets are available:
 
 * <<metricbeat-metricset-googlecloud-loadbalancing,loadbalancing>>
 
-* <<metricbeat-metricset-googlecloud-pubsub,pubsub>>
+* <<metricbeat-metricset-googlecloud-metrics,metrics>>
 
-* <<metricbeat-metricset-googlecloud-stackdriver,stackdriver>>
+* <<metricbeat-metricset-googlecloud-pubsub,pubsub>>
 
 * <<metricbeat-metricset-googlecloud-storage,storage>>
 
 include::googlecloud/compute.asciidoc[]
 
 include::googlecloud/loadbalancing.asciidoc[]
 
-include::googlecloud/pubsub.asciidoc[]
+include::googlecloud/metrics.asciidoc[]
 
-include::googlecloud/stackdriver.asciidoc[]
+include::googlecloud/pubsub.asciidoc[]
 
 include::googlecloud/storage.asciidoc[]
 
diff --git a/.../modules/googlecloud/stackdriver.asciidoc → ...docs/modules/googlecloud/metrics.asciidoc b/.../modules/googlecloud/stackdriver.asciidoc → ...docs/modules/googlecloud/metrics.asciidoc
@@ -2,12 +2,12 @@
 This file is generated! See scripts/mage/docs_collector.go
 ////
 
-[[metricbeat-metricset-googlecloud-stackdriver]]
-=== Google Cloud Platform stackdriver metricset
+[[metricbeat-metricset-googlecloud-metrics]]
+=== Google Cloud Platform metrics metricset
 
 beta[]
 
-include::../../../../x-pack/metricbeat/module/googlecloud/stackdriver/_meta/docs.asciidoc[]
+include::../../../../x-pack/metricbeat/module/googlecloud/metrics/_meta/docs.asciidoc[]
 
 
 ==== Fields
@@ -19,5 +19,5 @@ Here is an example document generated by this metricset:
 
 [source,json]
 ----
-include::../../../../x-pack/metricbeat/module/googlecloud/stackdriver/_meta/data.json[]
+include::../../../../x-pack/metricbeat/module/googlecloud/metrics/_meta/data.json[]
 ----
diff --git a/metricbeat/docs/modules_list.asciidoc b/metricbeat/docs/modules_list.asciidoc
@@ -113,8 +113,8 @@ This file is generated! See scripts/mage/docs_collector.go
 |<<metricbeat-module-googlecloud,Google Cloud Platform>>  beta[]   |image:./images/icon-yes.png[Prebuilt dashboards are available]    |  
 .5+| .5+|  |<<metricbeat-metricset-googlecloud-compute,compute>> beta[]  
 |<<metricbeat-metricset-googlecloud-loadbalancing,loadbalancing>> beta[]  
+|<<metricbeat-metricset-googlecloud-metrics,metrics>> beta[]  
 |<<metricbeat-metricset-googlecloud-pubsub,pubsub>> beta[]  
-|<<metricbeat-metricset-googlecloud-stackdriver,stackdriver>> beta[]  
 |<<metricbeat-metricset-googlecloud-storage,storage>> beta[]  
 |<<metricbeat-module-graphite,Graphite>>     |image:./images/icon-no.png[No prebuilt dashboards]    |  
 .1+| .1+|  |<<metricbeat-metricset-graphite-server,server>>   

diff --git a/x-pack/metricbeat/include/list.go b/x-pack/metricbeat/include/list.go
diff --git a/x-pack/metricbeat/metricbeat.reference.yml b/x-pack/metricbeat/metricbeat.reference.yml
@@ -543,7 +543,7 @@ metricbeat.modules:
 
 - module: googlecloud
   metricsets:
-    - stackdriver
+    - metrics
   project_id: "your project id"
   credentials_file_path: "your JSON credentials file path"
   exclude_labels: false

diff --git a/x-pack/metricbeat/module/googlecloud/_meta/config.yml b/x-pack/metricbeat/module/googlecloud/_meta/config.yml
@@ -27,7 +27,7 @@
 
 - module: googlecloud
   metricsets:
-    - stackdriver
+    - metrics
   project_id: "your project id"
   credentials_file_path: "your JSON credentials file path"
   exclude_labels: false

diff --git a/x-pack/metricbeat/module/googlecloud/_meta/docs.asciidoc b/x-pack/metricbeat/module/googlecloud/_meta/docs.asciidoc
@@ -135,7 +135,7 @@ For example, if Compute Metricset fetches 14 metrics (which is the number of met
 
 [float]
 == Metricsets
-Currently, we have `compute`, `loadbalancing`, `pubsub`, `stackdriver` and
+Currently, we have `compute`, `loadbalancing`, `pubsub`, `metrics` and
 `storage` metricset in `googlecloud` module.
 
 [float]
@@ -186,10 +186,11 @@ The `pubsub` metricset comes with a predefined dashboard:
 image::./images/metricbeat-googlecloud-pubsub-overview.png[]
 
 [float]
-=== `stackdriver`
-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.
+=== `metrics`
+`metrics` metricset uses Google Cloud Operations/Stackdriver, which 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 https://cloud.google.com/monitoring/api/metrics_gcp[monitoring metrics]
 from Google Cloud using `ListTimeSeries` API.
 

diff --git a/x-pack/metricbeat/module/googlecloud/_meta/fields.yml b/x-pack/metricbeat/module/googlecloud/_meta/fields.yml
@@ -24,9 +24,9 @@
             - name: system.*
               type: object
               object_type: keyword
-        - name: "stackdriver.*.*.*.*"
+        - name: "metrics.*.*.*.*"
           type: object
           object_type: double
           object_type_mapping_type: "*"
           description: >
-            Metrics that returned from StackDriver API query.
+            Metrics that returned from Google Cloud API query.
diff --git a/x-pack/metricbeat/module/googlecloud/compute/compute_integration_test.go b/x-pack/metricbeat/module/googlecloud/compute/compute_integration_test.go
@@ -13,7 +13,7 @@ import (
 
 	"github.com/elastic/beats/v7/libbeat/common"
 	mbtest "github.com/elastic/beats/v7/metricbeat/mb/testing"
-	"github.com/elastic/beats/v7/x-pack/metricbeat/module/googlecloud/stackdriver"
+	"github.com/elastic/beats/v7/x-pack/metricbeat/module/googlecloud/metrics"
 )
 
 func TestData(t *testing.T) {
@@ -36,7 +36,7 @@ func TestData(t *testing.T) {
 		{"googlecloud.compute.instance.memory", "./_meta/data_memory.json"},
 	}
 
-	config := stackdriver.GetConfigForTest(t, "compute")
+	config := metrics.GetConfigForTest(t, "compute")
 
 	for _, df := range dataFiles {
 		metricSet := mbtest.NewFetcher(t, config)

diff --git a/x-pack/metricbeat/module/googlecloud/compute/compute_test.go b/x-pack/metricbeat/module/googlecloud/compute/compute_test.go
@@ -11,7 +11,7 @@ import (
 
 	// Register input module and metricset
 	_ "github.com/elastic/beats/v7/x-pack/metricbeat/module/googlecloud"
-	_ "github.com/elastic/beats/v7/x-pack/metricbeat/module/googlecloud/stackdriver"
+	_ "github.com/elastic/beats/v7/x-pack/metricbeat/module/googlecloud/metrics"
 )
 
 func init() {

diff --git a/x-pack/metricbeat/module/googlecloud/compute/manifest.yml b/x-pack/metricbeat/module/googlecloud/compute/manifest.yml
@@ -1,7 +1,7 @@
 default: true
 input:
   module: googlecloud
-  metricset: stackdriver
+  metricset: metrics
   defaults:
     metrics:
       - service: compute

diff --git a/x-pack/metricbeat/module/googlecloud/fields.go b/x-pack/metricbeat/module/googlecloud/fields.go
diff --git a/x-pack/metricbeat/module/googlecloud/loadbalancing/loadbalancing_integration_test.go b/x-pack/metricbeat/module/googlecloud/loadbalancing/loadbalancing_integration_test.go
@@ -13,7 +13,7 @@ import (
 
 	"github.com/elastic/beats/v7/libbeat/common"
 	mbtest "github.com/elastic/beats/v7/metricbeat/mb/testing"
-	"github.com/elastic/beats/v7/x-pack/metricbeat/module/googlecloud/stackdriver"
+	"github.com/elastic/beats/v7/x-pack/metricbeat/module/googlecloud/metrics"
 )
 
 func TestData(t *testing.T) {
@@ -34,7 +34,7 @@ func TestData(t *testing.T) {
 		{"googlecloud.loadbalancing.tcp_ssl_proxy", "./_meta/data_tcp_ssl_proxy.json"},
 	}
 
-	config := stackdriver.GetConfigForTest(t, "loadbalancing")
+	config := metrics.GetConfigForTest(t, "loadbalancing")
 
 	for _, df := range dataFiles {
 		metricSet := mbtest.NewFetcher(t, config)

diff --git a/x-pack/metricbeat/module/googlecloud/loadbalancing/loadbalancing_test.go b/x-pack/metricbeat/module/googlecloud/loadbalancing/loadbalancing_test.go
@@ -11,7 +11,7 @@ import (
 
 	// Register input module and metricset
 	_ "github.com/elastic/beats/v7/x-pack/metricbeat/module/googlecloud"
-	_ "github.com/elastic/beats/v7/x-pack/metricbeat/module/googlecloud/stackdriver"
+	_ "github.com/elastic/beats/v7/x-pack/metricbeat/module/googlecloud/metrics"
 )
 
 func init() {

diff --git a/x-pack/metricbeat/module/googlecloud/loadbalancing/manifest.yml b/x-pack/metricbeat/module/googlecloud/loadbalancing/manifest.yml
@@ -1,7 +1,7 @@
 default: false
 input:
   module: googlecloud
-  metricset: stackdriver
+  metricset: metrics
   defaults:
     metrics:
       - service: loadbalancing

diff --git a/x-pack/metricbeat/module/googlecloud/metrics/_meta/data.json b/x-pack/metricbeat/module/googlecloud/metrics/_meta/data.json
@@ -0,0 +1,36 @@
+{
+    "@timestamp": "2017-10-12T08:05:34.853Z",
+    "cloud": {
+        "account": {
+            "id": "elastic-apm"
+        },
+        "instance": {
+            "id": "8867356942891823986",
+            "name": "apm-ui-dev"
+        },
+        "provider": "googlecloud"
+    },
+    "cloud.availability_zone": "europe-west4-a",
+    "event": {
+        "dataset": "googlecloud.metrics",
+        "duration": 115000,
+        "module": "googlecloud"
+    },
+    "googlecloud": {
+        "labels": {},
+        "metrics": {
+            "instance": {
+                "uptime": {
+                    "value": 60
+                }
+            }
+        }
+    },
+    "metricset": {
+        "name": "metrics",
+        "period": 10000
+    },
+    "service": {
+        "type": "googlecloud"
+    }
+}