Add flag for specifying configuration file path and include cluster name in metric labels

Dockerfile

@@ -23,4 +23,4 @@ WORKDIR /app/
 
 COPY --from=builder /nats-blackbox-exporter .
 
-ENTRYPOINT ["./nats-blackbox-exporter"]
+CMD [ "./nats-blackbox-exporter"]

README.md

@@ -26,7 +26,7 @@ You can deploy and use NATS Blackbox Exporter using Docker images or by building
 ### 1. Using Docker Image 📫
 You can use pre-built Docker images from GitHub Container Registry (GHCR):
 ```bash
-docker run -d -p 8080:8080 --name nats-blackbox-exporter -v ./setting/config.yaml:/app/setting/config.yaml:ro ghcr.io/snapp-incubator/nats-blackbox-exporter:<release-tag>
+docker run -d -p 8080:8080 --name nats-blackbox-exporter -v ./setting/config.yaml:/app/setting/config.yaml:ro ghcr.io/snapp-incubator/nats-blackbox-exporter:<release-tag> --configPath ./setting/config.yaml
 ```
 and then pass environment variables as needed.
 
@@ -50,7 +50,16 @@ You can check the list of parameters with default values in the [config.example.
    Set the necessary environment variables before running the exporter.
 
 2. **Configuration File:**
-   Use a `config.yaml` file to specify the configuration parameters.
+
+   Use a `config.yaml` file to specify configuration parameters. You can specify the path to the config file using the `--configPath` flag.
+
+   Example usage:
+
+   ```bash
+   ./nats-blackbox-exporter --configPath /path/to/config.yaml
+   ```
+
+   Replace `/path/to/config.yaml` with the actual path to your configuration file.
 
 3. **Default Values:**
    If neither environment variables nor a configuration file is provided, the exporter will use default values.

internal/cmd/main.go

@@ -13,9 +13,6 @@ import (
 func main(cfg config.Config, logger *zap.Logger) {
 	natsConfig := cfg.NATS
 
-	// client := natsclient.New(natsConfig, logger)
-	// client.StartMessaging()
-
 	jetstreamClient := natsclient.NewJetstream(natsConfig, logger)
 	jetstreamClient.StartBlackboxTest()
 

internal/cmd/root.go

@@ -7,13 +7,19 @@
 	"github.com/snapp-incubator/nats-blackbox-exporter/internal/logger"
 	"github.com/snapp-incubator/nats-blackbox-exporter/internal/metric"
 	"github.com/spf13/cobra"
+	"github.com/spf13/pflag"
 )
 
 // ExitFailure status code.
 const ExitFailure = 1
 
+var configPath string
+
 func Execute() {
-	cfg := config.New()
+	pflag.StringVar(&configPath, "configPath", "./config.yaml", "Path to config file")
+	pflag.Parse()
+
+	cfg := config.New(configPath)
 
 	logger := logger.New(cfg.Logger)
 

internal/config/config.go

@@ -31,7 +31,7 @@
 )
 
 // New reads configuration with koanf.
-func New() Config {
+func New(configPath string) Config {
 	var instance Config
 
 	k := koanf.New(".")
@@ -42,8 +42,8 @@
 	}
 
 	// load configuration from file
-	if err := k.Load(file.Provider("setting/config.yaml"), yaml.Parser()); err != nil {
-		log.Printf("error loading config.yaml")
+	if err := k.Load(file.Provider(configPath), yaml.Parser()); err != nil {
+		log.Printf("error loading config.yaml from: %s", configPath)
 	}
 
 	// load environment variables

internal/natsclient/jetstream.go

@@ -34,7 +34,7 @@
 	j := &Jetstream{
 		config:  &config,
 		logger:  logger,
-		metrics: NewMetrics(config.ClientName),
+		metrics: NewMetrics(),
 	}
 
 	j.connect()
@@ -140,6 +140,7 @@
 }
 
 func (j *Jetstream) jetstreamSubscribe(h chan *Message, streamName string) {
+	clusterName := j.connection.ConnectedClusterName()
 	for msg := range h {
 		var publishTime time.Time
 		err := publishTime.UnmarshalBinary(msg.Data)
@@ -150,27 +151,30 @@
 		}
 		latency := time.Since(publishTime).Seconds()
 		j.metrics.Latency.With(prometheus.Labels{
-			"stream": streamName,
+			"stream":  streamName,
+			"cluster": clusterName,
 		}).Observe(latency)
 		j.metrics.SuccessCounter.With(prometheus.Labels{
-			"type":   successfulSubscribe,
-			"stream": streamName,
+			"type":    successfulSubscribe,
+			"stream":  streamName,
+			"cluster": clusterName,
 		}).Add(1)
 		j.logger.Info("Received message: ", zap.String("subject", msg.Subject), zap.Float64("latency", latency))
 	}
 }
 
 func (j *Jetstream) jetstreamPublish(subject string, streamName string) {
+	clusterName := j.connection.ConnectedClusterName()
 	for {
 		t, err := time.Now().MarshalBinary()
 		if err != nil {
 			j.logger.Error("could not marshal current time.", zap.Error(err))
 		}
-
 		if ack, err := j.jetstream.Publish(subject, t); err != nil {
 			j.metrics.SuccessCounter.With(prometheus.Labels{
-				"type":   failedPublish,
-				"stream": streamName,
+				"type":    failedPublish,
+				"stream":  streamName,
+				"cluster": clusterName,
 			}).Add(1)
 			if err == nats.ErrTimeout {
 				j.logger.Error("Request timeout: No response received within the timeout period.")
@@ -181,8 +185,9 @@
 			}
 		} else {
 			j.metrics.SuccessCounter.With(prometheus.Labels{
-				"type":   successfulPublish,
-				"stream": streamName,
+				"type":    successfulPublish,
+				"stream":  streamName,
+				"cluster": clusterName,
 			}).Add(1)
 			j.logger.Info("receive ack", zap.String("stream", ack.Stream))
 		}

internal/natsclient/metric.go

@@ -8,6 +8,7 @@
 
 const (
 	Namespace = "nats_blackbox_exporter"
+	Subsystem = "client"
 )
 
 var latencyBuckets = []float64{
@@ -68,30 +69,30 @@
 	return *ev
 }
 
-func NewMetrics(clinetName string) Metrics {
+func NewMetrics() Metrics {
 	return Metrics{
 		Connection: newCounterVec(prometheus.CounterOpts{
 			Namespace:   Namespace,
-			Subsystem:   clinetName,
+			Subsystem:   Subsystem,
 			Name:        "connection_errors_total",
 			Help:        "total number of disconnections and reconnections",
 			ConstLabels: nil,
-		}, []string{"type"}),
+		}, []string{"type", "cluster"}),
 		// nolint: exhaustruct
 		Latency: newHistogramVec(prometheus.HistogramOpts{
 			Namespace:   Namespace,
-			Subsystem:   clinetName,
+			Subsystem:   Subsystem,
 			Name:        "latency",
 			Help:        "from publish to consume duration in seconds",
 			ConstLabels: nil,
 			Buckets:     latencyBuckets,
-		}, []string{"stream"}),
+		}, []string{"stream", "cluster"}),
 		SuccessCounter: newCounterVec(prometheus.CounterOpts{
 			Namespace:   Namespace,
-			Subsystem:   clinetName,
+			Subsystem:   Subsystem,
 			Name:        "success_counter",
 			Help:        "publish and consume success rate",
 			ConstLabels: nil,
-		}, []string{"type", "stream"}),
+		}, []string{"type", "stream", "cluster"}),
 	}
 }