Fix extra metrics description example (#12043)

* update extra_metrics docs * Only do for extra metrics * Sync config
DataDog · May 18, 2022 · 33a3f37 · 33a3f37
1 parent 13e063d
commit 33a3f37
Show file tree

Hide file tree

Showing 17 changed files with 68 additions and 68 deletions.
diff --git a/aerospike/datadog_checks/aerospike/data/conf.yaml.example b/aerospike/datadog_checks/aerospike/data/conf.yaml.example
@@ -64,22 +64,22 @@ instances:
     ## 1. If the item is a string, then it represents the exposed metric name, and
     ##    the sent metric name will be identical. For example:
     ##
-    ##      metrics:
+    ##      extra_metrics:
     ##      - <METRIC_1>
     ##      - <METRIC_2>
     ## 2. If the item is a mapping, then the keys represent the exposed metric names.
     ##
     ##      a. If a value is a string, then it represents the sent metric name. For example:
     ##
-    ##           metrics:
+    ##           extra_metrics:
     ##           - <EXPOSED_METRIC_1>: <SENT_METRIC_1>
     ##           - <EXPOSED_METRIC_2>: <SENT_METRIC_2>
     ##      b. If a value is a mapping, then it must have a `name` and/or `type` key.
     ##         The `name` represents the sent metric name, and the `type` represents how
     ##         the metric should be handled, overriding any type information the endpoint
     ##         may provide. For example:
     ##
-    ##           metrics:
+    ##           extra_metrics:
     ##           - <EXPOSED_METRIC_1>:
     ##               name: <SENT_METRIC_1>
     ##               type: <METRIC_TYPE_1>
@@ -97,7 +97,7 @@ instances:
     ##
     ## Regular expressions may be used to match the exposed metric names, for example:
     ##
-    ##   metrics:
+    ##   extra_metrics:
     ##   - ^network_(ingress|egress)_.+
     ##   - .+:
     ##       type: gauge

diff --git a/amazon_msk/datadog_checks/amazon_msk/data/conf.yaml.example b/amazon_msk/datadog_checks/amazon_msk/data/conf.yaml.example
@@ -115,22 +115,22 @@ instances:
     ## 1. If the item is a string, then it represents the exposed metric name, and
     ##    the sent metric name will be identical. For example:
     ##
-    ##      metrics:
+    ##      extra_metrics:
     ##      - <METRIC_1>
     ##      - <METRIC_2>
     ## 2. If the item is a mapping, then the keys represent the exposed metric names.
     ##
     ##      a. If a value is a string, then it represents the sent metric name. For example:
     ##
-    ##           metrics:
+    ##           extra_metrics:
     ##           - <EXPOSED_METRIC_1>: <SENT_METRIC_1>
     ##           - <EXPOSED_METRIC_2>: <SENT_METRIC_2>
     ##      b. If a value is a mapping, then it must have a `name` and/or `type` key.
     ##         The `name` represents the sent metric name, and the `type` represents how
     ##         the metric should be handled, overriding any type information the endpoint
     ##         may provide. For example:
     ##
-    ##           metrics:
+    ##           extra_metrics:
     ##           - <EXPOSED_METRIC_1>:
     ##               name: <SENT_METRIC_1>
     ##               type: <METRIC_TYPE_1>
@@ -148,7 +148,7 @@ instances:
     ##
     ## Regular expressions may be used to match the exposed metric names, for example:
     ##
-    ##   metrics:
+    ##   extra_metrics:
     ##   - ^network_(ingress|egress)_.+
     ##   - .+:
     ##       type: gauge

diff --git a/arangodb/datadog_checks/arangodb/data/conf.yaml.example b/arangodb/datadog_checks/arangodb/data/conf.yaml.example
@@ -64,22 +64,22 @@ instances:
     ## 1. If the item is a string, then it represents the exposed metric name, and
     ##    the sent metric name will be identical. For example:
     ##
-    ##      metrics:
+    ##      extra_metrics:
     ##      - <METRIC_1>
     ##      - <METRIC_2>
     ## 2. If the item is a mapping, then the keys represent the exposed metric names.
     ##
     ##      a. If a value is a string, then it represents the sent metric name. For example:
     ##
-    ##           metrics:
+    ##           extra_metrics:
     ##           - <EXPOSED_METRIC_1>: <SENT_METRIC_1>
     ##           - <EXPOSED_METRIC_2>: <SENT_METRIC_2>
     ##      b. If a value is a mapping, then it must have a `name` and/or `type` key.
     ##         The `name` represents the sent metric name, and the `type` represents how
     ##         the metric should be handled, overriding any type information the endpoint
     ##         may provide. For example:
     ##
-    ##           metrics:
+    ##           extra_metrics:
     ##           - <EXPOSED_METRIC_1>:
     ##               name: <SENT_METRIC_1>
     ##               type: <METRIC_TYPE_1>
@@ -97,7 +97,7 @@ instances:
     ##
     ## Regular expressions may be used to match the exposed metric names, for example:
     ##
-    ##   metrics:
+    ##   extra_metrics:
     ##   - ^network_(ingress|egress)_.+
     ##   - .+:
     ##       type: gauge

diff --git a/avi_vantage/datadog_checks/avi_vantage/data/conf.yaml.example b/avi_vantage/datadog_checks/avi_vantage/data/conf.yaml.example
@@ -75,22 +75,22 @@ instances:
     ## 1. If the item is a string, then it represents the exposed metric name, and
     ##    the sent metric name will be identical. For example:
     ##
-    ##      metrics:
+    ##      extra_metrics:
     ##      - <METRIC_1>
     ##      - <METRIC_2>
     ## 2. If the item is a mapping, then the keys represent the exposed metric names.
     ##
     ##      a. If a value is a string, then it represents the sent metric name. For example:
     ##
-    ##           metrics:
+    ##           extra_metrics:
     ##           - <EXPOSED_METRIC_1>: <SENT_METRIC_1>
     ##           - <EXPOSED_METRIC_2>: <SENT_METRIC_2>
     ##      b. If a value is a mapping, then it must have a `name` and/or `type` key.
     ##         The `name` represents the sent metric name, and the `type` represents how
     ##         the metric should be handled, overriding any type information the endpoint
     ##         may provide. For example:
     ##
-    ##           metrics:
+    ##           extra_metrics:
     ##           - <EXPOSED_METRIC_1>:
     ##               name: <SENT_METRIC_1>
     ##               type: <METRIC_TYPE_1>
@@ -108,7 +108,7 @@ instances:
     ##
     ## Regular expressions may be used to match the exposed metric names, for example:
     ##
-    ##   metrics:
+    ##   extra_metrics:
     ##   - ^network_(ingress|egress)_.+
     ##   - .+:
     ##       type: gauge

diff --git a/calico/datadog_checks/calico/data/conf.yaml.example b/calico/datadog_checks/calico/data/conf.yaml.example
@@ -64,22 +64,22 @@ instances:
     ## 1. If the item is a string, then it represents the exposed metric name, and
     ##    the sent metric name will be identical. For example:
     ##
-    ##      metrics:
+    ##      extra_metrics:
     ##      - <METRIC_1>
     ##      - <METRIC_2>
     ## 2. If the item is a mapping, then the keys represent the exposed metric names.
     ##
     ##      a. If a value is a string, then it represents the sent metric name. For example:
     ##
-    ##           metrics:
+    ##           extra_metrics:
     ##           - <EXPOSED_METRIC_1>: <SENT_METRIC_1>
     ##           - <EXPOSED_METRIC_2>: <SENT_METRIC_2>
     ##      b. If a value is a mapping, then it must have a `name` and/or `type` key.
     ##         The `name` represents the sent metric name, and the `type` represents how
     ##         the metric should be handled, overriding any type information the endpoint
     ##         may provide. For example:
     ##
-    ##           metrics:
+    ##           extra_metrics:
     ##           - <EXPOSED_METRIC_1>:
     ##               name: <SENT_METRIC_1>
     ##               type: <METRIC_TYPE_1>
@@ -97,7 +97,7 @@ instances:
     ##
     ## Regular expressions may be used to match the exposed metric names, for example:
     ##
-    ##   metrics:
+    ##   extra_metrics:
     ##   - ^network_(ingress|egress)_.+
     ##   - .+:
     ##       type: gauge

diff --git a/cilium/datadog_checks/cilium/data/conf.yaml.example b/cilium/datadog_checks/cilium/data/conf.yaml.example
@@ -80,22 +80,22 @@ instances:
     ## 1. If the item is a string, then it represents the exposed metric name, and
     ##    the sent metric name will be identical. For example:
     ##
-    ##      metrics:
+    ##      extra_metrics:
     ##      - <METRIC_1>
     ##      - <METRIC_2>
     ## 2. If the item is a mapping, then the keys represent the exposed metric names.
     ##
     ##      a. If a value is a string, then it represents the sent metric name. For example:
     ##
-    ##           metrics:
+    ##           extra_metrics:
     ##           - <EXPOSED_METRIC_1>: <SENT_METRIC_1>
     ##           - <EXPOSED_METRIC_2>: <SENT_METRIC_2>
     ##      b. If a value is a mapping, then it must have a `name` and/or `type` key.
     ##         The `name` represents the sent metric name, and the `type` represents how
     ##         the metric should be handled, overriding any type information the endpoint
     ##         may provide. For example:
     ##
-    ##           metrics:
+    ##           extra_metrics:
     ##           - <EXPOSED_METRIC_1>:
     ##               name: <SENT_METRIC_1>
     ##               type: <METRIC_TYPE_1>
@@ -113,7 +113,7 @@ instances:
     ##
     ## Regular expressions may be used to match the exposed metric names, for example:
     ##
-    ##   metrics:
+    ##   extra_metrics:
     ##   - ^network_(ingress|egress)_.+
     ##   - .+:
     ##       type: gauge

diff --git a/cockroachdb/datadog_checks/cockroachdb/data/conf.yaml.example b/cockroachdb/datadog_checks/cockroachdb/data/conf.yaml.example
@@ -65,22 +65,22 @@ instances:
     ## 1. If the item is a string, then it represents the exposed metric name, and
     ##    the sent metric name will be identical. For example:
     ##
-    ##      metrics:
+    ##      extra_metrics:
     ##      - <METRIC_1>
     ##      - <METRIC_2>
     ## 2. If the item is a mapping, then the keys represent the exposed metric names.
     ##
     ##      a. If a value is a string, then it represents the sent metric name. For example:
     ##
-    ##           metrics:
+    ##           extra_metrics:
     ##           - <EXPOSED_METRIC_1>: <SENT_METRIC_1>
     ##           - <EXPOSED_METRIC_2>: <SENT_METRIC_2>
     ##      b. If a value is a mapping, then it must have a `name` and/or `type` key.
     ##         The `name` represents the sent metric name, and the `type` represents how
     ##         the metric should be handled, overriding any type information the endpoint
     ##         may provide. For example:
     ##
-    ##           metrics:
+    ##           extra_metrics:
     ##           - <EXPOSED_METRIC_1>:
     ##               name: <SENT_METRIC_1>
     ##               type: <METRIC_TYPE_1>
@@ -98,7 +98,7 @@ instances:
     ##
     ## Regular expressions may be used to match the exposed metric names, for example:
     ##
-    ##   metrics:
+    ##   extra_metrics:
     ##   - ^network_(ingress|egress)_.+
     ##   - .+:
     ##       type: gauge

diff --git a/coredns/datadog_checks/coredns/data/conf.yaml.example b/coredns/datadog_checks/coredns/data/conf.yaml.example
@@ -87,22 +87,22 @@ instances:
     ## 1. If the item is a string, then it represents the exposed metric name, and
     ##    the sent metric name will be identical. For example:
     ##
-    ##      metrics:
+    ##      extra_metrics:
     ##      - <METRIC_1>
     ##      - <METRIC_2>
     ## 2. If the item is a mapping, then the keys represent the exposed metric names.
     ##
     ##      a. If a value is a string, then it represents the sent metric name. For example:
     ##
-    ##           metrics:
+    ##           extra_metrics:
     ##           - <EXPOSED_METRIC_1>: <SENT_METRIC_1>
     ##           - <EXPOSED_METRIC_2>: <SENT_METRIC_2>
     ##      b. If a value is a mapping, then it must have a `name` and/or `type` key.
     ##         The `name` represents the sent metric name, and the `type` represents how
     ##         the metric should be handled, overriding any type information the endpoint
     ##         may provide. For example:
     ##
-    ##           metrics:
+    ##           extra_metrics:
     ##           - <EXPOSED_METRIC_1>:
     ##               name: <SENT_METRIC_1>
     ##               type: <METRIC_TYPE_1>
@@ -120,7 +120,7 @@ instances:
     ##
     ## Regular expressions may be used to match the exposed metric names, for example:
     ##
-    ##   metrics:
+    ##   extra_metrics:
     ##   - ^network_(ingress|egress)_.+
     ##   - .+:
     ##       type: gauge

diff --git a/..._checks_dev/datadog_checks/dev/tooling/templates/configuration/instances/openmetrics.yaml b/..._checks_dev/datadog_checks/dev/tooling/templates/configuration/instances/openmetrics.yaml
@@ -90,22 +90,22 @@
     1. If the item is a string, then it represents the exposed metric name, and
        the sent metric name will be identical. For example:
 
-         metrics:
+         extra_metrics:
          - <METRIC_1>
          - <METRIC_2>
     2. If the item is a mapping, then the keys represent the exposed metric names.
 
          a. If a value is a string, then it represents the sent metric name. For example:
 
-              metrics:
+              extra_metrics:
               - <EXPOSED_METRIC_1>: <SENT_METRIC_1>
               - <EXPOSED_METRIC_2>: <SENT_METRIC_2>
          b. If a value is a mapping, then it must have a `name` and/or `type` key.
             The `name` represents the sent metric name, and the `type` represents how
             the metric should be handled, overriding any type information the endpoint
             may provide. For example:
 
-              metrics:
+              extra_metrics:
               - <EXPOSED_METRIC_1>:
                   name: <SENT_METRIC_1>
                   type: <METRIC_TYPE_1>
@@ -123,7 +123,7 @@
     
     Regular expressions may be used to match the exposed metric names, for example:
 
-      metrics:
+      extra_metrics:
       - ^network_(ingress|egress)_.+
       - .+:
           type: gauge

diff --git a/envoy/datadog_checks/envoy/data/conf.yaml.example b/envoy/datadog_checks/envoy/data/conf.yaml.example
@@ -76,22 +76,22 @@ instances:
     ## 1. If the item is a string, then it represents the exposed metric name, and
     ##    the sent metric name will be identical. For example:
     ##
-    ##      metrics:
+    ##      extra_metrics:
     ##      - <METRIC_1>
     ##      - <METRIC_2>
     ## 2. If the item is a mapping, then the keys represent the exposed metric names.
     ##
     ##      a. If a value is a string, then it represents the sent metric name. For example:
     ##
-    ##           metrics:
+    ##           extra_metrics:
     ##           - <EXPOSED_METRIC_1>: <SENT_METRIC_1>
     ##           - <EXPOSED_METRIC_2>: <SENT_METRIC_2>
     ##      b. If a value is a mapping, then it must have a `name` and/or `type` key.
     ##         The `name` represents the sent metric name, and the `type` represents how
     ##         the metric should be handled, overriding any type information the endpoint
     ##         may provide. For example:
     ##
-    ##           metrics:
+    ##           extra_metrics:
     ##           - <EXPOSED_METRIC_1>:
     ##               name: <SENT_METRIC_1>
     ##               type: <METRIC_TYPE_1>
@@ -109,7 +109,7 @@ instances:
     ##
     ## Regular expressions may be used to match the exposed metric names, for example:
     ##
-    ##   metrics:
+    ##   extra_metrics:
     ##   - ^network_(ingress|egress)_.+
     ##   - .+:
     ##       type: gauge

diff --git a/haproxy/datadog_checks/haproxy/data/conf.yaml.example b/haproxy/datadog_checks/haproxy/data/conf.yaml.example
@@ -76,22 +76,22 @@ instances:
     ## 1. If the item is a string, then it represents the exposed metric name, and
     ##    the sent metric name will be identical. For example:
     ##
-    ##      metrics:
+    ##      extra_metrics:
     ##      - <METRIC_1>
     ##      - <METRIC_2>
     ## 2. If the item is a mapping, then the keys represent the exposed metric names.
     ##
     ##      a. If a value is a string, then it represents the sent metric name. For example:
     ##
-    ##           metrics:
+    ##           extra_metrics:
     ##           - <EXPOSED_METRIC_1>: <SENT_METRIC_1>
     ##           - <EXPOSED_METRIC_2>: <SENT_METRIC_2>
     ##      b. If a value is a mapping, then it must have a `name` and/or `type` key.
     ##         The `name` represents the sent metric name, and the `type` represents how
     ##         the metric should be handled, overriding any type information the endpoint
     ##         may provide. For example:
     ##
-    ##           metrics:
+    ##           extra_metrics:
     ##           - <EXPOSED_METRIC_1>:
     ##               name: <SENT_METRIC_1>
     ##               type: <METRIC_TYPE_1>
@@ -109,7 +109,7 @@ instances:
     ##
     ## Regular expressions may be used to match the exposed metric names, for example:
     ##
-    ##   metrics:
+    ##   extra_metrics:
     ##   - ^network_(ingress|egress)_.+
     ##   - .+:
     ##       type: gauge