From b177dc4e2b2703cee260b77d37ac551544f12344 Mon Sep 17 00:00:00 2001
From: "Chris S. Kim" <ckim@hashicorp.com>
Date: Thu, 2 Mar 2023 12:08:03 -0500
Subject: [PATCH] Suppress AlreadyRegisteredError to fix test retries (#16501)

* Suppress AlreadyRegisteredError to fix test retries

* Remove duplicate sink
---
 lib/telemetry.go | 13 ++++++++++---
 1 file changed, 10 insertions(+), 3 deletions(-)

diff --git a/lib/telemetry.go b/lib/telemetry.go
index b5815ff64e..d07dea96d5 100644
--- a/lib/telemetry.go
+++ b/lib/telemetry.go
@@ -14,6 +14,7 @@ import (
 	"github.com/armon/go-metrics/prometheus"
 	"github.com/hashicorp/go-hclog"
 	"github.com/hashicorp/go-multierror"
+	prometheuscore "github.com/prometheus/client_golang/prometheus"
 
 	"github.com/hashicorp/consul/lib/retry"
 )
@@ -258,7 +259,7 @@ func dogstatdSink(cfg TelemetryConfig, hostname string) (metrics.MetricSink, err
 	return sink, nil
 }
 
-func prometheusSink(cfg TelemetryConfig, hostname string) (metrics.MetricSink, error) {
+func prometheusSink(cfg TelemetryConfig, _ string) (metrics.MetricSink, error) {
 
 	if cfg.PrometheusOpts.Expiration.Nanoseconds() < 1 {
 		return nil, nil
@@ -266,12 +267,19 @@ func prometheusSink(cfg TelemetryConfig, hostname string) (metrics.MetricSink, e
 
 	sink, err := prometheus.NewPrometheusSinkFrom(cfg.PrometheusOpts)
 	if err != nil {
+		// During testing we may try to register the same metrics collector
+		// multiple times in a single run (e.g. a metrics test fails and
+		// we attempt a retry), resulting in an AlreadyRegisteredError.
+		// Suppress this and move on.
+		if errors.As(err, &prometheuscore.AlreadyRegisteredError{}) {
+			return nil, nil
+		}
 		return nil, err
 	}
 	return sink, nil
 }
 
-func circonusSink(cfg TelemetryConfig, hostname string) (metrics.MetricSink, error) {
+func circonusSink(cfg TelemetryConfig, _ string) (metrics.MetricSink, error) {
 	token := cfg.CirconusAPIToken
 	url := cfg.CirconusSubmissionURL
 	if token == "" && url == "" {
@@ -337,7 +345,6 @@ func configureSinks(cfg TelemetryConfig, memSink metrics.MetricSink) (metrics.Fa
 	addSink(statsdSink)
 	addSink(dogstatdSink)
 	addSink(circonusSink)
-	addSink(circonusSink)
 	addSink(prometheusSink)
 
 	if len(sinks) > 0 {