Add configuration value to Consul check to not send service metrics containing service name #20309
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- add a new option `services_tags_include_service_name` to the consul configuration - if set to false, the consul checks will not produce the service tags that look like `consul_<servicename>_service_tag:<consultagkey>=<consultagvalue>` - defaults to true, to maintain backward compatibility - this substantially reduces the number of tags that the check includes
janine-c
previously approved these changes
May 15, 2025
Co-authored-by: Janine Chan <[email protected]>
temporal-github-worker-1
bot
dismissed
janine-c’s stale review
Review from janine-c is dismissed. Related teams and files:
- documentation
- consul/assets/configuration/spec.yaml
- consul/datadog_checks/consul/data/conf.yaml.example
temporal-github-worker-1
bot
added
docs/review-requested
and removed
docs/approved
labels
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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?
services_tags_include_service_nameto the Consul check configuration (this name is kind of awkward, I was trying to match existing options but very open to suggestions)consul_<servicename>_service_tag:<consultag>in addition to theconsul_service_tag:<consultag>Motivation
We have a lot of Consul services and a lot of tags, and the additional
consul_<servicename>_service_tag:<consultag>for every consul tag makes an explosion of tags that we don't use, since we can combineservice:andconsul_service_tagin queries to get the same result, and that is clearer. We would like to turn these off so we have fewer tags around.Review checklist (to be filled by reviewers)
qa/skip-qalabel if the PR doesn't need to be tested during QA.backport/<branch-name>label to the PR and it will automatically open a backport PR once this one is merged