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

Document how auto-host generation can increase custom metric counts #267

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

patsplat
Copy link

@patsplat patsplat commented Jun 5, 2023

Requirements for Contributing to this repository

  • Fill out the template below. Any pull request that does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion.
  • The pull request must only fix one issue, or add one feature, at the time.
  • The pull request must update the test suite to demonstrate the changed functionality.
  • After you create the pull request, all status checks must be pass before a maintainer reviews your contribution. For more details, please see CONTRIBUTING.

What does this PR do?

This PR documents behavior of the dogapi library that can unexpectedly inflate billing.

Description of the Change

Adds documentation of how the host field is automatically set, and how that behavior can cause the creation of an excessive number of custom metrics.

Alternate Designs

One could also change the behavior of dogapi so that host detection was an opt-in rather than an auto-behavior. However that might break other customers installations.

Possible Drawbacks

The documentation may be less readable. This is worth a review to make sure that it appropriately matches the voice and interests of datadog.

Verification Process

It's a doc update

Additional Notes

This issue can potentially increase usage and customer costs, leading to a lack of trust in the library.

Release Notes

N/A

Review checklist (to be filled by reviewers)

  • Feature or bug fix MUST have appropriate tests (unit, integration, etc...)
  • PR title must be written as a CHANGELOG entry (see why)
  • Files changes must correspond to the primary purpose of the PR as described in the title (small unrelated changes should have their own PR)
  • PR must have one changelog/ label attached. If applicable it should have the backward-incompatible label attached.
  • PR should not have do-not-merge/ label attached.
  • If Applicable, issue must have kind/ and severity/ labels attached at least.

@patsplat patsplat requested a review from a team as a code owner June 5, 2023 13:58
Copy link

This issue has been automatically marked as stale because it has not had activity in the last 30 days.
Note that the issue will not be automatically closed, but this notification will remind us to investigate why there's been inactivity.

@github-actions github-actions bot added the stale Stale - Bot reminder label Sep 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
stale Stale - Bot reminder
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant