Skip to content

Commit 354257e

Browse files
authored
Set display_priority on shared configuration template fields (DataDog#23311)
* Set display_priority on shared configuration template fields * Regenerate conf.yaml.example for mysql and postgres * Regenerate conf.yaml.example for all integrations; update datadog_checks_dev tests - Sync 219 conf.yaml.example files (and related auto_conf/conf.yaml.default) that were out of sync after adding display_priority to shared templates - Update datadog_checks_dev unit tests to reflect new display_priority values and field ordering in template-generated configs * Keep tags, service, min_collection_interval at display_priority: 0 * Regenerate conf.yaml.example for mysql and postgres * Reset all template display_priority to 0 * Revert all non-template file changes * Fix test_template.py expectations for explicit display_priority: 0 in templates * Add perf counters
1 parent 596211f commit 354257e

20 files changed

Lines changed: 151 additions & 0 deletions

File tree

datadog_checks_dev/datadog_checks/dev/tooling/templates/configuration/common/perf_counters.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
- name: metrics
2+
display_priority: 0
23
fleet_configurable: true
34
description: |
45
This mapping defines which metrics to collect from the performance

datadog_checks_dev/datadog_checks/dev/tooling/templates/configuration/init_config/db.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
- name: global_custom_queries
2+
display_priority: 0
23
fleet_configurable: true
34
description: |
45
See `custom_queries` defined below.

datadog_checks_dev/datadog_checks/dev/tooling/templates/configuration/init_config/http.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
- name: proxy
2+
display_priority: 0
23
fleet_configurable: true
34
value:
45
example:
@@ -31,6 +32,7 @@
3132
the client or proxy. If you want to resolve the domains on the proxy
3233
server, use `socks5h` as the scheme.
3334
- name: skip_proxy
35+
display_priority: 0
3436
fleet_configurable: true
3537
value:
3638
example: false
@@ -39,6 +41,7 @@
3941
If set to `true`, this makes the check bypass any proxy
4042
settings enabled and attempt to reach services directly.
4143
- name: timeout
44+
display_priority: 0
4245
fleet_configurable: true
4346
value:
4447
example: 10

datadog_checks_dev/datadog_checks/dev/tooling/templates/configuration/init_config/jmx.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
- name: is_jmx
2+
display_priority: 0
23
required: true
34
description: Whether or not this file is a configuration for a JMX integration.
45
value:
56
example: true
67
type: boolean
78
fleet_configurable: true
89
- name: collect_default_metrics
10+
display_priority: 0
911
description: Whether or not the check should collect all default metrics.
1012
enabled: true
1113
value:
@@ -14,6 +16,7 @@
1416
type: boolean
1517
fleet_configurable: true
1618
- name: new_gc_metrics
19+
display_priority: 0
1720
description: |
1821
Set to true to use better metric names for garbage collection metrics.
1922
jvm.gc.cms.count => jvm.gc.minor_collection_count
@@ -28,13 +31,15 @@
2831
type: boolean
2932
fleet_configurable: true
3033
- name: service_check_prefix
34+
display_priority: 0
3135
description: |
3236
Custom service check prefix. e.g. `my_prefix` to get a service check called `my_prefix.can_connect`.
3337
If not set, the default service check used is the integration name.
3438
value:
3539
type: string
3640
fleet_configurable: true
3741
- name: conf
42+
display_priority: 0
3843
description: |
3944
The list of metrics to be collected by the integration
4045
Read http://docs.datadoghq.com/integrations/java/ to learn how to customize it

datadog_checks_dev/datadog_checks/dev/tooling/templates/configuration/init_config/perf_counters.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
- name: use_localized_counters
2+
display_priority: 0
23
description: |
34
Whether performance object and counter names should refer to their
45
locale-specific versions rather than their English name.

datadog_checks_dev/datadog_checks/dev/tooling/templates/configuration/init_config/service.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
name: service
2+
display_priority: 0
23
value:
34
type: string
45
description: |

datadog_checks_dev/datadog_checks/dev/tooling/templates/configuration/init_config/tags.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
name: tags
2+
display_priority: 0
23
value:
34
example:
45
- <KEY_1>:<VALUE_1>

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
- name: only_custom_queries
2+
display_priority: 0
23
fleet_configurable: true
34
description: |
45
Set this parameter to `true` if you want to skip the integration's default metrics collection.
@@ -7,6 +8,7 @@
78
type: boolean
89
example: false
910
- name: use_global_custom_queries
11+
display_priority: 0
1012
fleet_configurable: true
1113
description: |
1214
How `global_custom_queries` should be used for this instance. There are 3 options:
@@ -18,6 +20,7 @@
1820
type: string
1921
example: "true"
2022
- name: custom_queries
23+
display_priority: 0
2124
fleet_configurable: true
2225
description: |
2326
Each query must have 2 fields, and can have a third optional field:

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
- template: instances/all_integrations
22
- name: disable_generic_tags
3+
display_priority: 0
34
description: |
45
Generic tags such as `cluster` will be replaced by <integration_name>_cluster to avoid
56
getting mixed with other integration tags.
@@ -10,6 +11,7 @@
1011
hidden: true
1112
fleet_configurable: true
1213
- name: enable_legacy_tags_normalization
14+
display_priority: 0
1315
description: |
1416
Whether to enable legacy tags normalization. When enabled (default), hyphens in tag
1517
values are replaced with underscores. Set to `false` to preserve hyphens, which is
@@ -21,6 +23,7 @@
2123
hidden: true
2224
fleet_configurable: true
2325
- name: metric_patterns
26+
display_priority: 0
2427
description: |
2528
A mapping of metrics to include or exclude, with each entry being a regular expression.
2629

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
- name: min_collection_interval
2+
display_priority: 0
23
value:
34
example: 15
45
type: number
@@ -7,6 +8,7 @@
78
https://docs.datadoghq.com/developers/write_agent_check/#collection-interval
89
fleet_configurable: true
910
- name: empty_default_hostname
11+
display_priority: 0
1012
value:
1113
example: false
1214
type: boolean

0 commit comments

Comments
 (0)