DataDog / dogapi-rb

Ruby client for Datadog's API
https://www.datadoghq.com
BSD 3-Clause "New" or "Revised" License
96 stars 88 forks source link

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

Open patsplat opened 1 year ago

patsplat commented 1 year ago

Requirements for Contributing to this repository

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)

github-actions[bot] commented 1 month ago

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.