Rename config spec example consumer option default to `display_defa…

…ult` (DataDog#8593)
kkourtchikov · Feb 11, 2021 · e6bce64 · e6bce64
1 parent 3a7d381
commit e6bce64
Show file tree

Hide file tree

Showing 35 changed files with 133 additions and 132 deletions.
diff --git a/cilium/assets/configuration/spec.yaml b/cilium/assets/configuration/spec.yaml
@@ -16,15 +16,15 @@ files:
       value:
         type: string
         example: http://localhost:9090/metrics
-        default: None
+        display_default: None
     - name: operator_endpoint
       description: |
         Provide instead of `agent_endpoint` to collect `cilium-operator` metrics.
         Cilium operator metrics are exposed on port 6942.
       value:
         type: string
         example: http://localhost:6942/metrics
-        default: None
+        display_default: None
     - template: instances/openmetrics_legacy
       overrides:
         prometheus_url.hidden: true

diff --git a/cisco_aci/assets/configuration/spec.yaml b/cisco_aci/assets/configuration/spec.yaml
@@ -109,5 +109,5 @@ files:
         aws_service.hidden: true
     - template: instances/default
       overrides:
-        min_collection_interval.value.default: 15
+        min_collection_interval.value.display_default: 15
         min_collection_interval.value.example: 180
diff --git a/clickhouse/assets/configuration/spec.yaml b/clickhouse/assets/configuration/spec.yaml
@@ -37,7 +37,7 @@ files:
       description: The database to connect to.
       value:
         type: string
-        default: default
+        display_default: default
     - name: connect_timeout
       description: The timeout for connecting to the `server`.
       value:

diff --git a/cloud_foundry_api/assets/configuration/spec.yaml b/cloud_foundry_api/assets/configuration/spec.yaml
@@ -43,7 +43,7 @@ files:
       value:
         type: integer
         maximum: 5000
-        default: 100
+        display_default: 100
     - template: instances/default
     - template: instances/http
       overrides:
@@ -65,4 +65,3 @@ files:
     options:
     - template: init_config/default
     - template: init_config/http
-
diff --git a/couch/assets/configuration/spec.yaml b/couch/assets/configuration/spec.yaml
@@ -30,7 +30,7 @@ files:
         example:
           - <DATABASE_1>
           - <DATABASE_2>
-        default: all
+        display_default: all
     - name: db_exclude
       description: |
         The `db_exclude` should contain the names of any databases meant to be excluded
@@ -43,7 +43,7 @@ files:
         example:
           - <DATABASE_1>
           - <DATABASE_2>
-        default: None
+        display_default: None
     - name: max_dbs_per_check
       description: Number of databases to scan per check.
       value:
@@ -54,13 +54,13 @@ files:
       value:
         type: string
         example: <ERLANG_NAME>
-        default: None
+        display_default: None
     - name: max_nodes_per_check
       description: CouchDB 2.x only. How many nodes each check reports if no name is provided.
       value:
         type: integer
         example: 10
-        default: 20
+        display_default: 20
     - template: instances/default
     - template: instances/http
       overrides:

diff --git a/datadog_checks_dev/datadog_checks/dev/tooling/specs/configuration/consumers/example.py b/datadog_checks_dev/datadog_checks/dev/tooling/specs/configuration/consumers/example.py
@@ -119,8 +119,8 @@ def write_option(option, writer, indent='', start_list=False):
         example = value.get('example')
         example_type = type(example)
         if not required:
-            if 'default' in value:
-                default = value['default']
+            if 'display_default' in value:
+                default = value['display_default']
                 default_type = type(default)
                 if default is not None and str(default).lower() != 'none':
                     if default_type is str:

diff --git a/datadog_checks_dev/datadog_checks/dev/tooling/templates/configuration/init_config/db.yaml b/datadog_checks_dev/datadog_checks/dev/tooling/templates/configuration/init_config/db.yaml
@@ -8,7 +8,7 @@
     type: array
     items:
       type: object
-    default: null
+    display_default: null
     example:
       - query: <QUERY>
         columns: <COLUMNS>

diff --git a/datadog_checks_dev/datadog_checks/dev/tooling/templates/configuration/init_config/jmx.yaml b/datadog_checks_dev/datadog_checks/dev/tooling/templates/configuration/init_config/jmx.yaml
@@ -21,7 +21,7 @@
   value:
     type: boolean
     example: false
-    default: false
+    display_default: false
 - name: service_check_prefix
   description: |
     Custom service check prefix. e.g. `my_prefix` to get a service check called `my_prefix.can_connect`.

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
@@ -18,7 +18,7 @@
   value:
     type: string
     example: <PREFIX>_
-    default: null
+    display_default: null
 - name: metrics  # Only shown for the `openmetrics` provider integration
   hidden: true
   description: |

diff --git a/..._dev/datadog_checks/dev/tooling/templates/configuration/instances/openmetrics_legacy.yaml b/..._dev/datadog_checks/dev/tooling/templates/configuration/instances/openmetrics_legacy.yaml
@@ -29,7 +29,7 @@
   value:
     type: string
     example: <PREFIX>_
-    default: null
+    display_default: null
 - name: health_service_check
   description: |
     Send a service check reporting about the health of the Prometheus endpoint.

diff --git a/datadog_checks_dev/tests/tooling/configuration/consumers/test_example.py b/datadog_checks_dev/tests/tooling/configuration/consumers/test_example.py
@@ -809,7 +809,7 @@ def test_option_string_type_not_default_example_default_value_none():
             value:
               type: string
               example: something
-              default: None
+              display_default: None
         """
     )
 
@@ -840,7 +840,7 @@ def test_option_string_type_not_default_example_default_value_null():
             value:
               type: string
               example: something
-              default: null
+              display_default: null
         """
     )
 
@@ -1294,7 +1294,7 @@ def test_option_default_example_override_null():
             value:
               type: string
               example: something
-              default: null
+              display_default: null
         """
     )
 
@@ -1325,7 +1325,7 @@ def test_option_default_example_override_string():
             value:
               type: string
               example: something
-              default: bar
+              display_default: bar
         """
     )
 
@@ -1356,7 +1356,7 @@ def test_option_default_example_override_non_string():
             value:
               type: string
               example: something
-              default:
+              display_default:
                 foo: [bar, baz]
         """
     )

diff --git a/disk/assets/configuration/spec.yaml b/disk/assets/configuration/spec.yaml
@@ -190,7 +190,7 @@ files:
               Works on Linux only.
             value:
               example: /run/blkid/blkid.tab
-              default: null
+              display_default: null
               type: string
           - name: device_tag_re
             description: |
@@ -215,7 +215,7 @@ files:
             description: Timeout of the disk query in seconds
             value:
               example: 5
-              default: 5
+              display_default: 5
               type: integer
           - name: create_mounts
             description: |

diff --git a/docs/developer/meta/config-specs.md b/docs/developer/meta/config-specs.md
@@ -127,10 +127,12 @@ It respects a few extra [option](#options)-level attributes:
 
 - `example` - A complete example of an option in lieu of a strictly typed `value` attribute
 - `enabled` - Whether or not to un-comment the option, overriding the behavior of `required`
+- `display_priority` - This is an integer affecting the order in which options are displayed, with higher values indicating higher priority.
+  The default is `0`.
 
 It also respects a few extra fields under the `value` attribute of each option:
 
-- `default` - This is the default value that will be shown in the header of each option, useful if it differs from the `example`.
+- `display_default` - This is the default value that will be shown in the header of each option, useful if it differs from the `example`.
   You may set it to `null` explicitly to disable showing this part of the header.
 - `compact_example` - Whether or not to display complex types like arrays in their most compact representation. It defaults to `false`.
 

diff --git a/go_expvar/assets/configuration/spec.yaml b/go_expvar/assets/configuration/spec.yaml
@@ -18,7 +18,7 @@ files:
       description: Define your namespace that is prefixed to all metrics collected by this check.
       value:
         type: string
-        default: go_expvar
+        display_default: go_expvar
     - name: metrics
       description: |
         These metrics are just here as examples.

diff --git a/istio/assets/configuration/spec.yaml b/istio/assets/configuration/spec.yaml
@@ -12,7 +12,7 @@ files:
             Collect mixer, galley, pilot, and citadel metrics available from the istiod deployment.
             Only available for Istio >= v1.5.
           value:
-            default: null
+            display_default: null
             example: http://istiod.istio-system:15014/metrics
             type: string
         - name: istio_mesh_endpoint
@@ -25,7 +25,7 @@ files:
             When collecting mesh metrics in Istio < v1.5, use
             istio_mesh_endpoint: http://istio-telemetry.istio-system:42422/metrics
           value:
-            default: null
+            display_default: null
             example: http://istio-proxy.istio-system:15090/stats/prometheus
             type: string
         - name: mixer_endpoint
@@ -35,31 +35,31 @@ files:
             If using Istio < v1.1, replace port 15014 with port 9093. See the changes here:
             https://istio.io/about/notes/1.1/#configuration-management
           value:
-            default: null
+            display_default: null
             example: http://istio-telemetry.istio-system:15014/metrics
             type: string
         - name: pilot_endpoint
           description: |
             Define the pilot endpoint in order to collect all Prometheus metrics on the Pilot process.
             Only available for Istio >= v1.1.
           value:
-            default: null
+            display_default: null
             example: http://istio-pilot.istio-system:15014/metrics
             type: string
         - name: galley_endpoint
           description: |
             Define the galley endpoint in order to collect all Prometheus metrics on the Galley process.
             Only available for Istio >= v1.1.
           value:
-            default: null
+            display_default: null
             example: http://istio-galley.istio-system:15014/metrics
             type: string
         - name: citadel_endpoint
           description: |
             Define the citadel endpoint in order to collect all Prometheus metrics on the Citadel process.
             Only available for Istio >= v1.1.
           value:
-            default: null
+            display_default: null
             example: http://istio-citadel.istio-system:15014/metrics
             type: string
         - template: instances/openmetrics_legacy