Skip to content

Commit 9cd9fcb

Browse files
authored
Add additional context for database_identifier configuration for Postgres, MySQL, and SQLServer (DataDog#21575)
* Add additional context for configuration for Postgres, MySQL, and SQLServer * Copy * Changelog * Copy
1 parent 453ff53 commit 9cd9fcb

9 files changed

Lines changed: 27 additions & 12 deletions

File tree

mysql/assets/configuration/spec.yaml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,8 +79,10 @@ files:
7979
default: false
8080
- name: database_identifier
8181
description: |
82-
Controls how the database is identified. The default value is the resolved hostname for the instance,
83-
which respects the `reported_hostname` option.
82+
Controls how the database is identified. Each unique value of this identifier will appear in DBM as a separate
83+
billable instance.
84+
85+
The default value is the resolved hostname for the instance, which respects the `reported_hostname` option.
8486
8587
This value will be used as-is for the display name of the instance but will be normalized
8688
when applied as the `database_instance` tag. Please see https://docs.datadoghq.com/getting_started/tagging/

mysql/changelog.d/21575.added

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Add additional context to the database_identifier configuration description.

mysql/datadog_checks/mysql/data/conf.yaml.example

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,8 +69,10 @@ instances:
6969
#
7070
# exclude_hostname: false
7171

72-
## Controls how the database is identified. The default value is the resolved hostname for the instance,
73-
## which respects the `reported_hostname` option.
72+
## Controls how the database is identified. Each unique value of this identifier will appear in DBM as a separate
73+
## billable instance.
74+
##
75+
## The default value is the resolved hostname for the instance, which respects the `reported_hostname` option.
7476
##
7577
## This value will be used as-is for the display name of the instance but will be normalized
7678
## when applied as the `database_instance` tag. Please see https://docs.datadoghq.com/getting_started/tagging/

postgres/assets/configuration/spec.yaml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,10 @@ files:
5858
example: false
5959
- name: database_identifier
6060
description: |
61-
Controls how the database is identified. The default value is the resolved hostname for the instance,
62-
which respects the `reported_hostname` option.
61+
Controls how the database is identified. Each unique value of this identifier will appear in DBM as a separate
62+
billable instance.
63+
64+
The default value is the resolved hostname for the instance, which respects the `reported_hostname` option.
6365
6466
This value will be used as-is for the display name of the instance but will be normalized
6567
when applied as the `database_instance` tag. Please see https://docs.datadoghq.com/getting_started/tagging/

postgres/changelog.d/21575.added

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Add additional context to the database_identifier configuration description.

postgres/datadog_checks/postgres/data/conf.yaml.example

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,8 +70,10 @@ instances:
7070
#
7171
# exclude_hostname: false
7272

73-
## Controls how the database is identified. The default value is the resolved hostname for the instance,
74-
## which respects the `reported_hostname` option.
73+
## Controls how the database is identified. Each unique value of this identifier will appear in DBM as a separate
74+
## billable instance.
75+
##
76+
## The default value is the resolved hostname for the instance, which respects the `reported_hostname` option.
7577
##
7678
## This value will be used as-is for the display name of the instance but will be normalized
7779
## when applied as the `database_instance` tag. Please see https://docs.datadoghq.com/getting_started/tagging/

sqlserver/assets/configuration/spec.yaml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,8 +80,10 @@ files:
8080
default: false
8181
- name: database_identifier
8282
description: |
83-
Controls how the database is identified. The default value is the resolved hostname for the instance,
84-
which respects the `reported_hostname` option.
83+
Controls how the database is identified. Each unique value of this identifier will appear in DBM as a separate
84+
billable instance.
85+
86+
The default value is the resolved hostname for the instance, which respects the `reported_hostname` option.
8587
8688
This value will be used as-is for the display name of the instance but will be normalized
8789
when applied as the `database_instance` tag. Please see https://docs.datadoghq.com/getting_started/tagging/

sqlserver/changelog.d/21575.added

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Add additional context to the database_identifier configuration description.

sqlserver/datadog_checks/sqlserver/data/conf.yaml.example

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,8 +85,10 @@ instances:
8585
#
8686
# exclude_hostname: false
8787

88-
## Controls how the database is identified. The default value is the resolved hostname for the instance,
89-
## which respects the `reported_hostname` option.
88+
## Controls how the database is identified. Each unique value of this identifier will appear in DBM as a separate
89+
## billable instance.
90+
##
91+
## The default value is the resolved hostname for the instance, which respects the `reported_hostname` option.
9092
##
9193
## This value will be used as-is for the display name of the instance but will be normalized
9294
## when applied as the `database_instance` tag. Please see https://docs.datadoghq.com/getting_started/tagging/

0 commit comments

Comments
 (0)