feat: Add new Emitter API to start and stop metrics #18
Conversation
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
IDK where it was there to begin with. The [go module spec][1] says: > The toolchain directive only has an effect when the module is the main > module and the default toolchain’s version is less than the suggested > toolchain’s version. So removing this should not have any impact. [1]: https://go.dev/ref/mod#go-mod-file-toolchain
This brings us inline with the minimal go version required by dd-trace-go and also allows using `cmp.Or` which is introduced by a later commit in this PR.
felixge
commented
Jun 25, 2025
felixge
commented
Jun 25, 2025
felixge
commented
Jun 25, 2025
felixge
commented
Jun 25, 2025
| logger *slog.Logger | ||
| baseTags []string | ||
| unknownMetricLogOnce *sync.Once | ||
| unsupportedKindLogOnce *sync.Once | ||
| } |
There was a problem hiding this comment.
todo: follow-up PR - refactor this into the Emitter type
felixge
force-pushed
the
push-ltsptlnlnkpt
branch
from
1e843fb to
7914529
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a new Emitter API to start and stop the reporting of runtime metrics to a statsd client. Key changes include:
- Refactoring runtime metrics reporting by replacing the global Start function with an Emitter type that provides explicit start/stop semantics.
- Updating tests to exercise the new Emitter API and its idempotent Stop behavior.
- Simplifying base tags handling and updating go.mod for a newer Go version.
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| pkg/runtimemetrics/tags_test.go | Updated tests to directly call getBaseTags inline with tag assertions. |
| pkg/runtimemetrics/tags.go | Simplified getBaseTags by removing unnecessary mutex locking and global state. |
| pkg/runtimetrics/runtime_metrics_test.go | Revised unit tests to leverage the new Emitter API and check for idempotence. |
| pkg/runtimemetrics/runtime_metrics.go | Introduced Options and Emitter, refactored runtime metric store usage, and improved logging. |
| go.mod | Updated the Go version and removed the explicit toolchain specification. |
Comments suppressed due to low confidence (1)
pkg/runtimemetrics/runtime_metrics.go:44
- [nitpick] Consider adding a comment to clarify the behavior and intent of using cmp.Or for selecting default values, to improve code clarity for future maintainers.
logger: cmp.Or(opts.Logger, slog.Default()),
Comment on lines
+81
to
+86
| tick := time.Tick(e.period) | ||
| for { | ||
| select { | ||
| case <-e.stop: | ||
| return | ||
| case <-tick: |
There was a problem hiding this comment.
Consider replacing time.Tick with time.NewTicker to allow proper cleanup of the ticker when the emitter is stopped, thereby avoiding potential resource leaks.
Suggested change
| tick := time.Tick(e.period) | |
| for { | |
| select { | |
| case <-e.stop: | |
| return | |
| case <-tick: | |
| ticker := time.NewTicker(e.period) | |
| defer ticker.Stop() | |
| for { | |
| select { | |
| case <-e.stop: | |
| return | |
| case <-ticker.C: |
Copilot uses AI. Check for mistakes.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.