recomend to allways set Label

iimos · Dec 30, 2023 · e0498a6 · e0498a6
1 parent 4840ce4
commit e0498a6
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 6 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1 +1,4 @@
-.idea
+/.idea
+/.vscode
+.DS_STORE
+.DS_Store
diff --git a/README.md b/README.md
@@ -24,7 +24,9 @@ import (
 
 ctx := context.Background()
 cfg := sarama.NewConfig()
-err := saramaprom.ExportMetrics(ctx, cfg.MetricRegistry, saramaprom.Options{})
+err := saramaprom.ExportMetrics(ctx, cfg.MetricRegistry, saramaprom.Options{
+	Label: "some name to distinguish between different sarama instances",
+})
 ```
 
 Posible options:
@@ -38,7 +40,9 @@ type Options struct {
 	Namespace string
 	Subsystem string
 
-	// Label specifies value of "label" label. Default "".
+	// Label specifies value of "label" label. It is recomended
+	// to always set the label to avoid collisions between sarama
+	// instances. Default "".
 	Label string
 
 	// FlushInterval specifies interval between updating metrics. Default 1s.

diff --git a/saramaprom.go b/saramaprom.go
@@ -19,7 +19,9 @@ type Options struct {
 	Namespace string
 	Subsystem string
 
-	// Label specifies value of "label" label. Default "".
+	// Label specifies value of "label" label. It is recomended
+	// to always set the label to avoid collisions between sarama
+	// instances. Default "".
 	Label string
 
 	// FlushInterval specifies interval between updating metrics. Default 1s.

diff --git a/saramaprom_test.go b/saramaprom_test.go
@@ -6,12 +6,11 @@ import (
 	"testing"
 	"time"
 
+	"github.com/iimos/saramaprom"
 	"github.com/prometheus/client_golang/prometheus"
 	"github.com/rcrowley/go-metrics"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
-
-	"github.com/iimos/saramaprom"
 )
 
 func TestMetricCreation(t *testing.T) {