move disable_legacy_service_tag up in the conf.yaml.example (#21743)

* Slight re-arragement of config params

* changelog

* Update spec.yaml

* Update conf.yaml.example

* Update 21743.fixed

Author: steveny91

consul/assets/configuration/spec.yaml

@@ -9,6 +9,7 @@ files:
   - template: instances
     options:
     - name: url
+      display_priority: 2
       required: true
       description: |
         Where your Consul HTTP server lives,
@@ -125,9 +126,10 @@ files:
         example: 1
 
     - name: disable_legacy_service_tag
+      display_priority: 1
       description: |
-        Whether or not to stop submitting the tag `service` that has been renamed
-        to `consul_service` and disable the associated deprecation warning.
+        Whether to stop submitting the `service` tag, which has been renamed to `consul_service`, and to disable 
+        the associated deprecation warning. Datadog recommends setting this to `true`.
       value:
         type: boolean
         display_default: false

consul/changelog.d/21743.fixed

@@ -0,0 +1 @@
+Move `disable_legacy_service_tag` config param up in conf.yaml.example

consul/datadog_checks/consul/data/conf.yaml.example

@@ -52,6 +52,12 @@ instances:
     #
   - url: http://localhost:8500
 
+    ## @param disable_legacy_service_tag - boolean - optional - default: false
+    ## Whether to stop submitting the `service` tag, which has been renamed to `consul_service`, and to disable 
+    ## the associated deprecation warning. Datadog recommends setting this to `true`.
+    #
+    disable_legacy_service_tag: true
+
     ## @param use_prometheus_endpoint - boolean - optional - default: false
     ## Whether to use the Prometheus endpoint to get more metrics.
     ## The Prometheus endpoint is available for Consul versions v1.1.0 or higher.
@@ -136,12 +142,6 @@ instances:
     #
     # threads_count: 1
 
-    ## @param disable_legacy_service_tag - boolean - optional - default: false
-    ## Whether or not to stop submitting the tag `service` that has been renamed
-    ## to `consul_service` and disable the associated deprecation warning.
-    #
-    disable_legacy_service_tag: true
-
     ## @param collect_health_checks - boolean - optional - default: false
     ## Whether to enable new service health checks from this instance. Enabling this will
     ## also emit an event for every failed service health check.