Add legacy field in spec (#22333)

* add legacy field in spec

* more legacy fields

* changelog

* add legacy to allowlist

Author: steveny91

aerospike/assets/configuration/spec.yaml

@@ -7,6 +7,7 @@ files:
     - template: init_config/openmetrics
     - name: mappings
       hidden: true
+      legacy: true
       description: |
         Rate mappings. DO NOT EDIT unless you know what you're doing.
         See https://github.com/aerospike-community/aerospike-collectd/blob/master/aerospike_schema.yaml
@@ -371,18 +372,21 @@ files:
         openmetrics_endpoint.value.example: http://127.0.0.1:9145/metrics
     - name: host
       hidden: true
+      legacy: true
       description: Aerospike host to connect to.
       value:
         type: string
         example: localhost
     - name: port
       hidden: true
+      legacy: true
       description: Aerospike port to connect to.
       value:
         type: integer
         example: 3000
     - name: tls_name
       hidden: true
+      legacy: true
       value:
         type: string
       description: |
@@ -392,6 +396,7 @@ files:
         Note: TLS usage requires Aerospike Enterprise Edition
     - name: tls_config
       hidden: true
+      legacy: true
       description: |
         Note TLS usage requires Aerospike Enterprise Edition
         Key value pairs with a choice of the following elements:
@@ -414,6 +419,7 @@ files:
          keyfile: <KEY_FILE>
     - name: metrics
       hidden: true
+      legacy: true
       description: |
         All metrics collected by default. You probably don't want to do this,
         so list the ones you do want here. Check with:
@@ -427,6 +433,7 @@ files:
           - migrate_tx_objs
     - name: namespaces
       hidden: true
+      legacy: true
       description: All namespaces are collected by default. If you want to collect specific namespaces specify them here.
       value:
         type: array
@@ -437,6 +444,7 @@ files:
           - another_example_namespace
     - name: datacenters
       hidden: true
+      legacy: true
       description: |
         For Aerospike v4 or lower, all datacenters are collected by default.
         If you want to collect specific datacenters specify them here.
@@ -451,6 +459,7 @@ files:
           - another_example_datacenter
     - name: namespace_metrics
       hidden: true
+      legacy: true
       description: |
         All Namespace metrics collected by default. You probably don't want to do this,
         so list the ones you do want here. Check with:
@@ -471,6 +480,7 @@ files:
           - migrate-tx-partitions-remaining
     - name: datacenter_metrics
       hidden: true
+      legacy: true
       description: |
         All datacenter metrics collected by default. Specify which metrics you want here.
         List datacenters using this command:

datadog_checks_dev/changelog.d/22333.added

@@ -0,0 +1 @@
+Add legacy field in spec for legacy options

datadog_checks_dev/datadog_checks/dev/tooling/configuration/consumers/example.py

@@ -14,6 +14,7 @@
     'hidden',
     'display_priority',
     'deprecation',
+    'legacy',
     'multiple',
     'multiple_instances_defined',
     'metadata_tags',

datadog_checks_dev/datadog_checks/dev/tooling/templates/configuration/instances/pdh_legacy.yaml

@@ -1,4 +1,5 @@
 - name: host
+  legacy: true
   required: false
   description: |
     The host the current check connects to.
@@ -7,16 +8,19 @@
     example: .
     type: string
 - name: username
+  legacy: true
   required: false
   description: The username from the credentials needed to connect to the host.
   value:
     type: string
 - name: password
+  legacy: true
   required: false
   description: The password from the credentials needed to connect to the host.
   value:
     type: string
 - name: additional_metrics
+  legacy: true
   required: false
   description: |
     The additional metrics is a list of items that represent additional counters to collect.
@@ -43,6 +47,7 @@
       items:
         type: string
 - name: counter_data_types
+  legacy: true
   required: false
   description: |
     counter_data_types is a list of <METRIC_NAME>,<DATA_TYPE> elements that

envoy/assets/configuration/spec.yaml

@@ -15,6 +15,7 @@ files:
         openmetrics_endpoint.required: false
         openmetrics_endpoint.enabled: true
     - name: stats_url
+      legacy: true
       display_priority: 1
       description: |
         The check will collect and parse metrics from the admin /stats/ endpoint.
@@ -31,6 +32,7 @@ files:
         type: string
     - name: included_metrics
       hidden: true
+      legacy: true
       description: |
         Includes metrics using regular expressions.
         The filtering occurs before tag extraction, so you have the option
@@ -49,6 +51,7 @@ files:
           - cluster\.(in|out)\..*
     - name: excluded_metrics
       hidden: true
+      legacy: true
       description: |
         Excludes metrics using regular expressions.
         The filtering occurs before tag extraction, so you have the option
@@ -67,6 +70,7 @@ files:
           - ^http\..*
     - name: cache_metrics
       hidden: true
+      legacy: true
       description: |
         Results are cached by default to decrease CPU utilization, at
         the expense of some memory. Disable by setting this to false.
@@ -75,13 +79,15 @@ files:
         example: true
     - name: parse_unknown_metrics
       hidden: true
+      legacy: true
       description: |
         Attempt parsing of metrics that are unknown and will otherwise be skipped.
       value:
         type: boolean
         example: false
     - name: collect_server_info
       hidden: true
+      legacy: true
       description: |
         Collect Envoy version by accessing the `/server_info` endpoint.
         Disable this if this endpoint is not reachable by the agent.
@@ -90,6 +96,7 @@ files:
         example: true
     - name: disable_legacy_cluster_tag
       hidden: true
+      legacy: true
       description: |
         Enable to stop submitting the tags `cluster_name` and `virtual_cluster_name`,
         which has been renamed to `envoy_cluster` and `virtual_envoy_cluster`.

gitlab/assets/configuration/spec.yaml

@@ -27,6 +27,7 @@ files:
       description: |
         Deprecated alias for `prometheus_url`.
       hidden: true
+      legacy: true
       value:
         type: string
     - name: gitaly_server_endpoint

haproxy/assets/configuration/spec.yaml

@@ -39,6 +39,7 @@ files:
         prometheus_url.required: false
     - name: url
       enabled: true
+      legacy: true
       value:
         example: http://localhost/admin?stats
         type: string
@@ -50,6 +51,7 @@ files:
 
         NOTE: This only takes effect when `use_openmetrics` is set to `false`.
     - name: status_check
+      legacy: true
       value:
         example: false
         type: boolean
@@ -60,6 +62,7 @@ files:
 
         NOTE: This only takes effect when `use_openmetrics` is set to `false`.
     - name: collect_aggregates_only
+      legacy: true
       value:
         anyOf:
           - type: boolean
@@ -76,6 +79,7 @@ files:
 
         NOTE: This only takes effect when `use_openmetrics` is set to `false`.
     - name: collect_status_metrics
+      legacy: true
       value:
         example: false
         type: boolean
@@ -84,6 +88,7 @@ files:
 
         NOTE: This only takes effect when `use_openmetrics` is set to `false`.
     - name: collect_status_metrics_by_host
+      legacy: true
       value:
         example: false
         type: boolean
@@ -93,6 +98,7 @@ files:
 
         NOTE: This only takes effect when `use_openmetrics` is set to `false`.
     - name: collate_status_tags_per_host
+      legacy: true
       value:
         example: true
         type: boolean
@@ -102,6 +108,7 @@ files:
 
         NOTE: This only takes effect when `use_openmetrics` is set to `false`.
     - name: count_status_by_service
+      legacy: true
       value:
         example: true
         type: boolean
@@ -111,6 +118,7 @@ files:
 
         NOTE: This only takes effect when `use_openmetrics` is set to `false`.
     - name: tag_service_check_by_host
+      legacy: true
       value:
         example: false
         type: boolean
@@ -120,6 +128,7 @@ files:
 
         NOTE: This only takes effect when `use_openmetrics` is set to `false`.
     - name: services_include
+      legacy: true
       value:
         example:
         - <SERVICE_NAME_1>
@@ -133,6 +142,7 @@ files:
 
         NOTE: This only takes effect when `use_openmetrics` is set to `false`.
     - name: services_exclude
+      legacy: true
       value:
         example:
         - .*
@@ -145,6 +155,7 @@ files:
 
         NOTE: This only takes effect when `use_openmetrics` is set to `false`.
     - name: disable_legacy_service_tag
+      legacy: true
       value:
         example: false
         type: boolean
@@ -154,6 +165,7 @@ files:
 
         NOTE: This only takes effect when `use_openmetrics` is set to `false`.
     - name: active_tag
+      legacy: true
       value:
         example: false
         type: boolean
@@ -163,12 +175,14 @@ files:
 
         NOTE: This only takes effect when `use_openmetrics` is set to `false`.
     - name: enable_service_check
+      legacy: true
       value:
         example: false
         type: boolean
       description: |
         Enable the Haproxy service check.
     - name: tags_regex
+      legacy: true
       value:
         type: string
       description: |
@@ -182,6 +196,7 @@ files:
 
         NOTE: This only takes effect when `use_openmetrics` is set to `false`.
     - name: startup_grace_seconds
+      legacy: true
       value:
         example: 0
         type: number

kong/assets/configuration/spec.yaml

@@ -17,6 +17,7 @@ files:
         extra_metrics.value.example:
         - kong_memory_workers_lua_vms_bytes: memory.workers.lua.vms.bytes
     - name: kong_status_url
+      legacy: true
       fleet_configurable: true
       display_priority: 1
       description: |