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

chore: rename reportHealthMetrics function #3040

Merged
merged 3 commits into from
Dec 23, 2024

Conversation

mtoffl01
Copy link
Contributor

What does this PR do?

Renames the reportHealthMetrics function to reportHealthMetricsAtInterval

Motivation

Health metrics are reported across the repo; the name reportHealthMetrics can be confusing and incorrectly imply that the only health metrics we report are done inside of this function.

Reviewer's Checklist

  • Changed code has unit tests for its functionality at or near 100% coverage.
  • System-Tests covering this feature have been added and enabled with the va.b.c-dev version tag.
  • There is a benchmark for any new code, or changes to existing code.
  • If this interacts with the agent in a new way, a system test has been added.
  • Add an appropriate team label so this PR gets put in the right place for the release notes.
  • Non-trivial go.mod changes, e.g. adding new modules, are reviewed by @DataDog/dd-trace-go-guild.
  • For internal contributors, a matching PR should be created to the v2-dev branch and reviewed by @DataDog/apm-go.

Unsure? Have a question? Request a review!

@datadog-datadog-prod-us1
Copy link

datadog-datadog-prod-us1 bot commented Dec 16, 2024

Datadog Report

Branch report: mtoff/refactor-report-health-metrics
Commit report: 3995717
Test service: dd-trace-go

✅ 0 Failed, 5117 Passed, 70 Skipped, 2m 54.54s Total Time

@pr-commenter
Copy link

pr-commenter bot commented Dec 16, 2024

Benchmarks

Benchmark execution time: 2024-12-23 16:29:52

Comparing candidate commit c7a40e5 in PR branch mtoff/refactor-report-health-metrics with baseline commit d393324 in branch main.

Found 0 performance improvements and 0 performance regressions! Performance is the same for 58 metrics, 1 unstable metrics.

@mtoffl01 mtoffl01 marked this pull request as ready for review December 17, 2024 19:13
@mtoffl01 mtoffl01 requested a review from a team as a code owner December 17, 2024 19:13
@mtoffl01 mtoffl01 requested a review from hannahkm December 17, 2024 19:13
@@ -85,7 +85,9 @@ func (t *tracer) reportRuntimeMetrics(interval time.Duration) {
}
}

func (t *tracer) reportHealthMetrics(interval time.Duration) {
// reportHealthMetricsAtInterval reports health metrics at the specified interval to reduce noise.
Copy link
Contributor

Choose a reason for hiding this comment

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

Smallest nit in the world: since we are clarifying that not all health metrics are contained in this function, should we also be clear about that in this comment? Something along the lines of:

Suggested change
// reportHealthMetricsAtInterval reports health metrics at the specified interval to reduce noise.
// reportHealthMetricsAtInterval reports certain/noisy health metrics at the specified interval to reduce noise.

I'm not sure what word will best describe these metrics, but dealer's choice 👍🏼

@mtoffl01 mtoffl01 requested a review from hannahkm December 20, 2024 15:56
@mtoffl01 mtoffl01 merged commit 3961f7f into main Dec 23, 2024
159 of 160 checks passed
@mtoffl01 mtoffl01 deleted the mtoff/refactor-report-health-metrics branch December 23, 2024 19:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants