Fix the annotation key names listed in the AD Annotations v1 tab - #39217
Open
jumpe1 wants to merge 1 commit into
Open
Fix the annotation key names listed in the AD Annotations v1 tab#39217jumpe1 wants to merge 1 commit into
jumpe1 wants to merge 1 commit into
Conversation
The AD Annotations v1 tab named `ad.datadoghq.com/<container-name>.checks` as the check configuration key. That is the v2 key: the sentence was duplicated from the v2 tab, where it is correct. The YAML example in the same tab already used the three v1 keys, so the tab contradicted itself.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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? What is the motivation?
In Getting Started with Containers → Autodiscovery, the AD Annotations v1 tab says the check configuration key is
ad.datadoghq.com/<container-name>.checks. That is the v2 key — the sentence is duplicated from the v2 tab, where it is correct. The YAML example in the same tab correctly usescheck_names,init_configs, andinstances, so the tab contradicts itself.This is worth more than a typo fix. Autodiscovery applies only one annotation format per container, preferring v2 over v1, so a reader who follows both the v1 example and its prose ends up setting v1 and v2 keys together — and the v1 configuration is the one that gets silently dropped.
Merge readiness
AI assistance
Additional notes