Skip to content

Commit 2b0cf18

Browse files
authored
Touch up on the nginx config template (#21757)
* touch up on the nginx config template * changelog
1 parent 706d493 commit 2b0cf18

File tree

3 files changed

+25
-20
lines changed

3 files changed

+25
-20
lines changed

nginx/assets/configuration/spec.yaml

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,15 @@ files:
1010
options:
1111
- name: nginx_status_url
1212
required: true
13+
display_priority: 2
1314
description: |
1415
For every instance, you need an `nginx_status_url` and can optionally
1516
supply a list of tags. This plugin requires nginx to be compiled with
1617
the nginx stub status module option, and activated with the correct
1718
configuration stanza. On debian/ubuntu, this is included in the
1819
`nginx-extras` package. For more details, see:
1920
20-
http://docs.datadoghq.com/integrations/nginx/
21+
https://docs.datadoghq.com/integrations/nginx/
2122
2223
For NGINX Plus API Release 13+ users using the http_api_module,
2324
set nginx_status_url to the location of the `/api` endpoint.
@@ -27,10 +28,10 @@ files:
2728
type: string
2829
- name: use_plus_api
2930
description: |
30-
If you are using the commercial version of nginx, for releases R13 and above,
31-
there is a new API to replace the extended status API.
32-
See https://www.nginx.com/blog/nginx-plus-r13-released/
33-
To use it set `use_plus_api` to true
31+
If you are using the commercial version of NGINX for releases R13 and above,
32+
there is a new API that replaces the extended status API.
33+
See https://www.nginx.com/blog/nginx-plus-r13-released/.
34+
To use it, set `use_plus_api` to `true`.
3435
value:
3536
type: boolean
3637
example: false
@@ -69,12 +70,14 @@ files:
6970
- template: instances/http
7071
- template: instances/default
7172
overrides:
73+
disable_generic_tags.display_priority: 1
7274
disable_generic_tags.hidden: False
7375
disable_generic_tags.enabled: True
7476
disable_generic_tags.description: |
75-
Generic tags such as `cluster` will be replaced by <integration_name>_cluster to avoid
76-
getting mixed with other integration tags.
77-
Note that this is only relevant to service check submissions. Metrics do not include any generic tags.
77+
Generic tags such as `cluster` will be replaced by nginx_cluster to avoid
78+
getting mixed with other integration tags. Note that this is only relevant
79+
to service check submissions. Metrics do not include any generic tags.
80+
Datadog recommends setting this to `true` to avoid confusion.
7881
7982
- template: logs
8083
example:

nginx/changelog.d/21757.fixed

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Touch up on the nginx config template

nginx/datadog_checks/nginx/data/conf.yaml.example

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -52,19 +52,27 @@ instances:
5252
## configuration stanza. On debian/ubuntu, this is included in the
5353
## `nginx-extras` package. For more details, see:
5454
##
55-
## http://docs.datadoghq.com/integrations/nginx/
55+
## https://docs.datadoghq.com/integrations/nginx/
5656
##
5757
## For NGINX Plus API Release 13+ users using the http_api_module,
5858
## set nginx_status_url to the location of the `/api` endpoint.
5959
## E.g. `nginx_status_url: http://localhost:8080/api`
6060
#
6161
- nginx_status_url: http://localhost:81/nginx_status/
6262

63+
## @param disable_generic_tags - boolean - optional - default: false
64+
## Generic tags such as `cluster` will be replaced by nginx_cluster to avoid
65+
## getting mixed with other integration tags. Note that this is only relevant
66+
## to service check submissions. Metrics do not include any generic tags.
67+
## Datadog recommends setting this to `true` to avoid confusion.
68+
#
69+
disable_generic_tags: true
70+
6371
## @param use_plus_api - boolean - optional - default: false
64-
## If you are using the commercial version of nginx, for releases R13 and above,
65-
## there is a new API to replace the extended status API.
66-
## See https://www.nginx.com/blog/nginx-plus-r13-released/
67-
## To use it set `use_plus_api` to true
72+
## If you are using the commercial version of NGINX for releases R13 and above,
73+
## there is a new API that replaces the extended status API.
74+
## See https://www.nginx.com/blog/nginx-plus-r13-released/.
75+
## To use it, set `use_plus_api` to `true`.
6876
#
6977
# use_plus_api: false
7078

@@ -444,13 +452,6 @@ instances:
444452
#
445453
# empty_default_hostname: false
446454

447-
## @param disable_generic_tags - boolean - optional - default: false
448-
## Generic tags such as `cluster` will be replaced by <integration_name>_cluster to avoid
449-
## getting mixed with other integration tags.
450-
## Note that this is only relevant to service check submissions. Metrics do not include any generic tags.
451-
#
452-
disable_generic_tags: true
453-
454455
## @param metric_patterns - mapping - optional
455456
## A mapping of metrics to include or exclude, with each entry being a regular expression.
456457
##

0 commit comments

Comments
 (0)