SQL Expression: Add instrumentation for sql expressions (#103758)

2025-04-10 19:51:44 +01:00
parent 778d0b2da4
commit acd843303e
24 changed files with 223 additions and 143 deletions
@@ -0,0 +1,125 @@
+package metrics
+
+import (
+	"github.com/prometheus/client_golang/prometheus"
+)
+
+// ExprMetrics is a struct that contains all the metrics for an implementation of the expressions service
+// shared between multiple versions of expressions service, which are delineated by the subsystem string
+type ExprMetrics struct {
+	DSRequests              *prometheus.CounterVec
+	ExpressionsQuerySummary *prometheus.SummaryVec
+	SqlCommandDuration      *prometheus.HistogramVec
+	SqlCommandErrorCount    *prometheus.CounterVec
+	SqlCommandCellCount     *prometheus.HistogramVec
+}
+
+func newExprMetrics(subsystem string) *ExprMetrics {
+	return &ExprMetrics{
+		DSRequests: prometheus.NewCounterVec(prometheus.CounterOpts{
+			Namespace: "grafana",
+			Subsystem: subsystem,
+			Name:      "ds_queries_total",
+			Help:      "Number of datasource queries made via server side expression requests",
+		}, []string{"error", "dataplane", "datasource_type"}),
+
+		ExpressionsQuerySummary: prometheus.NewSummaryVec(
+			prometheus.SummaryOpts{
+				Namespace:  "grafana",
+				Subsystem:  subsystem,
+				Name:       "expressions_queries_duration_milliseconds",
+				Help:       "Expressions query summary",
+				Objectives: map[float64]float64{0.5: 0.05, 0.9: 0.01, 0.99: 0.001},
+			},
+			[]string{"status"},
+		),
+
+		SqlCommandDuration: prometheus.NewHistogramVec(prometheus.HistogramOpts{
+			Namespace: "grafana",
+			Subsystem: subsystem,
+			Name:      "sql_command_duration_seconds",
+			Help:      "Duration of SQL command execution",
+			Buckets:   prometheus.DefBuckets,
+		}, []string{"status"}),
+
+		SqlCommandErrorCount: prometheus.NewCounterVec(prometheus.CounterOpts{
+			Namespace: "grafana",
+			Subsystem: subsystem,
+			Name:      "sql_command_errors_total",
+			Help:      "Total number of SQL command execution errors",
+		}, []string{}),
+
+		SqlCommandCellCount: prometheus.NewHistogramVec(
+			prometheus.HistogramOpts{
+				Namespace: "grafana",
+				Subsystem: subsystem,
+				Name:      "sql_command_cell_count",
+				Help:      "Distribution of the total number of cells in each SQL command execution",
+				Buckets:   prometheus.ExponentialBuckets(100, 2, 10),
+			},
+			[]string{"status"},
+		),
+	}
+}
+
+// NewSSEMetrics creates a new ExprMetrics struct for the ST implementation of the expressions service
+func NewSSEMetrics(reg prometheus.Registerer) *ExprMetrics {
+	metricsSubSystem := "sse"
+
+	m := &ExprMetrics{
+		DSRequests: newExprMetrics(metricsSubSystem).DSRequests,
+
+		ExpressionsQuerySummary: newExprMetrics(metricsSubSystem).ExpressionsQuerySummary,
+
+		SqlCommandDuration: newExprMetrics(metricsSubSystem).SqlCommandDuration,
+
+		SqlCommandErrorCount: newExprMetrics(metricsSubSystem).SqlCommandErrorCount,
+
+		SqlCommandCellCount: newExprMetrics(metricsSubSystem).SqlCommandCellCount,
+	}
+
+	if reg != nil {
+		reg.MustRegister(
+			m.DSRequests,
+			m.ExpressionsQuerySummary,
+			m.SqlCommandDuration,
+			m.SqlCommandErrorCount,
+			m.SqlCommandCellCount,
+		)
+	}
+
+	return m
+}
+
+// NewQueryServiceExpressionsMetrics creates a new ExprMetrics struct for the query service implementation of the expressions service
+func NewQueryServiceExpressionsMetrics(reg prometheus.Registerer) *ExprMetrics {
+	metricsSubSystem := "queryservice"
+
+	m := &ExprMetrics{
+		DSRequests: newExprMetrics(metricsSubSystem).DSRequests,
+
+		ExpressionsQuerySummary: newExprMetrics(metricsSubSystem).ExpressionsQuerySummary,
+
+		SqlCommandDuration: newExprMetrics(metricsSubSystem).SqlCommandDuration,
+
+		SqlCommandErrorCount: newExprMetrics(metricsSubSystem).SqlCommandErrorCount,
+
+		SqlCommandCellCount: newExprMetrics(metricsSubSystem).SqlCommandCellCount,
+	}
+
+	if reg != nil {
+		reg.MustRegister(
+			m.DSRequests,
+			m.ExpressionsQuerySummary,
+			m.SqlCommandDuration,
+			m.SqlCommandErrorCount,
+			m.SqlCommandCellCount,
+		)
+	}
+
+	return m
+}
+
+func NewTestMetrics() *ExprMetrics {
+	return newExprMetrics("test")
+}