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

Introduce hashicorp/go-metrics compatibility to the SDK module #29358

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

mkeeler
Copy link
Member

@mkeeler mkeeler commented Jan 15, 2025

Description

This updates the sdk module to have dual compatibility with both armon/go-metrics and hashicorp/go-metrics

Compatability is attained with build tags

Using tag armonmetrics or no tag at all will result in the library utilizing github.com/armon/go-metrics for metrics emission

Using tag hashicorpmetrics will result in the library utilizing the updated github.com/hashicorp/go-metrics for metrics emission.

For now this will result in no functional changes to Vault with all metrics still flowing out via armon/go-metrics. Eventually, once all HashiCorp libraries have been updated to have dual compat, Vault and other products/services/applications will be PR'ed to switch them over to using hashicorp/go-metrics. This will include updating the build system to use the hashicorpmetrics functionality.

RFC

TODO only if you're a HashiCorp employee

  • Backport Labels: If this fix needs to be backported, use the appropriate backport/ label that matches the desired release branch. Note that in the CE repo, the latest release branch will look like backport/x.x.x, but older release branches will be backport/ent/x.x.x+ent.
    • LTS: If this fixes a critical security vulnerability or severity 1 bug, it will also need to be backported to the current LTS versions of Vault. To ensure this, use all available enterprise labels.
  • ENT Breakage: If this PR either 1) removes a public function OR 2) changes the signature
    of a public function, even if that change is in a CE file, double check that
    applying the patch for this PR to the ENT repo and running tests doesn't
    break any tests. Sometimes ENT only tests rely on public functions in CE
    files.
  • Jira: If this change has an associated Jira, it's referenced either
    in the PR description, commit message, or branch name.
  • RFC: If this change has an associated RFC, please link it in the description.
  • ENT PR: If this change has an associated ENT PR, please link it in the
    description. Also, make sure the changelog is in this PR, not in your ENT PR.

@mkeeler mkeeler requested a review from a team as a code owner January 15, 2025 15:33
@mkeeler mkeeler requested a review from swayne275 January 15, 2025 15:33
@github-actions github-actions bot added the hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed label Jan 15, 2025
Copy link

github-actions bot commented Jan 15, 2025

Build Results:
Build failed for these jobs: test-containers:failure. Please refer to this workflow to learn more: https://github.com/hashicorp/vault/actions/runs/12814994508

Copy link

github-actions bot commented Jan 15, 2025

CI Results:
All Go tests succeeded! ✅

@mkeeler mkeeler changed the title Introduce hashicorp/go-metrics compatibility Introduce hashicorp/go-metrics compatibility to the SDK module Jan 15, 2025
@mkeeler
Copy link
Member Author

mkeeler commented Jan 15, 2025

A few questions for the Vault team:

  1. My branch is up to date with Vault main and the linter still thinks my protobufs are out of date? Is this something I need to fix?
  2. Should a changelog entry be added as this PR only affects the SDK module and makes no functional or behavioral change to Vault itself?
  3. Presumably I should add the pr/no-milestone label to appease the milestone checker but I would like verification before I do that.

Compatability is attained with build tags

Using tag armonmetrics or no tag at all will result in the library utilizing github.com/armon/go-metrics for metrics emission

Using tag hashicorpmetrics will result in the library utilizing the updated github.com/hashicorp/go-metrics for metrics emission.
@mkeeler mkeeler force-pushed the sdk-metrics-compat branch from 5ad0091 to bbb60be Compare January 16, 2025 18:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant