Introduce compat package to ease migration from the old armon/go-metrice module name to the current hashicorp/go-metrics name
#169
Conversation
This file contains 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
…trics module name to the current hashicorp/go-metrics name
This was referenced Dec 18, 2024
mukeshjc
previously approved these changes
Jan 6, 2025
README.md
Outdated
| will never get exported. | ||
|
|
||
| Eventually all usage of `armon/go-metrics` should be replaced with usage of `hashicorp/go-metrics`. However, a single | ||
| point-in-time coordinated update across all libraries than an application may depend on isn't always feasible. To faciliate migrations, |
There was a problem hiding this comment.
Nit: typo
... across all libraries that an application ...
... To facilitate migrations ...
There was a problem hiding this comment.
Thanks, this is fixed now.
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.
Introduce the backwards compatibility layer with armon/go-metrics.
The
compatpackage (and its sub-packages) are API compatible witharmon/go-metrics@v0.4.1orhashicorp/go-metrics@v0.5.0. The underlying metrics module will be selected for all consumers of thecompatpackage by utilizing Go build tags.armonmetrics- Using this tag will cause metrics to be emitted viaarmon/go-metricshashicorpmetrics- Using this tag will cause metrics to be emitted viahashicorp/go-metricsIf no build tag is specified the default behavior will be to use
armon/go-metrics(however this behavior will be scheduled to change in 6 months).The intention is that libraries will be updated to consume the
compatpackage and then applications/services that produce the final binaries can use the build tags to control metrics emission globally for all libraries.