Add config specs #7291

hithwen · 2020-08-05T09:33:07Z

No description provided.

hithwen · 2020-08-05T09:36:11Z

amazon_msk/datadog_checks/amazon_msk/data/conf.yaml.example

    #
    # health_service_check: true

-    ## @param metrics - list of strings - optional


I don't see this used in code but is not part of the openmetrics template either cc @ofek

Yup only used by custom checks

What do you mean? If our code is not reading this param then custom checks have to add its logic around it, right?
My question is if is safe to remove this param

hithwen · 2020-08-05T09:37:28Z

amazon_msk/datadog_checks/amazon_msk/data/conf.yaml.example

    #
-    # ssl_cert: "<CERT_PATH>"


These are remapped on openmetrics base class (same for ssl_private_key and ssl_ca_cert)

codecov · 2020-08-05T09:43:43Z

Codecov Report

Merging #7291 into master will increase coverage by 5.13%.
The diff coverage is n/a.

Impacted Files	Coverage Δ
go_expvar/tests/conftest.py
directory/datadog_checks/directory/__about__.py
ssh_check/tests/test_ssh.py
cilium/datadog_checks/cilium/__about__.py
openldap/tests/common.py
datadog_checks_dev/datadog_checks/dev/spec.py
coredns/tests/test_check.py
ceph/tests/common.py
cisco_aci/datadog_checks/cisco_aci/__about__.py
pgbouncer/datadog_checks/pgbouncer/metrics.py
... and 776 more

ruthnaebeck

docs review

amazon_msk/assets/configuration/spec.yaml

amazon_msk/datadog_checks/amazon_msk/data/conf.yaml.example

ruthnaebeck · 2020-08-05T19:18:57Z

amazon_msk/datadog_checks/amazon_msk/data/conf.yaml.example

+    ##     |__ aws_host
+    ##     |__ aws_service
+    ##
+    ## The `aws` auth type relies on boto3 to automatically gather AWS credentials (e.g. from `.aws/credentials`).


Suggested change

## The `aws` auth type relies on boto3 to automatically gather AWS credentials (e.g. from `.aws/credentials`).

## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`.

This is from the base template, see comments below

ruthnaebeck · 2020-08-05T19:19:27Z

amazon_msk/datadog_checks/amazon_msk/data/conf.yaml.example

+    # password: <PASSWORD>
+
+    ## @param ntlm_domain - string - optional
+    ## If your services use NTLM authentication, you can specify


Suggested change

## If your services use NTLM authentication, you can specify

## If your services use NTLM authentication, specify

This is from the base template, see comments below

ruthnaebeck · 2020-08-05T19:20:06Z

amazon_msk/datadog_checks/amazon_msk/data/conf.yaml.example

+
+    ## @param ntlm_domain - string - optional
+    ## If your services use NTLM authentication, you can specify
+    ## a domain that is used in the check. For NTLM Auth, append


Suggested change

## a domain that is used in the check. For NTLM Auth, append

## the domain used in the check. For NTLM Auth, append

This is from the base template, see comment below

ruthnaebeck · 2020-08-05T19:21:15Z

amazon_msk/datadog_checks/amazon_msk/data/conf.yaml.example

+
+    ## @param kerberos_hostname - string - optional
+    ## Override the hostname used for the Kerberos GSS exchange if its DNS name doesn't
+    ## match its Kerberos hostname (e.g. behind a content switch or load balancer).


Suggested change

## match its Kerberos hostname (e.g. behind a content switch or load balancer).

## match its Kerberos hostname, for example: behind a content switch or load balancer.

This is on the base template. You guys may want to have a look at it and open a PR to it (it will update all affected integrations)

…nfig-specs

ChristineTChen

There is an openmetrics config template for init_config too

amazon_msk/assets/configuration/spec.yaml

Co-authored-by: Christine Chen <[email protected]>

hithwen · 2020-08-20T12:30:54Z

@ruthnaebeck docs reviews (when adding gh suggestions) should be on the spec file not on the conf.yaml. conf.yaml is a generated file when a spec file is present.

…tegrations-core into julia/amazon-msk-config-specs

hithwen · 2020-08-20T12:36:56Z

There is an openmetrics config template for init_config too

added!

…nfig-specs

* Add config specs Co-authored-by: Christine Chen <[email protected]> 03a7370

Add config specs

89e0ac8

hithwen requested review from a team as code owners August 5, 2020 09:33

hithwen added changelog/Added integration/amazon_msk labels Aug 5, 2020

github-actions bot added the documentation label Aug 5, 2020

hithwen commented Aug 5, 2020

View reviewed changes

ruthnaebeck suggested changes Aug 5, 2020

View reviewed changes

hithwen mentioned this pull request Aug 6, 2020

Apply config feedback #7303

Merged

Merge remote-tracking branch 'origin/master' into julia/amazon-msk-co…

e87cf77

…nfig-specs

hithwen force-pushed the julia/amazon-msk-config-specs branch from 9076ec7 to e87cf77 Compare August 7, 2020 08:28

hithwen requested a review from ruthnaebeck August 7, 2020 08:28

ChristineTChen requested changes Aug 18, 2020

View reviewed changes

amazon_msk/assets/configuration/spec.yaml Outdated Show resolved Hide resolved

Apply suggestions from code review

bed0e58

Co-authored-by: Christine Chen <[email protected]>

hithwen added 2 commits August 20, 2020 14:35

Include openmetrics template on init_config

8c58248

Merge branch 'julia/amazon-msk-config-specs' of github.com:DataDog/in…

1e5f822

…tegrations-core into julia/amazon-msk-config-specs

hithwen requested a review from ofek August 20, 2020 12:37

hithwen added 3 commits August 20, 2020 15:19

Merge remote-tracking branch 'origin/master' into julia/amazon-msk-co…

79994df

…nfig-specs

Sync

39d13b5

Merge remote-tracking branch 'origin/master' into julia/amazon-msk-co…

a8078c7

…nfig-specs

ChristineTChen approved these changes Aug 20, 2020

View reviewed changes

hithwen merged commit 03a7370 into master Aug 26, 2020

hithwen deleted the julia/amazon-msk-config-specs branch August 26, 2020 08:41

github-actions bot pushed a commit that referenced this pull request Aug 26, 2020

Add config specs (#7291)

901fd7d

* Add config specs Co-authored-by: Christine Chen <[email protected]> 03a7370

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add config specs #7291

Add config specs #7291

hithwen commented Aug 5, 2020 •

edited

Loading

hithwen Aug 5, 2020 •

edited

Loading

ofek Aug 18, 2020

hithwen Aug 20, 2020

hithwen Aug 5, 2020 •

edited

Loading

codecov bot commented Aug 5, 2020 •

edited

Loading

ruthnaebeck left a comment

ruthnaebeck Aug 5, 2020

hithwen Aug 20, 2020

ruthnaebeck Aug 5, 2020

hithwen Aug 20, 2020

ruthnaebeck Aug 5, 2020

hithwen Aug 20, 2020

ruthnaebeck Aug 5, 2020

hithwen Aug 20, 2020

ChristineTChen left a comment

hithwen commented Aug 20, 2020 •

edited

Loading

hithwen commented Aug 20, 2020

	## The `aws` auth type relies on boto3 to automatically gather AWS credentials (e.g. from `.aws/credentials`).
	## The `aws` auth type relies on boto3 to automatically gather AWS credentials, for example: from `.aws/credentials`.

	## If your services use NTLM authentication, you can specify
	## If your services use NTLM authentication, specify

	## a domain that is used in the check. For NTLM Auth, append
	## the domain used in the check. For NTLM Auth, append

	## match its Kerberos hostname (e.g. behind a content switch or load balancer).
	## match its Kerberos hostname, for example: behind a content switch or load balancer.

Add config specs #7291

Add config specs #7291

Conversation

hithwen commented Aug 5, 2020 • edited Loading

hithwen Aug 5, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hithwen Aug 5, 2020 • edited Loading

Choose a reason for hiding this comment

codecov bot commented Aug 5, 2020 • edited Loading

Codecov Report

ruthnaebeck left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ChristineTChen left a comment

Choose a reason for hiding this comment

hithwen commented Aug 20, 2020 • edited Loading

hithwen commented Aug 20, 2020

hithwen commented Aug 5, 2020 •

edited

Loading

hithwen Aug 5, 2020 •

edited

Loading

hithwen Aug 5, 2020 •

edited

Loading

codecov bot commented Aug 5, 2020 •

edited

Loading

hithwen commented Aug 20, 2020 •

edited

Loading