chore: clusterinfo.Retriever injected into collectors

rneuter · rneuter · commit d6672351e6a8 · 2025-06-05T18:40:52.000+02:00
Signed-off-by: Rémy Neuter &lt;remy.neuter@gmail.com&gt;
diff --git a/collector/cluster_info.go b/collector/cluster_info.go
@@ -23,6 +23,8 @@ import (
 
 	"github.com/blang/semver/v4"
 	"github.com/prometheus/client_golang/prometheus"
+
+	"github.com/prometheus-community/elasticsearch_exporter/pkg/clusterinfo"
 )
 
 func init() {
@@ -35,7 +37,7 @@ type ClusterInfoCollector struct {
 	hc     *http.Client
 }
 
-func NewClusterInfo(logger *slog.Logger, u *url.URL, hc *http.Client) (Collector, error) {
+func NewClusterInfo(logger *slog.Logger, u *url.URL, hc *http.Client, ci *clusterinfo.Retriever) (Collector, error) {
 	return &ClusterInfoCollector{
 		logger: logger,
 		u:      u,
diff --git a/collector/cluster_info_test.go b/collector/cluster_info_test.go
@@ -21,9 +21,12 @@ import (
 	"os"
 	"strings"
 	"testing"
+	"time"
 
 	"github.com/prometheus/client_golang/prometheus/testutil"
 	"github.com/prometheus/common/promslog"
+
+	"github.com/prometheus-community/elasticsearch_exporter/pkg/clusterinfo"
 )
 
 func TestClusterInfo(t *testing.T) {
@@ -80,7 +83,9 @@ func TestClusterInfo(t *testing.T) {
 				t.Fatal(err)
 			}
 
-			c, err := NewClusterInfo(promslog.NewNopLogger(), u, http.DefaultClient)
+			logger := promslog.NewNopLogger()
+			ci := clusterinfo.New(logger, http.DefaultClient, u, time.Duration(300000000000))
+			c, err := NewClusterInfo(logger, u, http.DefaultClient, ci)
 			if err != nil {
 				t.Fatal(err)
 			}
diff --git a/collector/cluster_settings.go b/collector/cluster_settings.go
@@ -26,6 +26,8 @@ import (
 
 	"github.com/imdario/mergo"
 	"github.com/prometheus/client_golang/prometheus"
+
+	"github.com/prometheus-community/elasticsearch_exporter/pkg/clusterinfo"
 )
 
 func init() {
@@ -38,7 +40,7 @@ type ClusterSettingsCollector struct {
 	hc     *http.Client
 }
 
-func NewClusterSettings(logger *slog.Logger, u *url.URL, hc *http.Client) (Collector, error) {
+func NewClusterSettings(logger *slog.Logger, u *url.URL, hc *http.Client, ci *clusterinfo.Retriever) (Collector, error) {
 	return &ClusterSettingsCollector{
 		logger: logger,
 		u:      u,
diff --git a/collector/cluster_settings_test.go b/collector/cluster_settings_test.go
@@ -21,9 +21,12 @@ import (
 	"os"
 	"strings"
 	"testing"
+	"time"
 
 	"github.com/prometheus/client_golang/prometheus/testutil"
 	"github.com/prometheus/common/promslog"
+
+	"github.com/prometheus-community/elasticsearch_exporter/pkg/clusterinfo"
 )
 
 func TestClusterSettingsStats(t *testing.T) {
@@ -136,7 +139,9 @@ elasticsearch_clustersettings_allocation_watermark_low_bytes 5.24288e+07
 				t.Fatal(err)
 			}
 
-			c, err := NewClusterSettings(promslog.NewNopLogger(), u, http.DefaultClient)
+			logger := promslog.NewNopLogger()
+			ci := clusterinfo.New(logger, http.DefaultClient, u, time.Duration(300000000000))
+			c, err := NewClusterSettings(logger, u, http.DefaultClient, ci)
 			if err != nil {
 				t.Fatal(err)
 			}
diff --git a/collector/collector.go b/collector/collector.go
@@ -26,6 +26,8 @@ import (
 
 	"github.com/alecthomas/kingpin/v2"
 	"github.com/prometheus/client_golang/prometheus"
+
+	"github.com/prometheus-community/elasticsearch_exporter/pkg/clusterinfo"
 )
 
 const (
@@ -36,7 +38,7 @@ const (
 	defaultDisabled = false
 )
 
-type factoryFunc func(logger *slog.Logger, u *url.URL, hc *http.Client) (Collector, error)
+type factoryFunc func(logger *slog.Logger, u *url.URL, hc *http.Client, ci *clusterinfo.Retriever) (Collector, error)
 
 var (
 	factories              = make(map[string]factoryFunc)
@@ -97,7 +99,7 @@ type ElasticsearchCollector struct {
 type Option func(*ElasticsearchCollector) error
 
 // NewElasticsearchCollector creates a new ElasticsearchCollector
-func NewElasticsearchCollector(logger *slog.Logger, filters []string, options ...Option) (*ElasticsearchCollector, error) {
+func NewElasticsearchCollector(logger *slog.Logger, filters []string, clusterInfoRetriever *clusterinfo.Retriever, options ...Option) (*ElasticsearchCollector, error) {
 	e := &ElasticsearchCollector{logger: logger}
 	// Apply options to customize the collector
 	for _, o := range options {
@@ -127,7 +129,7 @@ func NewElasticsearchCollector(logger *slog.Logger, filters []string, options ..
 		if collector, ok := initiatedCollectors[key]; ok {
 			collectors[key] = collector
 		} else {
-			collector, err := factories[key](logger.With("collector", key), e.esURL, e.httpClient)
+			collector, err := factories[key](logger.With("collector", key), e.esURL, e.httpClient, clusterInfoRetriever)
 			if err != nil {
 				return nil, err
 			}
diff --git a/collector/data_stream.go b/collector/data_stream.go
@@ -22,6 +22,8 @@ import (
 	"net/url"
 
 	"github.com/prometheus/client_golang/prometheus"
+
+	"github.com/prometheus-community/elasticsearch_exporter/pkg/clusterinfo"
 )
 
 var (
@@ -51,7 +53,7 @@ type DataStream struct {
 }
 
 // NewDataStream defines DataStream Prometheus metrics
-func NewDataStream(logger *slog.Logger, u *url.URL, hc *http.Client) (Collector, error) {
+func NewDataStream(logger *slog.Logger, u *url.URL, hc *http.Client, ci *clusterinfo.Retriever) (Collector, error) {
 	return &DataStream{
 		logger: logger,
 		hc:     hc,
diff --git a/collector/data_stream_test.go b/collector/data_stream_test.go
@@ -21,9 +21,12 @@ import (
 	"os"
 	"strings"
 	"testing"
+	"time"
 
 	"github.com/prometheus/client_golang/prometheus/testutil"
 	"github.com/prometheus/common/promslog"
+
+	"github.com/prometheus-community/elasticsearch_exporter/pkg/clusterinfo"
 )
 
 func TestDataStream(t *testing.T) {
@@ -64,7 +67,9 @@ func TestDataStream(t *testing.T) {
 				t.Fatal(err)
 			}
 
-			c, err := NewDataStream(promslog.NewNopLogger(), u, http.DefaultClient)
+			logger := promslog.NewNopLogger()
+			ci := clusterinfo.New(logger, http.DefaultClient, u, time.Duration(300000000000))
+			c, err := NewDataStream(logger, u, http.DefaultClient, ci)
 			if err != nil {
 				t.Fatal(err)
 			}
diff --git a/collector/health_report.go b/collector/health_report.go
@@ -21,6 +21,8 @@ import (
 	"net/url"
 
 	"github.com/prometheus/client_golang/prometheus"
+
+	"github.com/prometheus-community/elasticsearch_exporter/pkg/clusterinfo"
 )
 
 var (
@@ -166,7 +168,7 @@ type HealthReport struct {
 	url    *url.URL
 }
 
-func NewHealthReport(logger *slog.Logger, url *url.URL, client *http.Client) (Collector, error) {
+func NewHealthReport(logger *slog.Logger, url *url.URL, client *http.Client, ci *clusterinfo.Retriever) (Collector, error) {
 	return &HealthReport{
 		logger: logger,
 		client: client,
diff --git a/collector/health_report_test.go b/collector/health_report_test.go
@@ -21,9 +21,12 @@ import (
 	"os"
 	"strings"
 	"testing"
+	"time"
 
 	"github.com/prometheus/client_golang/prometheus/testutil"
 	"github.com/prometheus/common/promslog"
+
+	"github.com/prometheus-community/elasticsearch_exporter/pkg/clusterinfo"
 )
 
 func TestHealthReport(t *testing.T) {
@@ -156,7 +159,9 @@ func TestHealthReport(t *testing.T) {
 				t.Fatal(err)
 			}
 
-			c, err := NewHealthReport(promslog.NewNopLogger(), u, http.DefaultClient)
+			logger := promslog.NewNopLogger()
+			ci := clusterinfo.New(logger, http.DefaultClient, u, time.Duration(300000000000))
+			c, err := NewHealthReport(logger, u, http.DefaultClient, ci)
 			if err != nil {
 				t.Fatal(err)
 			}
diff --git a/collector/ilm.go b/collector/ilm.go
@@ -22,6 +22,8 @@ import (
 	"net/url"
 
 	"github.com/prometheus/client_golang/prometheus"
+
+	"github.com/prometheus-community/elasticsearch_exporter/pkg/clusterinfo"
 )
 
 var (
@@ -49,7 +51,7 @@ type ILM struct {
 	u      *url.URL
 }
 
-func NewILM(logger *slog.Logger, u *url.URL, hc *http.Client) (Collector, error) {
+func NewILM(logger *slog.Logger, u *url.URL, hc *http.Client, ci *clusterinfo.Retriever) (Collector, error) {
 	return &ILM{
 		logger: logger,
 		hc:     hc,
diff --git a/collector/ilm_test.go b/collector/ilm_test.go
@@ -22,9 +22,12 @@ import (
 	"path"
 	"strings"
 	"testing"
+	"time"
 
 	"github.com/prometheus/client_golang/prometheus/testutil"
 	"github.com/prometheus/common/promslog"
+
+	"github.com/prometheus-community/elasticsearch_exporter/pkg/clusterinfo"
 )
 
 func TestILM(t *testing.T) {
@@ -81,7 +84,9 @@ func TestILM(t *testing.T) {
 				t.Fatal(err)
 			}
 
-			c, err := NewILM(promslog.NewNopLogger(), u, http.DefaultClient)
+			logger := promslog.NewNopLogger()
+			ci := clusterinfo.New(logger, http.DefaultClient, u, time.Duration(300000000000))
+			c, err := NewILM(logger, u, http.DefaultClient, ci)
 			if err != nil {
 				t.Fatal(err)
 			}
diff --git a/collector/slm.go b/collector/slm.go
@@ -21,6 +21,8 @@ import (
 	"net/url"
 
 	"github.com/prometheus/client_golang/prometheus"
+
+	"github.com/prometheus-community/elasticsearch_exporter/pkg/clusterinfo"
 )
 
 var statuses = []string{"RUNNING", "STOPPING", "STOPPED"}
@@ -107,7 +109,7 @@ type SLM struct {
 }
 
 // NewSLM defines SLM Prometheus metrics
-func NewSLM(logger *slog.Logger, u *url.URL, hc *http.Client) (Collector, error) {
+func NewSLM(logger *slog.Logger, u *url.URL, hc *http.Client, ci *clusterinfo.Retriever) (Collector, error) {
 	return &SLM{
 		logger: logger,
 		hc:     hc,
diff --git a/collector/slm_test.go b/collector/slm_test.go
@@ -22,9 +22,12 @@ import (
 	"path"
 	"strings"
 	"testing"
+	"time"
 
 	"github.com/prometheus/client_golang/prometheus/testutil"
 	"github.com/prometheus/common/promslog"
+
+	"github.com/prometheus-community/elasticsearch_exporter/pkg/clusterinfo"
 )
 
 func TestSLM(t *testing.T) {
@@ -123,7 +126,9 @@ func TestSLM(t *testing.T) {
 				t.Fatalf("Failed to parse URL: %s", err)
 			}
 
-			s, err := NewSLM(promslog.NewNopLogger(), u, http.DefaultClient)
+			logger := promslog.NewNopLogger()
+			ci := clusterinfo.New(logger, http.DefaultClient, u, time.Duration(300000000000))
+			s, err := NewSLM(logger, u, http.DefaultClient, ci)
 			if err != nil {
 				t.Fatal(err)
 			}
diff --git a/collector/snapshots.go b/collector/snapshots.go
@@ -23,6 +23,8 @@ import (
 	"path"
 
 	"github.com/prometheus/client_golang/prometheus"
+
+	"github.com/prometheus-community/elasticsearch_exporter/pkg/clusterinfo"
 )
 
 var (
@@ -102,7 +104,7 @@ type Snapshots struct {
 }
 
 // NewSnapshots defines Snapshots Prometheus metrics
-func NewSnapshots(logger *slog.Logger, u *url.URL, hc *http.Client) (Collector, error) {
+func NewSnapshots(logger *slog.Logger, u *url.URL, hc *http.Client, ci *clusterinfo.Retriever) (Collector, error) {
 	return &Snapshots{
 		logger: logger,
 		u:      u,
diff --git a/collector/snapshots_test.go b/collector/snapshots_test.go
@@ -22,9 +22,12 @@ import (
 	"os"
 	"strings"
 	"testing"
+	"time"
 
 	"github.com/prometheus/client_golang/prometheus/testutil"
 	"github.com/prometheus/common/promslog"
+
+	"github.com/prometheus-community/elasticsearch_exporter/pkg/clusterinfo"
 )
 
 func TestSnapshots(t *testing.T) {
@@ -209,7 +212,9 @@ func TestSnapshots(t *testing.T) {
 				t.Fatal(err)
 			}
 
-			c, err := NewSnapshots(promslog.NewNopLogger(), u, http.DefaultClient)
+			logger := promslog.NewNopLogger()
+			ci := clusterinfo.New(logger, http.DefaultClient, u, time.Duration(300000000000))
+			c, err := NewSnapshots(logger, u, http.DefaultClient, ci)
 			if err != nil {
 				t.Fatal(err)
 			}
diff --git a/collector/tasks.go b/collector/tasks.go
@@ -24,6 +24,8 @@ import (
 
 	"github.com/alecthomas/kingpin/v2"
 	"github.com/prometheus/client_golang/prometheus"
+
+	"github.com/prometheus-community/elasticsearch_exporter/pkg/clusterinfo"
 )
 
 // filterByTask global required because collector interface doesn't expose any way to take
@@ -50,7 +52,7 @@ type TaskCollector struct {
 }
 
 // NewTaskCollector defines Task Prometheus metrics
-func NewTaskCollector(logger *slog.Logger, u *url.URL, hc *http.Client) (Collector, error) {
+func NewTaskCollector(logger *slog.Logger, u *url.URL, hc *http.Client, ci *clusterinfo.Retriever) (Collector, error) {
 	logger.Info("task collector created",
 		"actionFilter", actionFilter,
 	)
diff --git a/collector/tasks_test.go b/collector/tasks_test.go
@@ -20,9 +20,12 @@ import (
 	"net/url"
 	"strings"
 	"testing"
+	"time"
 
 	"github.com/prometheus/client_golang/prometheus/testutil"
 	"github.com/prometheus/common/promslog"
+
+	"github.com/prometheus-community/elasticsearch_exporter/pkg/clusterinfo"
 )
 
 func TestTasks(t *testing.T) {
@@ -65,7 +68,9 @@ elasticsearch_task_stats_action{action="indices:data/write/index"} 1
 				t.Fatalf("Failed to parse URL: %s", err)
 			}
 
-			c, err := NewTaskCollector(promslog.NewNopLogger(), u, ts.Client())
+			logger := promslog.NewNopLogger()
+			ci := clusterinfo.New(logger, http.DefaultClient, u, time.Duration(300000000000))
+			c, err := NewTaskCollector(promslog.NewNopLogger(), u, ts.Client(), ci)
 			if err != nil {
 				t.Fatalf("Failed to create collector: %v", err)
 			}
diff --git a/main.go b/main.go
@@ -177,10 +177,15 @@ func main() {
 	// version metric
 	prometheus.MustRegister(versioncollector.NewCollector(name))
 
+	// TODO(@sysadmind): Remove this when we have a better way to get the cluster name to down stream collectors.
+	// cluster info retriever
+	clusterInfoRetriever := clusterinfo.New(logger, httpClient, esURL, *esClusterInfoInterval)
+
 	// create the exporter
 	exporter, err := collector.NewElasticsearchCollector(
 		logger,
 		[]string{},
+		clusterInfoRetriever,
 		collector.WithElasticsearchURL(esURL),
 		collector.WithHTTPClient(httpClient),
 	)
@@ -190,10 +195,6 @@ func main() {
 	}
 	prometheus.MustRegister(exporter)
 
-	// TODO(@sysadmind): Remove this when we have a better way to get the cluster name to down stream collectors.
-	// cluster info retriever
-	clusterInfoRetriever := clusterinfo.New(logger, httpClient, esURL, *esClusterInfoInterval)
-
 	prometheus.MustRegister(collector.NewClusterHealth(logger, httpClient, esURL))
 	prometheus.MustRegister(collector.NewNodes(logger, httpClient, esURL, *esAllNodes, *esNode))
 

Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,8 @@ import (`
`23`	`23`
`24`	`24`	`"github.com/blang/semver/v4"`
`25`	`25`	`"github.com/prometheus/client_golang/prometheus"`
	`26`	`+`
	`27`	`+ "github.com/prometheus-community/elasticsearch_exporter/pkg/clusterinfo"`
`26`	`28`	`)`
`27`	`29`
`28`	`30`	`func init() {`
`@@ -35,7 +37,7 @@ type ClusterInfoCollector struct {`
`35`	`37`	`hc *http.Client`
`36`	`38`	`}`
`37`	`39`
`38`		`-func NewClusterInfo(logger slog.Logger, u url.URL, hc *http.Client) (Collector, error) {`
	`40`	`+func NewClusterInfo(logger slog.Logger, u url.URL, hc http.Client, ci clusterinfo.Retriever) (Collector, error) {`
`39`	`41`	`return &ClusterInfoCollector{`
`40`	`42`	`logger: logger,`
`41`	`43`	`u: u,`
Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,8 @@ import (`
`26`	`26`
`27`	`27`	`"github.com/imdario/mergo"`
`28`	`28`	`"github.com/prometheus/client_golang/prometheus"`
	`29`	`+`
	`30`	`+ "github.com/prometheus-community/elasticsearch_exporter/pkg/clusterinfo"`
`29`	`31`	`)`
`30`	`32`
`31`	`33`	`func init() {`
`@@ -38,7 +40,7 @@ type ClusterSettingsCollector struct {`
`38`	`40`	`hc *http.Client`
`39`	`41`	`}`
`40`	`42`
`41`		`-func NewClusterSettings(logger slog.Logger, u url.URL, hc *http.Client) (Collector, error) {`
	`43`	`+func NewClusterSettings(logger slog.Logger, u url.URL, hc http.Client, ci clusterinfo.Retriever) (Collector, error) {`
`42`	`44`	`return &ClusterSettingsCollector{`
`43`	`45`	`logger: logger,`
`44`	`46`	`u: u,`
Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,8 @@ import (`
`22`	`22`	`"net/url"`
`23`	`23`
`24`	`24`	`"github.com/prometheus/client_golang/prometheus"`
	`25`	`+`
	`26`	`+ "github.com/prometheus-community/elasticsearch_exporter/pkg/clusterinfo"`
`25`	`27`	`)`
`26`	`28`
`27`	`29`	`var (`
`@@ -51,7 +53,7 @@ type DataStream struct {`
`51`	`53`	`}`
`52`	`54`
`53`	`55`	`// NewDataStream defines DataStream Prometheus metrics`
`54`		`-func NewDataStream(logger slog.Logger, u url.URL, hc *http.Client) (Collector, error) {`
	`56`	`+func NewDataStream(logger slog.Logger, u url.URL, hc http.Client, ci clusterinfo.Retriever) (Collector, error) {`
`55`	`57`	`return &DataStream{`
`56`	`58`	`logger: logger,`
`57`	`59`	`hc: hc,`
Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,8 @@ import (`
`21`	`21`	`"net/url"`
`22`	`22`
`23`	`23`	`"github.com/prometheus/client_golang/prometheus"`
	`24`	`+`
	`25`	`+ "github.com/prometheus-community/elasticsearch_exporter/pkg/clusterinfo"`
`24`	`26`	`)`
`25`	`27`
`26`	`28`	`var (`
`@@ -166,7 +168,7 @@ type HealthReport struct {`
`166`	`168`	`url *url.URL`
`167`	`169`	`}`
`168`	`170`
`169`		`-func NewHealthReport(logger slog.Logger, url url.URL, client *http.Client) (Collector, error) {`
	`171`	`+func NewHealthReport(logger slog.Logger, url url.URL, client http.Client, ci clusterinfo.Retriever) (Collector, error) {`
`170`	`172`	`return &HealthReport{`
`171`	`173`	`logger: logger,`
`172`	`174`	`client: client,`