Skip to content

Commit 645e70c

Browse files
lspanoddtraegerdogeric-weaver
authored
Update README.md (DataDog#21328)
We made two changes to the documentation page: 1 - in the Annotations v1 example, we were not using the container name for check, which is incorrect and it will not work. Replaced the postgresql.check_names for postgres.check_names to match the container name. 2. We added a note to guide customers to match their container name in the integration check_names. We are open to suggestion regarding the added note in the documentation. Co-authored-by: traegerdog <122398611+traegerdog@users.noreply.github.com> Co-authored-by: Eric Weaver <eweaver755@gmail.com>
1 parent 8c4d81d commit 645e70c

1 file changed

Lines changed: 4 additions & 3 deletions

File tree

postgres/README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -282,6 +282,7 @@ Then, [instrument your application container that makes requests to Postgres][11
282282
To configure this check for an Agent running on Kubernetes:
283283

284284
##### Metric collection
285+
**Note**: The `<container-name>.check_names` must match the container name where the integration needs to collect metrics. In the example, we are using `postgres.check_names` because the container name is postgres.
285286

286287
Set [Autodiscovery Integrations Templates][13] as pod annotations on your application container. Aside from this, templates can also be configured with [a file, a configmap, or a key-value store][14].
287288

@@ -293,9 +294,9 @@ kind: Pod
293294
metadata:
294295
name: postgres
295296
annotations:
296-
ad.datadoghq.com/postgresql.check_names: '["postgres"]'
297-
ad.datadoghq.com/postgresql.init_configs: '[{}]'
298-
ad.datadoghq.com/postgresql.instances: |
297+
ad.datadoghq.com/postgres.check_names: '["postgres"]'
298+
ad.datadoghq.com/postgres.init_configs: '[{}]'
299+
ad.datadoghq.com/postgres.instances: |
299300
[
300301
{
301302
"host": "%%host%%",

0 commit comments

Comments
 (0)