refactor(fracmanager): reorganize package metrics

Author: eguguchkin

fracmanager/fetcher.go

@@ -6,8 +6,6 @@ import (
 	"sort"
 	"sync"
 
-	"github.com/prometheus/client_golang/prometheus"
-	"github.com/prometheus/client_golang/prometheus/promauto"
 	"go.uber.org/zap"
 
 	"github.com/ozontech/seq-db/frac"
@@ -18,35 +16,6 @@ import (
 	"github.com/ozontech/seq-db/util"
 )
 
-var (
-	fetcherStagesSeconds = promauto.NewHistogramVec(prometheus.HistogramOpts{
-		Namespace: "seq_db_store",
-		Subsystem: "fetcher",
-		Name:      "stages_seconds",
-		Buckets:   metric.SecondsBuckets,
-	}, []string{"stage"})
-	fetcherIDsPerFraction = promauto.NewSummary(prometheus.SummaryOpts{
-		Namespace: "seq_db_store",
-		Subsystem: "fetcher",
-		Name:      "ids_per_fraction",
-	})
-	fetcherWithHints = promauto.NewCounter(prometheus.CounterOpts{
-		Namespace: "seq_db_store",
-		Subsystem: "fetcher",
-		Name:      "requests_with_hints",
-	})
-	fetcherWithoutHint = promauto.NewCounter(prometheus.CounterOpts{
-		Namespace: "seq_db_store",
-		Subsystem: "fetcher",
-		Name:      "requests_without_hints",
-	})
-	fetcherHintMisses = promauto.NewCounter(prometheus.CounterOpts{
-		Namespace: "seq_db_store",
-		Subsystem: "fetcher",
-		Name:      "hint_misses",
-	})
-)
-
 type Fetcher struct {
 	sem chan struct{}
 }

fracmanager/fracmanager.go

@@ -7,16 +7,13 @@ import (
 	"sync"
 	"time"
 
-	"github.com/prometheus/client_golang/prometheus"
-	"github.com/prometheus/client_golang/prometheus/promauto"
 	"go.uber.org/atomic"
 	"go.uber.org/zap"
 
 	"github.com/ozontech/seq-db/config"
 	"github.com/ozontech/seq-db/consts"
 	"github.com/ozontech/seq-db/frac"
 	"github.com/ozontech/seq-db/logger"
-	"github.com/ozontech/seq-db/metric"
 	"github.com/ozontech/seq-db/storage"
 	"github.com/ozontech/seq-db/storage/s3"
 	"github.com/ozontech/seq-db/util"
@@ -251,7 +248,7 @@ func (fm *FracManager) determineOutsiders() []frac.Fraction {
 		}
 	}
 
-	metric.MaintenanceTruncateTotal.Add(float64(truncated))
+	maintenanceTruncateTotal.Add(float64(truncated))
 	return outsiders
 }
 
@@ -276,8 +273,8 @@ func (fm *FracManager) cleanupFractions(cleanupWg *sync.WaitGroup) {
 			offloadStart := time.Now()
 			remote, err := fm.fracProvider.Offload(fm.ctx, outsider)
 			if err != nil {
-				metric.OffloadingTotal.WithLabelValues("failure").Inc()
-				metric.OffloadingDurationSeconds.Observe(float64(time.Since(offloadStart).Seconds()))
+				offloadingTotal.WithLabelValues("failure").Inc()
+				offloadingDurationSeconds.Observe(float64(time.Since(offloadStart).Seconds()))
 
 				logger.Error(
 					"will call Suicide() on fraction: failed to offload fraction",
@@ -298,8 +295,8 @@ func (fm *FracManager) cleanupFractions(cleanupWg *sync.WaitGroup) {
 				return
 			}
 
-			metric.OffloadingTotal.WithLabelValues("success").Inc()
-			metric.OffloadingDurationSeconds.Observe(float64(time.Since(offloadStart).Seconds()))
+			offloadingTotal.WithLabelValues("success").Inc()
+			offloadingDurationSeconds.Observe(float64(time.Since(offloadStart).Seconds()))
 
 			logger.Info(
 				"successully offloaded fraction",
@@ -396,13 +393,13 @@ func (fm *FracManager) processFracsStats() {
 			util.ZapUint64AsSizeStr("index", ft.index),
 		)
 
-		metric.DataSizeTotal.WithLabelValues("total", st).Set(float64(ft.totalSize))
-		metric.DataSizeTotal.WithLabelValues("docs_raw", st).Set(float64(ft.docsRaw))
-		metric.DataSizeTotal.WithLabelValues("docs_on_disk", st).Set(float64(ft.docsDisk))
-		metric.DataSizeTotal.WithLabelValues("index", st).Set(float64(ft.index))
+		dataSizeTotal.WithLabelValues("total", st).Set(float64(ft.totalSize))
+		dataSizeTotal.WithLabelValues("docs_raw", st).Set(float64(ft.docsRaw))
+		dataSizeTotal.WithLabelValues("docs_on_disk", st).Set(float64(ft.docsDisk))
+		dataSizeTotal.WithLabelValues("index", st).Set(float64(ft.index))
 
 		if oldest != 0 {
-			metric.OldestFracTime.WithLabelValues(st).
+			oldestFracTime.WithLabelValues(st).
 				Set((time.Duration(oldest) * time.Millisecond).Seconds())
 		}
 	}
@@ -501,19 +498,6 @@ func (fm *FracManager) Append(ctx context.Context, docs, metas storage.DocBlock)
 	}
 }
 
-var (
-	sealsTotal = promauto.NewCounter(prometheus.CounterOpts{
-		Namespace: "seq_db",
-		Subsystem: "main",
-		Name:      "seals_total",
-	})
-	sealsDoneSeconds = promauto.NewSummary(prometheus.SummaryOpts{
-		Namespace: "seq_db",
-		Subsystem: "main",
-		Name:      "seals_done_seconds",
-	})
-)
-
 func (fm *FracManager) seal(activeRef activeRef) {
 	sealsTotal.Inc()
 	now := time.Now()

fracmanager/fraction_provider.go

@@ -8,8 +8,6 @@ import (
 	"time"
 
 	"github.com/oklog/ulid/v2"
-	"github.com/prometheus/client_golang/prometheus"
-	"github.com/prometheus/client_golang/prometheus/promauto"
 
 	"github.com/ozontech/seq-db/frac"
 	"github.com/ozontech/seq-db/frac/common"
@@ -19,12 +17,6 @@ import (
 	"github.com/ozontech/seq-db/storage/s3"
 )
 
-var storeBytesRead = promauto.NewCounter(prometheus.CounterOpts{
-	Namespace: "seq_db_store",
-	Subsystem: "common",
-	Name:      "bytes_read",
-})
-
 // fractionProvider is a factory for creating different types of fractions
 // Contains all necessary dependencies for creating and managing fractions
 type fractionProvider struct {

fracmanager/metrics.go

@@ -3,9 +3,12 @@ package fracmanager
 import (
 	"github.com/prometheus/client_golang/prometheus"
 	"github.com/prometheus/client_golang/prometheus/promauto"
+
+	"github.com/ozontech/seq-db/metric"
 )
 
 var (
+	// cache's metrics
 	cacheOldest = promauto.NewGaugeVec(prometheus.GaugeOpts{
 		Namespace: "seq_db_store",
 		Subsystem: "cache",
@@ -31,7 +34,6 @@ var (
 		Subsystem: "cache",
 		Name:      "change_generations",
 	}, []string{"cleaner"})
-
 	cacheSizeReleased = promauto.NewCounterVec(prometheus.CounterOpts{
 		Namespace: "seq_db_store",
 		Subsystem: "cache",
@@ -88,10 +90,94 @@ var (
 		Name:      "miss_latency_sec",
 	}, []string{"layer"})
 
+	// fetcher's metrics
+	fetcherStagesSeconds = promauto.NewHistogramVec(prometheus.HistogramOpts{
+		Namespace: "seq_db_store",
+		Subsystem: "fetcher",
+		Name:      "stages_seconds",
+		Buckets:   metric.SecondsBuckets,
+	}, []string{"stage"})
+	fetcherIDsPerFraction = promauto.NewSummary(prometheus.SummaryOpts{
+		Namespace: "seq_db_store",
+		Subsystem: "fetcher",
+		Name:      "ids_per_fraction",
+	})
+	fetcherWithHints = promauto.NewCounter(prometheus.CounterOpts{
+		Namespace: "seq_db_store",
+		Subsystem: "fetcher",
+		Name:      "requests_with_hints",
+	})
+	fetcherWithoutHint = promauto.NewCounter(prometheus.CounterOpts{
+		Namespace: "seq_db_store",
+		Subsystem: "fetcher",
+		Name:      "requests_without_hints",
+	})
+	fetcherHintMisses = promauto.NewCounter(prometheus.CounterOpts{
+		Namespace: "seq_db_store",
+		Subsystem: "fetcher",
+		Name:      "hint_misses",
+	})
+
+	// searchers's metrics
+	searchSubSearches = promauto.NewHistogram(prometheus.HistogramOpts{
+		Namespace: "seq_db_store",
+		Subsystem: "search",
+		Name:      "sub_searches",
+		Buckets:   []float64{0.99, 1, 1.01, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048},
+	})
+
+	// fraction lifecycle metrics
+	sealsTotal = promauto.NewCounter(prometheus.CounterOpts{
+		Namespace: "seq_db",
+		Subsystem: "main",
+		Name:      "seals_total",
+	})
+	sealsDoneSeconds = promauto.NewSummary(prometheus.SummaryOpts{
+		Namespace: "seq_db",
+		Subsystem: "main",
+		Name:      "seals_done_seconds",
+	})
+	maintenanceTruncateTotal = promauto.NewCounter(prometheus.CounterOpts{
+		Namespace: "seq_db_store",
+		Subsystem: "maintenance",
+		Name:      "truncate_total",
+		Help:      "",
+	})
+	offloadingTotal = promauto.NewCounterVec(prometheus.CounterOpts{
+		Namespace: "seq_db_store",
+		Subsystem: "offloading",
+		Name:      "total",
+		Help:      "How many fractions were offloaded",
+	}, []string{"status"})
+	offloadingDurationSeconds = promauto.NewHistogram(prometheus.HistogramOpts{
+		Namespace: "seq_db_store",
+		Subsystem: "offloading",
+		Name:      "duration_seconds",
+		Help:      "How many seconds it took to offload fraction to remote storage",
+		Buckets:   metric.SecondsBuckets,
+	})
+	dataSizeTotal = promauto.NewGaugeVec(prometheus.GaugeOpts{
+		Namespace: "seq_db_store",
+		Subsystem: "common",
+		Name:      "data_size_total",
+	}, []string{"kind", "storage_type"})
+	oldestFracTime = promauto.NewGaugeVec(prometheus.GaugeOpts{
+		Namespace: "seq_db_store",
+		Subsystem: "common",
+		Name:      "oldest_frac_time",
+		Help:      "",
+	}, []string{"storage_type"})
 	fractionLoadErrors = promauto.NewCounter(prometheus.CounterOpts{
 		Namespace: "seq_db_store",
 		Subsystem: "main",
 		Name:      "fraction_load_errors",
 		Help:      "Doc file load errors (missing or invalid doc file)",
 	})
+
+	// disk load metric
+	storeBytesRead = promauto.NewCounter(prometheus.CounterOpts{
+		Namespace: "seq_db_store",
+		Subsystem: "common",
+		Name:      "bytes_read",
+	})
 )

fracmanager/searcher.go

@@ -6,9 +6,6 @@ import (
 	"sort"
 	"sync"
 
-	"github.com/prometheus/client_golang/prometheus"
-	"github.com/prometheus/client_golang/prometheus/promauto"
-
 	"github.com/ozontech/seq-db/consts"
 	"github.com/ozontech/seq-db/frac"
 	"github.com/ozontech/seq-db/frac/processor"
@@ -18,16 +15,6 @@ import (
 	"github.com/ozontech/seq-db/util"
 )
 
-var (
-	searchSubSearches = promauto.NewHistogram(prometheus.HistogramOpts{
-		Namespace: "seq_db_store",
-		Subsystem: "search",
-		Name:      "sub_searches",
-		Help:      "",
-		Buckets:   []float64{0.99, 1, 1.01, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048},
-	})
-)
-
 type SearcherCfg struct {
 	MaxFractionHits       int // the maximum number of fractions used in the search
 	FractionsPerIteration int

metric/store.go

@@ -6,20 +6,6 @@ import (
 )
 
 var (
-	DataSizeTotal = promauto.NewGaugeVec(prometheus.GaugeOpts{
-		Namespace: "seq_db_store",
-		Subsystem: "common",
-		Name:      "data_size_total",
-		Help:      "",
-	}, []string{"kind", "storage_type"})
-
-	OldestFracTime = promauto.NewGaugeVec(prometheus.GaugeOpts{
-		Namespace: "seq_db_store",
-		Subsystem: "common",
-		Name:      "oldest_frac_time",
-		Help:      "",
-	}, []string{"storage_type"})
-
 	BulkDurationSeconds = promauto.NewHistogram(prometheus.HistogramOpts{
 		Namespace: "seq_db_store",
 		Subsystem: "bulk",
@@ -116,12 +102,6 @@ var (
 		Help:      "",
 		Buckets:   prometheus.ExponentialBuckets(256, 4, 32),
 	})
-	MaintenanceTruncateTotal = promauto.NewCounter(prometheus.CounterOpts{
-		Namespace: "seq_db_store",
-		Subsystem: "maintenance",
-		Name:      "truncate_total",
-		Help:      "",
-	})
 
 	StoreReady = promauto.NewGauge(prometheus.GaugeOpts{
 		Namespace: "seq_db_store",
@@ -154,18 +134,4 @@ var (
 	SkippedIndexesBytesText    = skippedIndexesBytes.WithLabelValues("text")
 	SkippedIndexesBytesKeyword = skippedIndexesBytes.WithLabelValues("keyword")
 	SkippedIndexesBytesPath    = skippedIndexesBytes.WithLabelValues("path")
-
-	OffloadingTotal = promauto.NewCounterVec(prometheus.CounterOpts{
-		Namespace: "seq_db_store",
-		Subsystem: "offloading",
-		Name:      "total",
-		Help:      "How many fractions were offloaded",
-	}, []string{"status"})
-	OffloadingDurationSeconds = promauto.NewHistogram(prometheus.HistogramOpts{
-		Namespace: "seq_db_store",
-		Subsystem: "offloading",
-		Name:      "duration_seconds",
-		Help:      "How many seconds it took to offload fraction to remote storage",
-		Buckets:   SecondsBuckets,
-	})
 )