Skip to content

Commit c494756

Browse files
authored
Touch up on the config template (#21879)
* style touch up * changelog
1 parent 323bd27 commit c494756

File tree

4 files changed

+33
-32
lines changed

4 files changed

+33
-32
lines changed

elastic/assets/configuration/spec.yaml

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ files:
1111
- name: url
1212
required: true
1313
description: |
14-
The URL where elasticsearch accepts HTTP requests. This is used to
14+
The URL where Elasticsearch accepts HTTP requests. This is used to
1515
fetch statistics from the nodes and information about the cluster health.
1616
value:
1717
example: http://localhost:9200
@@ -27,8 +27,8 @@ files:
2727
example: false
2828
- name: cluster_stats
2929
description: |
30-
If your cluster is hosted externally (i.e., you're not pointing to localhost)
31-
you must to set `cluster_stats` to true otherwise the check only
30+
If your cluster is hosted externally (i.e., you're not pointing to localhost),
31+
you must set `cluster_stats` to true, otherwise the check only
3232
submits metrics of the local node.
3333
This parameter was also called `is_external` and you can still use it but it
3434
is removed in Agent version 6+.
@@ -44,39 +44,39 @@ files:
4444
type: boolean
4545
example: false
4646
- name: index_stats
47-
description: Set "index_stats" to true to collect metrics for individual indices.
47+
description: Set `index_stats` to true to collect metrics for individual indices.
4848
value:
4949
type: boolean
5050
example: false
5151
- name: pshard_stats
5252
description: |
53-
If you enable the "pshard_stats" flag, statistics over primary shards
53+
If you enable the `pshard_stats` flag, statistics over primary shards
5454
are collected by the check and sent to the backend with the
55-
'elasticsearch.primary' prefix. It is particularly useful if you want to
55+
`elasticsearch.primary` prefix. It is particularly useful if you want to
5656
get certain metrics without taking replicas into account. For instance,
57-
'elasticsearch.primaries.docs.count` gives you the total number of
57+
`elasticsearch.primaries.docs.count` gives you the total number of
5858
documents in your indexes WITHOUT counting duplicates due to the existence
5959
of replica shards in your ES cluster.
6060
value:
6161
type: boolean
6262
example: false
6363
- name: slm_stats
6464
description: |
65-
Set "slm_stats" to true to collect statistics about Snapshot Lifcycle Management.
65+
Set `slm_stats` to true to collect statistics about Snapshot Lifecycle Management.
6666
The user must have the `read_slm` cluster privilege to get these metrics.
6767
value:
6868
type: boolean
6969
example: false
7070
- name: pshard_graceful_timeout
71-
description: Continue gracefully if pshard stats TO
71+
description: Continue gracefully if pshard stats timeout.
7272
value:
7373
type: boolean
7474
example: false
7575
- name: pending_task_stats
7676
description: |
77-
It specifies whether to collect data exposed by the `pending_tasks` cluster endpoint.
77+
Specifies whether to collect data exposed by the `pending_tasks` cluster endpoint.
7878
Ref: https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-pending.html
79-
Some managed ElasticSearch services (e.g. AWS ElasticSearch) do not expose this endpoint.
79+
Some managed Elasticsearch services (e.g., AWS Elasticsearch) do not expose this endpoint.
8080
Set `pending_task_stats` to false if you use such a service.
8181
value:
8282
type: boolean
@@ -90,8 +90,8 @@ files:
9090
example: false
9191
- name: admin_forwarder
9292
description: |
93-
It is used to signify a URL that includes a context root
94-
needed for a forwarder application to access Elasticsearch REST services for example
93+
Specifies a URL that includes a context root
94+
needed for a forwarder application to access Elasticsearch REST services, for example:
9595
https://www.ibm.com/support/knowledgecenter/SSFTN5_8.5.6/com.ibm.wbpm.main.doc/topics/tadm_fps_esearch.html
9696
value:
9797
type: boolean
@@ -112,7 +112,7 @@ files:
112112
enabled: false
113113
- name: disable_legacy_service_check_tags
114114
description: |
115-
Disable the submission of the elasticsearch `host` and `port` as tags in service checks.
115+
Disable the submission of the Elasticsearch `host` and `port` as tags in service checks.
116116
Submit them as `url` instead.
117117
value:
118118
type: boolean
@@ -141,7 +141,7 @@ files:
141141
breaker, the `value_path` is `estimated_size_in_bytes`.
142142
2. name - The full metric name sent to Datadog. If `type` is `tag`, this column is considered a tag and
143143
applied to every metric collected by this particular query.
144-
3. type (optional) - An optional parameter to designates the type of data sent. Possible values for
144+
3. type (optional) - An optional parameter to designate the type of data sent. Possible values for
145145
`type` include `gauge`, `monotonic_count`, `rate`, and `tag`, with `gauge` being
146146
the default.
147147
@@ -227,7 +227,7 @@ files:
227227
- name: url
228228
required: true
229229
description: |
230-
The URL where elasticsearch accepts HTTP requests. This is used to
230+
The URL where Elasticsearch accepts HTTP requests. This is used to
231231
fetch statistics from the nodes and information about the cluster health.
232232
value:
233233
example: http://%%host%%:9200

elastic/changelog.d/21879.fixed

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Fix styling and grammatical errors in the config template

elastic/datadog_checks/elastic/data/auto_conf.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ init_config:
1616
instances:
1717

1818
## @param url - string - required
19-
## The URL where elasticsearch accepts HTTP requests. This is used to
19+
## The URL where Elasticsearch accepts HTTP requests. This is used to
2020
## fetch statistics from the nodes and information about the cluster health.
2121
#
2222
- url: http://%%host%%:9200

elastic/datadog_checks/elastic/data/conf.yaml.example

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ init_config:
4646
instances:
4747

4848
## @param url - string - required
49-
## The URL where elasticsearch accepts HTTP requests. This is used to
49+
## The URL where Elasticsearch accepts HTTP requests. This is used to
5050
## fetch statistics from the nodes and information about the cluster health.
5151
#
5252
- url: http://localhost:9200
@@ -60,8 +60,8 @@ instances:
6060
# node_name_as_host: false
6161

6262
## @param cluster_stats - boolean - optional - default: false
63-
## If your cluster is hosted externally (i.e., you're not pointing to localhost)
64-
## you must to set `cluster_stats` to true otherwise the check only
63+
## If your cluster is hosted externally (i.e., you're not pointing to localhost),
64+
## you must set `cluster_stats` to true, otherwise the check only
6565
## submits metrics of the local node.
6666
## This parameter was also called `is_external` and you can still use it but it
6767
## is removed in Agent version 6+.
@@ -76,36 +76,36 @@ instances:
7676
# detailed_index_stats: false
7777

7878
## @param index_stats - boolean - optional - default: false
79-
## Set "index_stats" to true to collect metrics for individual indices.
79+
## Set `index_stats` to true to collect metrics for individual indices.
8080
#
8181
# index_stats: false
8282

8383
## @param pshard_stats - boolean - optional - default: false
84-
## If you enable the "pshard_stats" flag, statistics over primary shards
84+
## If you enable the `pshard_stats` flag, statistics over primary shards
8585
## are collected by the check and sent to the backend with the
86-
## 'elasticsearch.primary' prefix. It is particularly useful if you want to
86+
## `elasticsearch.primary` prefix. It is particularly useful if you want to
8787
## get certain metrics without taking replicas into account. For instance,
88-
## 'elasticsearch.primaries.docs.count` gives you the total number of
88+
## `elasticsearch.primaries.docs.count` gives you the total number of
8989
## documents in your indexes WITHOUT counting duplicates due to the existence
9090
## of replica shards in your ES cluster.
9191
#
9292
# pshard_stats: false
9393

9494
## @param slm_stats - boolean - optional - default: false
95-
## Set "slm_stats" to true to collect statistics about Snapshot Lifcycle Management.
95+
## Set `slm_stats` to true to collect statistics about Snapshot Lifecycle Management.
9696
## The user must have the `read_slm` cluster privilege to get these metrics.
9797
#
9898
# slm_stats: false
9999

100100
## @param pshard_graceful_timeout - boolean - optional - default: false
101-
## Continue gracefully if pshard stats TO
101+
## Continue gracefully if pshard stats timeout.
102102
#
103103
# pshard_graceful_timeout: false
104104

105105
## @param pending_task_stats - boolean - optional - default: true
106-
## It specifies whether to collect data exposed by the `pending_tasks` cluster endpoint.
106+
## Specifies whether to collect data exposed by the `pending_tasks` cluster endpoint.
107107
## Ref: https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-pending.html
108-
## Some managed ElasticSearch services (e.g. AWS ElasticSearch) do not expose this endpoint.
108+
## Some managed Elasticsearch services (e.g., AWS Elasticsearch) do not expose this endpoint.
109109
## Set `pending_task_stats` to false if you use such a service.
110110
#
111111
# pending_task_stats: true
@@ -117,8 +117,8 @@ instances:
117117
# cat_allocation_stats: false
118118

119119
## @param admin_forwarder - boolean - optional - default: false
120-
## It is used to signify a URL that includes a context root
121-
## needed for a forwarder application to access Elasticsearch REST services for example
120+
## Specifies a URL that includes a context root
121+
## needed for a forwarder application to access Elasticsearch REST services, for example:
122122
## https://www.ibm.com/support/knowledgecenter/SSFTN5_8.5.6/com.ibm.wbpm.main.doc/topics/tadm_fps_esearch.html
123123
#
124124
# admin_forwarder: false
@@ -135,7 +135,7 @@ instances:
135135
# disable_legacy_cluster_tag: true
136136

137137
## @param disable_legacy_service_check_tags - boolean - optional - default: false
138-
## Disable the submission of the elasticsearch `host` and `port` as tags in service checks.
138+
## Disable the submission of the Elasticsearch `host` and `port` as tags in service checks.
139139
## Submit them as `url` instead.
140140
#
141141
disable_legacy_service_check_tags: true
@@ -161,7 +161,7 @@ instances:
161161
## breaker, the `value_path` is `estimated_size_in_bytes`.
162162
## 2. name - The full metric name sent to Datadog. If `type` is `tag`, this column is considered a tag and
163163
## applied to every metric collected by this particular query.
164-
## 3. type (optional) - An optional parameter to designates the type of data sent. Possible values for
164+
## 3. type (optional) - An optional parameter to designate the type of data sent. Possible values for
165165
## `type` include `gauge`, `monotonic_count`, `rate`, and `tag`, with `gauge` being
166166
## the default.
167167
##

0 commit comments

Comments
 (0)