d87cb463c9
* adding sdk node removal test * fixing conflicts * testing enos test * testing enos test * testing enos test * fixing test * fixing test * testing pipeline * undo change * addressing comments * testing pipeline * fixing deprecated error Co-authored-by: Tin Vo <tintvo08@gmail.com> |
||
|---|---|---|
| .. | ||
| database | ||
| framework | ||
| helper | ||
| logical | ||
| physical | ||
| plugin | ||
| queue | ||
| rotation | ||
| .copywrite.hcl | ||
| go.mod | ||
| go.sum | ||
| LICENSE | ||
| README.md | ||
Vault SDK libs
This package provides the sdk package which contains code useful for
developing Vault plugins.
Although we try not to break functionality, we reserve the right to reorganize
the code at will and may occasionally cause breaks if they are warranted. As
such we expect the tag of this module will stay less than v1.0.0.
For any major changes we will try to give advance notice in the CHANGES section of Vault's CHANGELOG.md.
Metrics Emission and Compatibility
This module can emit metrics using either github.com/armon/go-metrics or github.com/hashicorp/go-metrics. Choosing between the libraries is controlled via build tags.
Build Tags
armonmetrics- Using this tag will cause metrics to be routed toarmon/go-metricshashicorpmetrics- Using this tag will cause all metrics to be routed tohashicorp/go-metrics
If no build tag is specified, the default behavior is to use armon/go-metrics.
Deprecating armon/go-metrics
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.
Migration
To migrate an application currently using the older armon/go-metrics to instead use hashicorp/go-metrics the following should be done.
- Upgrade libraries using
armon/go-metricsto consumehashicorp/go-metrics/compatinstead. This should involve only changing import statements. All repositories in thehashicorpnamespace will be migrated by February of 2025. - Update the application's library dependencies to those that have the compatibility layer configured.
- Update the application to use
hashicorp/go-metricsfor configuring metrics export instead ofarmon/go-metrics- Replace all application imports of
github.com/armon/go-metricswithgithub.com/hashicorp/go-metrics - Instrument your build system to build with the
hashicorpmetricstag.
- Replace all application imports of