Introduce hashicorp/go-metrics compatibility (#760)

mkeeler · web-flow · commit 93c69c072b85 · 2025-01-14T09:20:06.000-05:00
* 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 (like it has historically done)

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

* Update README.md

* Bump versions of memberlist and go-metrics to pull in go-metrics compat package
diff --git a/README.md b/README.md
@@ -126,3 +126,29 @@ Tests can be run by typing `make test`.
 
 If you make any changes to the code, run `make format` in order to automatically
 format the code according to Go [standards](https://golang.org/doc/effective_go.html#formatting).
+
+
+ ## 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/cmd/serf/command/agent/command.go b/cmd/serf/command/agent/command.go
@@ -16,7 +16,7 @@ import (
 	"syscall"
 	"time"
 
-	"github.com/armon/go-metrics"
+	"github.com/hashicorp/go-metrics/compat"
 	gsyslog "github.com/hashicorp/go-syslog"
 	"github.com/hashicorp/logutils"
 	"github.com/hashicorp/memberlist"
diff --git a/cmd/serf/command/agent/invoke.go b/cmd/serf/command/agent/invoke.go
@@ -15,7 +15,7 @@ import (
 	"time"
 
 	"github.com/armon/circbuf"
-	"github.com/armon/go-metrics"
+	"github.com/hashicorp/go-metrics/compat"
 	"github.com/hashicorp/serf/serf"
 )
 
diff --git a/cmd/serf/command/agent/ipc.go b/cmd/serf/command/agent/ipc.go
@@ -37,7 +37,7 @@ import (
 	"sync/atomic"
 	"time"
 
-	"github.com/armon/go-metrics"
+	"github.com/hashicorp/go-metrics/compat"
 	"github.com/hashicorp/go-msgpack/v2/codec"
 	"github.com/hashicorp/logutils"
 	"github.com/hashicorp/serf/coordinate"
diff --git a/coordinate/client.go b/coordinate/client.go
@@ -10,7 +10,7 @@ import (
 	"sync"
 	"time"
 
-	"github.com/armon/go-metrics"
+	"github.com/hashicorp/go-metrics/compat"
 )
 
 // Client manages the estimated network coordinate for a given node, and adjusts
diff --git a/coordinate/config.go b/coordinate/config.go
@@ -4,7 +4,7 @@
 package coordinate
 
 import (
-	"github.com/armon/go-metrics"
+	"github.com/hashicorp/go-metrics/compat"
 )
 
 // Config is used to set the parameters of the Vivaldi-based coordinate mapping
diff --git a/go.mod b/go.mod
@@ -4,12 +4,12 @@ go 1.19
 
 require (
 	github.com/armon/circbuf v0.0.0-20150827004946-bbbad097214e
-	github.com/armon/go-metrics v0.4.1
+	github.com/hashicorp/go-metrics v0.5.4
 	github.com/hashicorp/go-msgpack/v2 v2.1.2
 	github.com/hashicorp/go-syslog v1.0.0
 	github.com/hashicorp/logutils v1.0.0
 	github.com/hashicorp/mdns v1.0.5
-	github.com/hashicorp/memberlist v0.5.1
+	github.com/hashicorp/memberlist v0.5.2
 	github.com/mitchellh/cli v1.1.5
 	github.com/mitchellh/mapstructure v1.5.0
 	github.com/ryanuber/columnize v2.1.2+incompatible
@@ -19,6 +19,7 @@ require (
 	github.com/Masterminds/goutils v1.1.1 // indirect
 	github.com/Masterminds/semver/v3 v3.1.1 // indirect
 	github.com/Masterminds/sprig/v3 v3.2.1 // indirect
+	github.com/armon/go-metrics v0.4.1 // indirect
 	github.com/armon/go-radix v1.0.0 // indirect
 	github.com/bgentry/speakeasy v0.1.0 // indirect
 	github.com/fatih/color v1.9.0 // indirect
diff --git a/go.sum b/go.sum
diff --git a/serf/config.go b/serf/config.go
@@ -9,7 +9,7 @@ import (
 	"os"
 	"time"
 
-	"github.com/armon/go-metrics"
+	"github.com/hashicorp/go-metrics/compat"
 	"github.com/hashicorp/memberlist"
 )
 
diff --git a/serf/delegate.go b/serf/delegate.go
@@ -7,7 +7,7 @@ import (
 	"bytes"
 	"fmt"
 
-	"github.com/armon/go-metrics"
+	"github.com/hashicorp/go-metrics/compat"
 	"github.com/hashicorp/go-msgpack/v2/codec"
 	"github.com/hashicorp/memberlist"
 )
diff --git a/serf/ping_delegate.go b/serf/ping_delegate.go
@@ -7,7 +7,7 @@ import (
 	"bytes"
 	"time"
 
-	"github.com/armon/go-metrics"
+	"github.com/hashicorp/go-metrics/compat"
 	"github.com/hashicorp/go-msgpack/v2/codec"
 	"github.com/hashicorp/memberlist"
 	"github.com/hashicorp/serf/coordinate"
diff --git a/serf/serf.go b/serf/serf.go
@@ -19,7 +19,7 @@ import (
 	"sync/atomic"
 	"time"
 
-	"github.com/armon/go-metrics"
+	"github.com/hashicorp/go-metrics/compat"
 	"github.com/hashicorp/go-msgpack/v2/codec"
 	"github.com/hashicorp/memberlist"
 	"github.com/hashicorp/serf/coordinate"
diff --git a/serf/snapshot.go b/serf/snapshot.go
@@ -14,7 +14,7 @@ import (
 	"strings"
 	"time"
 
-	"github.com/armon/go-metrics"
+	"github.com/hashicorp/go-metrics/compat"
 )
 
 /*

Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ import (`
`15`	`15`	`"time"`
`16`	`16`
`17`	`17`	`"github.com/armon/circbuf"`
`18`		`- "github.com/armon/go-metrics"`
	`18`	`+ "github.com/hashicorp/go-metrics/compat"`
`19`	`19`	`"github.com/hashicorp/serf/serf"`
`20`	`20`	`)`
`21`	`21`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ import (`
`10`	`10`	`"sync"`
`11`	`11`	`"time"`
`12`	`12`
`13`		`- "github.com/armon/go-metrics"`
	`13`	`+ "github.com/hashicorp/go-metrics/compat"`
`14`	`14`	`)`
`15`	`15`
`16`	`16`	`// Client manages the estimated network coordinate for a given node, and adjusts`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`	`package coordinate`
`5`	`5`
`6`	`6`	`import (`
`7`		`- "github.com/armon/go-metrics"`
	`7`	`+ "github.com/hashicorp/go-metrics/compat"`
`8`	`8`	`)`
`9`	`9`
`10`	`10`	`// Config is used to set the parameters of the Vivaldi-based coordinate mapping`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ import (`
`9`	`9`	`"os"`
`10`	`10`	`"time"`
`11`	`11`
`12`		`- "github.com/armon/go-metrics"`
	`12`	`+ "github.com/hashicorp/go-metrics/compat"`
`13`	`13`	`"github.com/hashicorp/memberlist"`
`14`	`14`	`)`
`15`	`15`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ import (`
`7`	`7`	`"bytes"`
`8`	`8`	`"fmt"`
`9`	`9`
`10`		`- "github.com/armon/go-metrics"`
	`10`	`+ "github.com/hashicorp/go-metrics/compat"`
`11`	`11`	`"github.com/hashicorp/go-msgpack/v2/codec"`
`12`	`12`	`"github.com/hashicorp/memberlist"`
`13`	`13`	`)`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ import (`
`14`	`14`	`"strings"`
`15`	`15`	`"time"`
`16`	`16`
`17`		`- "github.com/armon/go-metrics"`
	`17`	`+ "github.com/hashicorp/go-metrics/compat"`
`18`	`18`	`)`
`19`	`19`
`20`	`20`	`/*`