metrics: attach const label keyspace_id (#41693)

close #41698
pingcap · Mar 3, 2023 · 7235267 · 7235267
1 parent ac6a9eb
commit 7235267
Show file tree

Hide file tree

Showing 85 changed files with 2,097 additions and 879 deletions.
diff --git a/br/cmd/br/BUILD.bazel b/br/cmd/br/BUILD.bazel
@@ -34,6 +34,7 @@ go_library(
         "//session",
         "//util",
         "//util/logutil",
+        "//util/metricsutil",
         "@com_github_gogo_protobuf//proto",
         "@com_github_pingcap_errors//:errors",
         "@com_github_pingcap_kvproto//pkg/brpb",

diff --git a/br/cmd/br/backup.go b/br/cmd/br/backup.go
@@ -13,6 +13,7 @@ import (
 	"github.com/pingcap/tidb/br/pkg/version/build"
 	"github.com/pingcap/tidb/config"
 	"github.com/pingcap/tidb/session"
+	"github.com/pingcap/tidb/util/metricsutil"
 	"github.com/spf13/cobra"
 	"go.uber.org/zap"
 	"sourcegraph.com/sourcegraph/appdash"
@@ -25,6 +26,10 @@ func runBackupCommand(command *cobra.Command, cmdName string) error {
 		return errors.Trace(err)
 	}
 
+	if err := metricsutil.RegisterMetricsForBR(cfg.PD, cfg.KeyspaceName); err != nil {
+		return errors.Trace(err)
+	}
+
 	ctx := GetDefaultContext()
 	if cfg.EnableOpenTracing {
 		var store *appdash.MemoryStore

diff --git a/br/cmd/br/restore.go b/br/cmd/br/restore.go
@@ -15,6 +15,7 @@ import (
 	"github.com/pingcap/tidb/br/pkg/utils"
 	"github.com/pingcap/tidb/br/pkg/version/build"
 	"github.com/pingcap/tidb/session"
+	"github.com/pingcap/tidb/util/metricsutil"
 	"github.com/spf13/cobra"
 	"go.uber.org/zap"
 	"sourcegraph.com/sourcegraph/appdash"
@@ -27,6 +28,10 @@ func runRestoreCommand(command *cobra.Command, cmdName string) error {
 		return errors.Trace(err)
 	}
 
+	if err := metricsutil.RegisterMetricsForBR(cfg.PD, cfg.KeyspaceName); err != nil {
+		return errors.Trace(err)
+	}
+
 	if task.IsStreamRestore(cmdName) {
 		if err := cfg.ParseStreamRestoreFlags(command.Flags()); err != nil {
 			return errors.Trace(err)

diff --git a/domain/BUILD.bazel b/domain/BUILD.bazel
@@ -30,6 +30,7 @@ go_library(
         "//ddl/util",
         "//domain/globalconfigsync",
         "//domain/infosync",
+        "//domain/metrics",
         "//errno",
         "//infoschema",
         "//infoschema/perfschema",

diff --git a/domain/historical_stats.go b/domain/historical_stats.go
@@ -17,19 +17,14 @@ package domain
 import (
 	"github.com/pingcap/errors"
 	"github.com/pingcap/failpoint"
-	"github.com/pingcap/tidb/metrics"
+	domain_metrics "github.com/pingcap/tidb/domain/metrics"
 	"github.com/pingcap/tidb/parser/model"
 	"github.com/pingcap/tidb/sessionctx"
 	"github.com/pingcap/tidb/statistics/handle"
 	"github.com/pingcap/tidb/util/logutil"
 	"go.uber.org/zap"
 )
 
-var (
-	generateHistoricalStatsSuccessCounter = metrics.HistoricalStatsCounter.WithLabelValues("generate", "success")
-	generateHistoricalStatsFailedCounter  = metrics.HistoricalStatsCounter.WithLabelValues("generate", "fail")
-)
-
 // HistoricalStatsWorker indicates for dump historical stats
 type HistoricalStatsWorker struct {
 	tblCH chan int64
@@ -85,10 +80,10 @@ func (w *HistoricalStatsWorker) DumpHistoricalStats(tableID int64, statsHandle *
 		return errors.Errorf("cannot get DBInfo by TableID %d", tableID)
 	}
 	if _, err := statsHandle.RecordHistoricalStatsToStorage(dbInfo.Name.O, tblInfo, tableID, isPartition); err != nil {
-		generateHistoricalStatsFailedCounter.Inc()
+		domain_metrics.GenerateHistoricalStatsFailedCounter.Inc()
 		return errors.Errorf("record table %s.%s's historical stats failed, err:%v", dbInfo.Name.O, tblInfo.Name.O, err)
 	}
-	generateHistoricalStatsSuccessCounter.Inc()
+	domain_metrics.GenerateHistoricalStatsSuccessCounter.Inc()
 	return nil
 }
 

diff --git a/domain/metrics/BUILD.bazel b/domain/metrics/BUILD.bazel
@@ -0,0 +1,12 @@
+load("@io_bazel_rules_go//go:def.bzl", "go_library")
+
+go_library(
+    name = "metrics",
+    srcs = ["metrics.go"],
+    importpath = "github.com/pingcap/tidb/domain/metrics",
+    visibility = ["//visibility:public"],
+    deps = [
+        "//metrics",
+        "@com_github_prometheus_client_golang//prometheus",
+    ],
+)
diff --git a/domain/metrics/metrics.go b/domain/metrics/metrics.go
@@ -0,0 +1,52 @@
+// Copyright 2023 PingCAP, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package metrics
+
+import (
+	"github.com/pingcap/tidb/metrics"
+	"github.com/prometheus/client_golang/prometheus"
+)
+
+// domain metrics vars
+var (
+	GenerateHistoricalStatsSuccessCounter prometheus.Counter
+	GenerateHistoricalStatsFailedCounter  prometheus.Counter
+
+	PlanReplayerDumpTaskSuccess prometheus.Counter
+	PlanReplayerDumpTaskFailed  prometheus.Counter
+
+	PlanReplayerCaptureTaskSendCounter    prometheus.Counter
+	PlanReplayerCaptureTaskDiscardCounter prometheus.Counter
+
+	PlanReplayerRegisterTaskGauge prometheus.Gauge
+)
+
+func init() {
+	InitMetricsVars()
+}
+
+// InitMetricsVars init domain metrics vars.
+func InitMetricsVars() {
+	GenerateHistoricalStatsSuccessCounter = metrics.HistoricalStatsCounter.WithLabelValues("generate", "success")
+	GenerateHistoricalStatsFailedCounter = metrics.HistoricalStatsCounter.WithLabelValues("generate", "fail")
+
+	PlanReplayerDumpTaskSuccess = metrics.PlanReplayerTaskCounter.WithLabelValues("dump", "success")
+	PlanReplayerDumpTaskFailed = metrics.PlanReplayerTaskCounter.WithLabelValues("dump", "fail")
+
+	PlanReplayerCaptureTaskSendCounter = metrics.PlanReplayerTaskCounter.WithLabelValues("capture", "send")
+	PlanReplayerCaptureTaskDiscardCounter = metrics.PlanReplayerTaskCounter.WithLabelValues("capture", "discard")
+
+	PlanReplayerRegisterTaskGauge = metrics.PlanReplayerRegisterTaskGauge
+}
diff --git a/domain/plan_replayer.go b/domain/plan_replayer.go
@@ -28,6 +28,7 @@ import (
 	"github.com/pingcap/errors"
 	"github.com/pingcap/tidb/bindinfo"
 	"github.com/pingcap/tidb/domain/infosync"
+	domain_metrics "github.com/pingcap/tidb/domain/metrics"
 	"github.com/pingcap/tidb/kv"
 	"github.com/pingcap/tidb/metrics"
 	"github.com/pingcap/tidb/parser"
@@ -179,13 +180,6 @@ func insertPlanReplayerSuccessStatusRecord(ctx context.Context, sctx sessionctx.
 	}
 }
 
-var (
-	planReplayerCaptureTaskSendCounter    = metrics.PlanReplayerTaskCounter.WithLabelValues("capture", "send")
-	planReplayerCaptureTaskDiscardCounter = metrics.PlanReplayerTaskCounter.WithLabelValues("capture", "discard")
-
-	planReplayerRegisterTaskGauge = metrics.PlanReplayerRegisterTaskGauge
-)
-
 type planReplayerHandle struct {
 	*planReplayerTaskCollectorHandle
 	*planReplayerTaskDumpHandle
@@ -200,10 +194,10 @@ func (h *planReplayerHandle) SendTask(task *PlanReplayerDumpTask) bool {
 		if !task.IsContinuesCapture {
 			h.planReplayerTaskCollectorHandle.removeTask(task.PlanReplayerTaskKey)
 		}
-		planReplayerCaptureTaskSendCounter.Inc()
+		domain_metrics.PlanReplayerCaptureTaskSendCounter.Inc()
 		return true
 	default:
-		planReplayerCaptureTaskDiscardCounter.Inc()
+		domain_metrics.PlanReplayerCaptureTaskDiscardCounter.Inc()
 		// directly discard the task if the task channel is full in order not to block the query process
 		logutil.BgLogger().Warn("discard one plan replayer dump task",
 			zap.String("sql-digest", task.SQLDigest), zap.String("plan-digest", task.PlanDigest))
@@ -241,7 +235,7 @@ func (h *planReplayerTaskCollectorHandle) CollectPlanReplayerTask() error {
 		}
 	}
 	h.setupTasks(tasks)
-	planReplayerRegisterTaskGauge.Set(float64(len(tasks)))
+	domain_metrics.PlanReplayerRegisterTaskGauge.Set(float64(len(tasks)))
 	return nil
 }
 

diff --git a/domain/plan_replayer_dump.go b/domain/plan_replayer_dump.go
@@ -28,8 +28,8 @@ import (
 	"github.com/pingcap/failpoint"
 	"github.com/pingcap/tidb/bindinfo"
 	"github.com/pingcap/tidb/config"
+	domain_metrics "github.com/pingcap/tidb/domain/metrics"
 	"github.com/pingcap/tidb/infoschema"
-	"github.com/pingcap/tidb/metrics"
 	"github.com/pingcap/tidb/parser/ast"
 	"github.com/pingcap/tidb/parser/model"
 	"github.com/pingcap/tidb/sessionctx"
@@ -151,11 +151,6 @@ func (tne *tableNameExtractor) handleIsView(t *ast.TableName) (bool, error) {
 	return true, nil
 }
 
-var (
-	planReplayerDumpTaskSuccess = metrics.PlanReplayerTaskCounter.WithLabelValues("dump", "success")
-	planReplayerDumpTaskFailed  = metrics.PlanReplayerTaskCounter.WithLabelValues("dump", "fail")
-)
-
 // DumpPlanReplayerInfo will dump the information about sqls.
 // The files will be organized into the following format:
 /*
@@ -224,9 +219,9 @@ func DumpPlanReplayerInfo(ctx context.Context, sctx sessionctx.Context,
 					zap.Strings("sqls", sqls))
 			}
 			errMsg = err.Error()
-			planReplayerDumpTaskFailed.Inc()
+			domain_metrics.PlanReplayerDumpTaskFailed.Inc()
 		} else {
-			planReplayerDumpTaskSuccess.Inc()
+			domain_metrics.PlanReplayerDumpTaskSuccess.Inc()
 		}
 		err1 := zw.Close()
 		if err1 != nil {

diff --git a/executor/BUILD.bazel b/executor/BUILD.bazel
@@ -114,6 +114,7 @@ go_library(
         "//domain/infosync",
         "//errno",
         "//executor/aggfuncs",
+        "//executor/metrics",
         "//expression",
         "//expression/aggregation",
         "//infoschema",