Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[integrations] Document "ignore_autodiscovery_tags" option #14007

Merged
merged 1 commit into from
May 12, 2022

Conversation

davidor
Copy link
Member

@davidor davidor commented May 11, 2022

What does this PR do?

Documents the ignore_autodiscovery_tags option that was introduced here: DataDog/datadog-agent#4521


Reviewer checklist

  • Review the changed files.
  • Review the URLs listed in the Preview section.
  • Check images for PII
  • Review any mentions of "Contact Datadog support" for internal support documentation.

@davidor davidor requested a review from a team as a code owner May 11, 2022 16:31
@github-actions github-actions bot added the getting_started Content changed in the getting started folder label May 11, 2022
@github-actions
Copy link
Contributor

Preview links (active after the build_preview check completes):
https://docs-staging.datadoghq.com/davidor/ignore_autodiscovery_tags/getting_started/integrations/

@davidor davidor force-pushed the davidor/ignore_autodiscovery_tags branch from 62e1696 to a977efa Compare May 11, 2022 16:42
Copy link
Collaborator

@kayayarai kayayarai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suggested a little rewording, but also: With a name like ignore_autodiscovery_tags, I'd have expected true to be the setting that would stop the tags from coming through. No?

@@ -97,6 +97,15 @@ For example, setting `service` in your config file is the recommended [Agent set

To better unify your environment, it is also recommended to configure the `env` tag in the Agent. To learn more, see [Unified Service Tagging][27].

By default, the metrics reported by integrations include tags autodiscovered from the environment. For example, the metrics reported by a Redis check that runs inside a container include tags that refer to the container like `image_name`. This can be disabled by setting the `ignore_autodiscovery_tags` parameter to `false`:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
By default, the metrics reported by integrations include tags autodiscovered from the environment. For example, the metrics reported by a Redis check that runs inside a container include tags that refer to the container like `image_name`. This can be disabled by setting the `ignore_autodiscovery_tags` parameter to `false`:
By default, the metrics reported by integrations include tags autodiscovered from the environment. For example, the metrics reported by a Redis check that runs inside a container include tags that refer to the container, such as `image_name`. You can turn this behavior off by setting the `ignore_autodiscovery_tags` parameter to `false`:

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, as you mentioned, the setting should be set to true instead of false.
I fixed that and also included your suggestion.

@davidor davidor force-pushed the davidor/ignore_autodiscovery_tags branch from a977efa to 7b3f21d Compare May 12, 2022 08:26
@davidor davidor force-pushed the davidor/ignore_autodiscovery_tags branch from 7b3f21d to f12e2ef Compare May 12, 2022 08:31
@davidor davidor requested a review from kayayarai May 12, 2022 13:04
@kayayarai kayayarai merged commit 2e00365 into master May 12, 2022
@kayayarai kayayarai deleted the davidor/ignore_autodiscovery_tags branch May 12, 2022 15:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
getting_started Content changed in the getting started folder
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants