Introduce hashicorp/go-metrics compatibility (#315)

* Introduce hashicorp/go-metrics compatibility 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.
hashicorp · Jan 8, 2025 · 2df46fe · 2df46fe
1 parent 5af4428
commit 2df46fe
Show file tree

Hide file tree

Showing 13 changed files with 193 additions and 35 deletions.
diff --git a/README.md b/README.md
@@ -71,3 +71,28 @@ convergence rate.
 
 For details on all of these extensions, please read our paper "[Lifeguard : SWIM-ing with Situational Awareness](https://arxiv.org/abs/1707.00788)", along with the memberlist source.  We welcome any questions related
 to the protocol on our issue tracker.
+
+## Metrics Emission and Compatibility
+
+This library 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 to `armon/go-metrics`
+* `hashicorpmetrics` - Using this tag will cause all metrics to be routed to `hashicorp/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.
+
+1. Upgrade libraries using `armon/go-metrics` to consume `hashicorp/go-metrics/compat` instead. This should involve only changing import statements. All repositories in the `hashicorp` namespace
+2. Update an applications library dependencies to those that have the compatibility layer configured.
+3. Update the application to use `hashicorp/go-metrics` for configuring metrics export instead of `armon/go-metrics`
+   * Replace all application imports of `github.com/armon/go-metrics` with `github.com/hashicorp/go-metrics`
+   * Instrument your build system to build with the `hashicorpmetrics` tag.
+
+Eventually once the default behavior changes to use `hashicorp/go-metrics` by default (mid-2025), you can drop the `hashicorpmetrics` build tag.
diff --git a/awareness.go b/awareness.go
@@ -7,7 +7,7 @@ import (
 	"sync"
 	"time"
 
-	"github.com/armon/go-metrics"
+	"github.com/hashicorp/go-metrics/compat"
 )
 
 // awareness manages a simple metric for tracking the estimated health of the

diff --git a/config.go b/config.go
@@ -12,7 +12,7 @@ import (
 	"strings"
 	"time"
 
-	"github.com/armon/go-metrics"
+	"github.com/hashicorp/go-metrics/compat"
 	"github.com/hashicorp/go-multierror"
 )
 

diff --git a/go.mod b/go.mod
@@ -3,24 +3,25 @@ module github.com/hashicorp/memberlist
 go 1.20
 
 require (
-	github.com/armon/go-metrics v0.0.0-20180917152333-f0300d1749da
 	github.com/google/btree v0.0.0-20180813153112-4030bb1f1f0c
+	github.com/hashicorp/go-metrics v0.5.4
 	github.com/hashicorp/go-msgpack/v2 v2.1.1
 	github.com/hashicorp/go-multierror v1.0.0
 	github.com/hashicorp/go-sockaddr v1.0.0
 	github.com/miekg/dns v1.1.26
 	github.com/sean-/seed v0.0.0-20170313163322-e2103e2c3529
-	github.com/stretchr/testify v1.2.2
+	github.com/stretchr/testify v1.4.0
 )
 
 require (
+	github.com/armon/go-metrics v0.4.1 // indirect
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/hashicorp/errwrap v1.0.0 // indirect
 	github.com/hashicorp/go-immutable-radix v1.0.0 // indirect
 	github.com/hashicorp/golang-lru v0.5.0 // indirect
-	github.com/pascaldekloe/goe v0.0.0-20180627143212-57f6aae5913c // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
 	golang.org/x/crypto v0.14.0 // indirect
 	golang.org/x/net v0.16.0 // indirect
 	golang.org/x/sys v0.13.0 // indirect
+	gopkg.in/yaml.v2 v2.4.0 // indirect
 )
diff --git a/go.sum b/go.sum
diff --git a/internal/retry/retry.go b/internal/retry/retry.go
@@ -5,14 +5,13 @@
 //
 // A sample retry operation looks like this:
 //
-//   func TestX(t *testing.T) {
-//       retry.Run(t, func(r *retry.R) {
-//           if err := foo(); err != nil {
-//               r.Fatal("f: ", err)
-//           }
-//       })
-//   }
-//
+//	func TestX(t *testing.T) {
+//	    retry.Run(t, func(r *retry.R) {
+//	        if err := foo(); err != nil {
+//	            r.Fatal("f: ", err)
+//	        }
+//	    })
+//	}
 package retry
 
 import (

diff --git a/memberlist.go b/memberlist.go
@@ -30,7 +30,7 @@ import (
 	"sync/atomic"
 	"time"
 
-	"github.com/armon/go-metrics"
+	"github.com/hashicorp/go-metrics/compat"
 	"github.com/hashicorp/go-multierror"
 	"github.com/hashicorp/go-sockaddr"
 	"github.com/miekg/dns"

diff --git a/net.go b/net.go
@@ -15,7 +15,7 @@ import (
 	"sync/atomic"
 	"time"
 
-	"github.com/armon/go-metrics"
+	"github.com/hashicorp/go-metrics/compat"
 	"github.com/hashicorp/go-msgpack/v2/codec"
 )
 

diff --git a/net_transport.go b/net_transport.go
@@ -13,7 +13,7 @@ import (
 	"sync/atomic"
 	"time"
 
-	"github.com/armon/go-metrics"
+	"github.com/hashicorp/go-metrics/compat"
 	sockaddr "github.com/hashicorp/go-sockaddr"
 )
 

diff --git a/queue.go b/queue.go
@@ -134,13 +134,13 @@ type Broadcast interface {
 // You shoud ensure that Invalidates() checks the same uniqueness as the
 // example below:
 //
-// func (b *foo) Invalidates(other Broadcast) bool {
-// 	nb, ok := other.(NamedBroadcast)
-// 	if !ok {
-// 		return false
-// 	}
-// 	return b.Name() == nb.Name()
-// }
+//	func (b *foo) Invalidates(other Broadcast) bool {
+//		nb, ok := other.(NamedBroadcast)
+//		if !ok {
+//			return false
+//		}
+//		return b.Name() == nb.Name()
+//	}
 //
 // Invalidates() isn't currently used for NamedBroadcasts, but that may change
 // in the future.

diff --git a/security.go b/security.go
@@ -13,14 +13,12 @@ import (
 )
 
 /*
-
 Encrypted messages are prefixed with an encryptionVersion byte
 that is used for us to be able to properly encode/decode. We
 currently support the following versions:
 
- 0 - AES-GCM 128, using PKCS7 padding
- 1 - AES-GCM 128, no padding. Padding not needed, caused bloat.
-
+	0 - AES-GCM 128, using PKCS7 padding
+	1 - AES-GCM 128, no padding. Padding not needed, caused bloat.
 */
 type encryptionVersion uint8
 

diff --git a/state.go b/state.go
@@ -13,7 +13,7 @@ import (
 	"sync/atomic"
 	"time"
 
-	"github.com/armon/go-metrics"
+	"github.com/hashicorp/go-metrics/compat"
 )
 
 type NodeStateType int

diff --git a/state_test.go b/state_test.go
@@ -16,7 +16,7 @@ import (
 	"testing"
 	"time"
 
-	"github.com/armon/go-metrics"
+	"github.com/hashicorp/go-metrics/compat"
 	iretry "github.com/hashicorp/memberlist/internal/retry"
 	"github.com/stretchr/testify/require"
 )
-Original file line number
+Diff line change
@@ Expand Up / @@ -7,7 +7,7 @@ import ( @@
     	"sync"
     	"time"
-    	"github.com/armon/go-metrics"
+    	"github.com/hashicorp/go-metrics/compat"
     )
     // awareness manages a simple metric for tracking the estimated health of the
@@ Expand Down @@