feat(Insights): add anonymous usage data collection (#3543)

* feat(insights): initial code (WIP) * feat(insights): add more info * feat(insights): add fs info * feat(insights): export insights.Data Signed-off-by: Deluan <deluan@navidrome.org> * feat(insights): more config info Signed-off-by: Deluan <deluan@navidrome.org> * refactor(insights): move data struct to its own package Signed-off-by: Deluan <deluan@navidrome.org> * refactor(insights): omit some attrs if empty Signed-off-by: Deluan <deluan@navidrome.org> * feat(insights): send insights to server, add option to disable Signed-off-by: Deluan <deluan@navidrome.org> * fix(insights): remove info about anonymous login Signed-off-by: Deluan <deluan@navidrome.org> * chore(insights): fix lint Signed-off-by: Deluan <deluan@navidrome.org> * fix(insights): disable collector if EnableExternalServices is false Signed-off-by: Deluan <deluan@navidrome.org> * fix(insights): fix type casting for 32bit platforms Signed-off-by: Deluan <deluan@navidrome.org> * fix(insights): remove EnableExternalServices from the collection (as it will always be false) Signed-off-by: Deluan <deluan@navidrome.org> * chore(insights): fix lint Signed-off-by: Deluan <deluan@navidrome.org> * refactor(insights): rename function for consistency Signed-off-by: Deluan <deluan@navidrome.org> * feat(insights): log the data sent to the collector server Signed-off-by: Deluan <deluan@navidrome.org> * feat(insights): add last collection timestamp to the "about" dialog. Also add opt-out info to the SignUp form Signed-off-by: Deluan <deluan@navidrome.org> * feat(insights): only sends the initial data collection after an admin user is created Signed-off-by: Deluan <deluan@navidrome.org> * feat(insights): remove dangling comment Signed-off-by: Deluan <deluan@navidrome.org> * feat(insights): Translate insights messages Signed-off-by: Deluan <deluan@navidrome.org> * fix(insights): reporting empty library Signed-off-by: Deluan <deluan@navidrome.org> * refactor: move URL to consts.js Signed-off-by: Deluan <deluan@navidrome.org> --------- Signed-off-by: Deluan <deluan@navidrome.org>
2024-12-17 17:10:55 -05:00
parent bc3576e092
commit 8e2052ff95
26 changed files with 665 additions and 39 deletions
@@ -0,0 +1,123 @@
+package metrics
+
+import (
+	"context"
+	"fmt"
+	"strconv"
+	"sync"
+
+	"github.com/navidrome/navidrome/consts"
+	"github.com/navidrome/navidrome/log"
+	"github.com/navidrome/navidrome/model"
+	"github.com/prometheus/client_golang/prometheus"
+)
+
+func WriteInitialMetrics() {
+	getPrometheusMetrics().versionInfo.With(prometheus.Labels{"version": consts.Version}).Set(1)
+}
+
+func WriteAfterScanMetrics(ctx context.Context, dataStore model.DataStore, success bool) {
+	processSqlAggregateMetrics(ctx, dataStore, getPrometheusMetrics().dbTotal)
+
+	scanLabels := prometheus.Labels{"success": strconv.FormatBool(success)}
+	getPrometheusMetrics().lastMediaScan.With(scanLabels).SetToCurrentTime()
+	getPrometheusMetrics().mediaScansCounter.With(scanLabels).Inc()
+}
+
+// Prometheus' metrics requires initialization. But not more than once
+var (
+	prometheusMetricsInstance *prometheusMetrics
+	prometheusOnce            sync.Once
+)
+
+type prometheusMetrics struct {
+	dbTotal           *prometheus.GaugeVec
+	versionInfo       *prometheus.GaugeVec
+	lastMediaScan     *prometheus.GaugeVec
+	mediaScansCounter *prometheus.CounterVec
+}
+
+func getPrometheusMetrics() *prometheusMetrics {
+	prometheusOnce.Do(func() {
+		var err error
+		prometheusMetricsInstance, err = newPrometheusMetrics()
+		if err != nil {
+			log.Fatal("Unable to create Prometheus metrics instance.", err)
+		}
+	})
+	return prometheusMetricsInstance
+}
+
+func newPrometheusMetrics() (*prometheusMetrics, error) {
+	res := &prometheusMetrics{
+		dbTotal: prometheus.NewGaugeVec(
+			prometheus.GaugeOpts{
+				Name: "db_model_totals",
+				Help: "Total number of DB items per model",
+			},
+			[]string{"model"},
+		),
+		versionInfo: prometheus.NewGaugeVec(
+			prometheus.GaugeOpts{
+				Name: "navidrome_info",
+				Help: "Information about Navidrome version",
+			},
+			[]string{"version"},
+		),
+		lastMediaScan: prometheus.NewGaugeVec(
+			prometheus.GaugeOpts{
+				Name: "media_scan_last",
+				Help: "Last media scan timestamp by success",
+			},
+			[]string{"success"},
+		),
+		mediaScansCounter: prometheus.NewCounterVec(
+			prometheus.CounterOpts{
+				Name: "media_scans",
+				Help: "Total success media scans by success",
+			},
+			[]string{"success"},
+		),
+	}
+
+	err := prometheus.DefaultRegisterer.Register(res.dbTotal)
+	if err != nil {
+		return nil, fmt.Errorf("unable to register db_model_totals metrics: %w", err)
+	}
+	err = prometheus.DefaultRegisterer.Register(res.versionInfo)
+	if err != nil {
+		return nil, fmt.Errorf("unable to register navidrome_info metrics: %w", err)
+	}
+	err = prometheus.DefaultRegisterer.Register(res.lastMediaScan)
+	if err != nil {
+		return nil, fmt.Errorf("unable to register media_scan_last metrics: %w", err)
+	}
+	err = prometheus.DefaultRegisterer.Register(res.mediaScansCounter)
+	if err != nil {
+		return nil, fmt.Errorf("unable to register media_scans metrics: %w", err)
+	}
+	return res, nil
+}
+
+func processSqlAggregateMetrics(ctx context.Context, dataStore model.DataStore, targetGauge *prometheus.GaugeVec) {
+	albumsCount, err := dataStore.Album(ctx).CountAll()
+	if err != nil {
+		log.Warn("album CountAll error", err)
+		return
+	}
+	targetGauge.With(prometheus.Labels{"model": "album"}).Set(float64(albumsCount))
+
+	songsCount, err := dataStore.MediaFile(ctx).CountAll()
+	if err != nil {
+		log.Warn("media CountAll error", err)
+		return
+	}
+	targetGauge.With(prometheus.Labels{"model": "media"}).Set(float64(songsCount))
+
+	usersCount, err := dataStore.User(ctx).CountAll()
+	if err != nil {
+		log.Warn("user CountAll error", err)
+		return
+	}
+	targetGauge.With(prometheus.Labels{"model": "user"}).Set(float64(usersCount))
+}