Hide auto-populated prometheus_url from config spec #8330
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Hide the
prometheus_url
option from Amazon MSK example config.Motivation
Customer and SE were confused about this option being present and marked as "required", but they didn't know what to put there.
Turns out the option is irrelevant to the MSK check:
integrations-core/amazon_msk/datadog_checks/amazon_msk/amazon_msk.py
Lines 33 to 34 in 2fdc311
The check iterates through MSK nodes returned by the AWS API, and auto-fills the
prometheus_url
for each:integrations-core/amazon_msk/datadog_checks/amazon_msk/amazon_msk.py
Lines 78 to 82 in 2fdc311
As our test setup confirms, only
cluster_arn
is really required:integrations-core/amazon_msk/tests/conftest.py
Lines 34 to 39 in 1bf1bcf
So we should drop
prometheus_url
from the docs.Additional Notes
Review checklist (to be filled by reviewers)
changelog/
andintegration/
labels attached