docs: update metrics README to reflect current migration status#677
Merged
tgross merged 1 commit intohashicorp:mainfrom Apr 24, 2026
Merged
Conversation
|
Thank you for your submission! We require that all contributors sign our Contributor License Agreement ("CLA") before we can accept the contribution. Read and sign the agreement Learn more about why HashiCorp requires a CLA and what the CLA includes Have you signed the CLA already but the status is still pending? Recheck it. |
tgross
reviewed
Apr 23, 2026
Comment on lines
+134
to
+136
| Emitting metrics to `armon/go-metrics` is officially deprecated. Usage of `armon/go-metrics` will remain the default until mid-2025 with opt-in support continuing to the end of 2025. | ||
|
|
||
| **Note:** As of mid-2026, the default behavior has not yet changed to `hashicorp/go-metrics`. The `hashicorpmetrics` build tag is still required to use `hashicorp/go-metrics`. We are actively working on completing this migration and will update this documentation when the default changes. Please continue to use the `hashicorpmetrics` build tag if you want to opt into `hashicorp/go-metrics`. |
Member
There was a problem hiding this comment.
Leaving the note about 2025 above doesn't make sense. I'd probably just change this to something like:
Emitting metrics to
armon/go-metricsis officially deprecated, but usage ofarmon/go-metricsis still the default. Please continue to use thehashicorpmetricsbuild tag if you want to opt intohashicorp/go-metrics. #676 will have status updates on the migration.
tgross
requested changes
Apr 23, 2026
- Add note explaining that the default behavior has not yet changed to hashicorp/go-metrics as of mid-2026 - Clarify that hashicorpmetrics build tag is still required - Remove outdated mid-2025 timeline reference - Fixes hashicorp#676
goingforstudying-ctrl
force-pushed
the
fix/update-metrics-readme
branch
from
d680f6c to
d591306
Compare
Contributor
Author
Contributor
Author
tgross
approved these changes
Apr 24, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
Updates the README to accurately reflect the current state of the metrics library migration.
Changes
Motivation
The README stated that the default would change by mid-2025 and that the hashicorpmetrics build tag could be dropped at that point. However, as noted in #676, this migration has not been completed. This documentation update prevents confusion for users who expect the default to have changed.
Fixes #676