sql,roachpb: add plan hash correct value to persisted stats

Previosuly, we didn't have the plan hash/gist values, so
a dummy value was being used instead. Now that we have the value,
this commit uses those values to be corrected stored.
The Plan Hash is saved on its own column and is part of a
statement key. A plan gist is a string saved in the metadata
and can later on converted back into a logical plan.

Partially addresses cockroachdb#72129

Release note (sql change): Saving plan hash/gist to the Statements
persisted stats.

pkg/roachpb/app_stats.go

@@ -26,6 +26,7 @@ func (m *StatementStatisticsKey) FingerprintID() StmtFingerprintID {
 		m.Failed,
 		m.ImplicitTxn,
 		m.Database,
+		m.PlanHash,
 	)
 }
 
@@ -34,7 +35,7 @@ func (m *StatementStatisticsKey) FingerprintID() StmtFingerprintID {
 // these are the axis' we use to bucket queries for stats collection
 // (see stmtKey).
 func ConstructStatementFingerprintID(
-	anonymizedStmt string, failed bool, implicitTxn bool, database string,
+	anonymizedStmt string, failed bool, implicitTxn bool, database string, planHash uint64,
 ) StmtFingerprintID {
 	fnv := util.MakeFNV64()
 	for _, c := range anonymizedStmt {
@@ -53,6 +54,7 @@ func ConstructStatementFingerprintID(
 	} else {
 		fnv.Add('E')
 	}
+	fnv.Add(planHash)
 	return StmtFingerprintID(fnv.Sum())
 }
 
@@ -161,13 +163,13 @@ func (s *StatementStatistics) Add(other *StatementStatistics) {
 	s.RowsRead.Add(other.RowsRead, s.Count, other.Count)
 	s.RowsWritten.Add(other.RowsWritten, s.Count, other.Count)
 	s.Nodes = util.CombineUniqueInt64(s.Nodes, other.Nodes)
+	s.PlanGists = util.CombineUniqueString(s.PlanGists, other.PlanGists)
 
 	s.ExecStats.Add(other.ExecStats)
 
 	if other.SensitiveInfo.LastErr != "" {
 		s.SensitiveInfo.LastErr = other.SensitiveInfo.LastErr
 	}
-
 	if s.SensitiveInfo.MostRecentPlanTimestamp.Before(other.SensitiveInfo.MostRecentPlanTimestamp) {
 		s.SensitiveInfo = other.SensitiveInfo
 	}

pkg/roachpb/app_stats.proto

@@ -104,6 +104,12 @@ message StatementStatistics {
   // Nodes is the ordered list of nodes ids on which the statement was executed.
   repeated int64 nodes = 24;
 
+  // plan_gists is list of a compressed version of plan that can be converted (lossily)
+  // back into a logical plan.
+  // Each statement contain only one plan gist, but the same statement fingerprint id
+  // can contain more than one value.
+  repeated string plan_gists = 26;
+
   // Note: be sure to update `sql/app_stats.go` when adding/removing fields here!
 
   reserved 13, 14, 17, 18, 19, 20;

pkg/server/combined_statement_stats.go

@@ -109,6 +109,14 @@ func getFilterAndParams(
 		args = append(args, *end)
 	}
 
+	//buffer.WriteString(`GROUP BY
+	//	aggregated_ts,
+	//	fingerprint_id,
+	//	transaction_fingerprint_id,
+	//	app_name,
+	//	aggregation_interval,
+	//	statistics`)
+
 	// Retrieve the top rows ordered by aggregation time and service latency.
 	buffer.WriteString(fmt.Sprintf(`
 ORDER BY aggregated_ts DESC,(statistics -> 'statistics' -> 'svcLat' ->> 'mean')::float DESC
@@ -199,6 +207,7 @@ func collectCombinedStatements(
 			return nil, err
 		}
 		metadata.Stats.SensitiveInfo.MostRecentPlanDescription = *plan
+		// TODO marylia
 
 		aggInterval := tree.MustBeDInterval(row[7]).Duration
 

pkg/sql/crdb_internal.go

@@ -5051,10 +5051,8 @@ CREATE TABLE crdb_internal.cluster_statement_statistics (
 				transactionFingerprintID := tree.NewDBytes(
 					tree.DBytes(sqlstatsutil.EncodeUint64ToBytes(uint64(statistics.Key.TransactionFingerprintID))))
 
-				// TODO(azhng): properly update plan_hash value once we can expose it
-				//  from the optimizer.
 				planHash := tree.NewDBytes(
-					tree.DBytes(sqlstatsutil.EncodeUint64ToBytes(0)))
+					tree.DBytes(sqlstatsutil.EncodeUint64ToBytes(statistics.Key.PlanHash)))
 
 				metadataJSON, err := sqlstatsutil.BuildStmtMetadataJSON(statistics)
 				if err != nil {

pkg/sql/executor_statement_metrics.go

@@ -163,6 +163,7 @@ func (ex *connExecutor) recordStatementSummary(
 		FullScan:     flags.IsSet(planFlagContainsFullIndexScan) || flags.IsSet(planFlagContainsFullTableScan),
 		Failed:       stmtErr != nil,
 		Database:     planner.SessionData().Database,
+		PlanHash:     planner.instrumentation.planGist.Hash(),
 	}
 
 	// We only populate the transaction fingerprint ID field if we are in an
@@ -204,6 +205,7 @@ func (ex *connExecutor) recordStatementSummary(
 		Nodes:           getNodesFromPlanner(planner),
 		StatementType:   stmt.AST.StatementType(),
 		Plan:            planner.instrumentation.PlanForStats(ctx),
+		PlanGist:        planner.instrumentation.planGist.String(),
 		StatementError:  stmtErr,
 	}
 

pkg/sql/instrumentation.go

@@ -296,6 +296,7 @@ func (ih *instrumentationHelper) Finish(
 			ImplicitTxn: ih.implicitTxn,
 			Database:    p.SessionData().Database,
 			Failed:      retErr != nil,
+			PlanHash:    ih.planGist.Hash(),
 		}
 		// We populate transaction fingerprint ID if this is an implicit transaction.
 		// See executor_statement_metrics.go:recordStatementSummary() for further

pkg/sql/instrumentation_test.go

@@ -47,13 +47,15 @@ func TestSampledStatsCollection(t *testing.T) {
 			stmt string,
 			implicitTxn bool,
 			database string,
+			planHash uint64,
 		) *roachpb.CollectedStatementStatistics {
 			t.Helper()
 			key := roachpb.StatementStatisticsKey{
 				Query:       stmt,
 				ImplicitTxn: implicitTxn,
 				Database:    database,
 				Failed:      false,
+				PlanHash:    planHash,
 			}
 			var stats *roachpb.CollectedStatementStatistics
 			require.NoError(t, server.SQLServer().(*Server).sqlStats.
@@ -65,7 +67,8 @@ func TestSampledStatsCollection(t *testing.T) {
 						if statistics.Key.Query == key.Query &&
 							statistics.Key.ImplicitTxn == key.ImplicitTxn &&
 							statistics.Key.Database == key.Database &&
-							statistics.Key.Failed == key.Failed {
+							statistics.Key.Failed == key.Failed &&
+							statistics.Key.PlanHash == key.PlanHash {
 							stats = statistics
 						}
 
@@ -127,7 +130,7 @@ func TestSampledStatsCollection(t *testing.T) {
 		toggleSampling(true)
 		queryDB(t, db, selectOrderBy)
 
-		stats := getStmtStats(t, s, selectOrderBy, true /* implicitTxn */, "defaultdb")
+		stats := getStmtStats(t, s, selectOrderBy, true /* implicitTxn */, "defaultdb", uint64(0))
 
 		require.Equal(t, int64(2), stats.Stats.Count, "expected to have collected two sets of general stats")
 		require.Equal(t, int64(1), stats.Stats.ExecStats.Count, "expected to have collected exactly one set of execution stats")
@@ -152,8 +155,8 @@ func TestSampledStatsCollection(t *testing.T) {
 		toggleSampling(true)
 		doTxn(t)
 
-		aggStats := getStmtStats(t, s, aggregation, false /* implicitTxn */, "defaultdb")
-		selectStats := getStmtStats(t, s, selectOrderBy, false /* implicitTxn */, "defaultdb")
+		aggStats := getStmtStats(t, s, aggregation, false /* implicitTxn */, "defaultdb", uint64(0))
+		selectStats := getStmtStats(t, s, selectOrderBy, false /* implicitTxn */, "defaultdb", uint64(0))
 
 		require.Equal(t, int64(2), aggStats.Stats.Count, "expected to have collected two sets of general stats")
 		require.Equal(t, int64(1), aggStats.Stats.ExecStats.Count, "expected to have collected exactly one set of execution stats")
@@ -190,7 +193,7 @@ func TestSampledStatsCollection(t *testing.T) {
 
 		// Make sure DEALLOCATE statements are grouped together rather than having
 		// one key per prepared statement name.
-		stats := getStmtStats(t, s, "DEALLOCATE _", true /* implicitTxn */, "defaultdb")
+		stats := getStmtStats(t, s, "DEALLOCATE _", true /* implicitTxn */, "defaultdb", uint64(0))
 
 		require.Equal(t, int64(2), stats.Stats.Count, "expected to have collected two sets of general stats")
 		require.Equal(t, int64(0), stats.Stats.ExecStats.Count, "expected to have collected zero execution stats")

pkg/sql/sqlstats/persistedsqlstats/flush.go

@@ -147,7 +147,7 @@ func (s *PersistedSQLStats) doFlushSingleStmtStats(
 
 		serializedFingerprintID := sqlstatsutil.EncodeUint64ToBytes(uint64(scopedStats.ID))
 		serializedTransactionFingerprintID := sqlstatsutil.EncodeUint64ToBytes(uint64(scopedStats.Key.TransactionFingerprintID))
-		serializedPlanHash := sqlstatsutil.EncodeUint64ToBytes(uint64(dummyPlanHash))
+		serializedPlanHash := sqlstatsutil.EncodeUint64ToBytes(scopedStats.Key.PlanHash)
 
 		insertFn := func(ctx context.Context, txn *kv.Txn) (alreadyExists bool, err error) {
 			rowsAffected, err := s.insertStatementStats(
@@ -417,7 +417,7 @@ WHERE fingerprint_id = $2
 			"plan_hash: %d, "+
 			"node_id: %d",
 			serializedFingerprintID, serializedTransactionFingerprintID, stats.Key.App,
-			aggregatedTs, dummyPlanHash, s.cfg.SQLIDContainer.SQLInstanceID())
+			aggregatedTs, serializedPlanHash, s.cfg.SQLIDContainer.SQLInstanceID())
 	}
 
 	return nil
@@ -581,12 +581,12 @@ FOR UPDATE
 	if row == nil {
 		return errors.AssertionFailedf(
 			"statement statistics not found fingerprint_id: %s, app: %s, aggregated_ts: %s, plan_hash: %d, node_id: %d",
-			serializedFingerprintID, key.App, aggregatedTs, dummyPlanHash, s.cfg.SQLIDContainer.SQLInstanceID())
+			serializedFingerprintID, key.App, aggregatedTs, serializedPlanHash, s.cfg.SQLIDContainer.SQLInstanceID())
 	}
 
 	if len(row) != 1 {
 		return errors.AssertionFailedf("unexpectedly found %d returning columns for fingerprint_id: %s, app: %s, aggregated_ts: %s, plan_hash %d, node_id: %d",
-			len(row), serializedFingerprintID, key.App, aggregatedTs, dummyPlanHash,
+			len(row), serializedFingerprintID, key.App, aggregatedTs, serializedPlanHash,
 			s.cfg.SQLIDContainer.SQLInstanceID())
 	}
 

pkg/sql/sqlstats/persistedsqlstats/provider.go

@@ -34,14 +34,6 @@ import (
 	"github.com/cockroachdb/errors"
 )
 
-const (
-	// TODO(azhng): currently we do not have the ability to compute a hash for
-	//  query plan. This is currently being worked on by the SQL Queries team.
-	//  Once we are able get consistent hash value from a query plan, we should
-	//  update this.
-	dummyPlanHash = int64(0)
-)
-
 // ErrConcurrentSQLStatsCompaction is reported when two sql stats compaction
 // jobs are issued concurrently. This is a sentinel error.
 var ErrConcurrentSQLStatsCompaction = errors.New("another sql stats compaction job is already running")

pkg/sql/sqlstats/persistedsqlstats/sqlstatsutil/json_impl.go

@@ -99,6 +99,7 @@ func (s *stmtStatsMetadata) jsonFields() jsonFields {
 		{"implicitTxn", (*jsonBool)(&s.Key.ImplicitTxn)},
 		{"vec", (*jsonBool)(&s.Key.Vec)},
 		{"fullScan", (*jsonBool)(&s.Key.FullScan)},
+		{"planGists", (*stringArray)(&s.Stats.PlanGists)},
 	}
 }
 
@@ -135,6 +136,39 @@ func (a *int64Array) encodeJSON() (json.JSON, error) {
 	return builder.Build(), nil
 }
 
+type stringArray []string
+
+func (a *stringArray) decodeJSON(js json.JSON) error {
+	arrLen := js.Len()
+	for i := 0; i < arrLen; i++ {
+		var value jsonString
+		valJSON, err := js.FetchValIdx(i)
+		if err != nil {
+			return err
+		}
+		if err := value.decodeJSON(valJSON); err != nil {
+			return err
+		}
+		*a = append(*a, string(value))
+	}
+
+	return nil
+}
+
+func (a *stringArray) encodeJSON() (json.JSON, error) {
+	builder := json.NewArrayBuilder(len(*a))
+
+	for _, value := range *a {
+		jsVal, err := (*jsonString)(&value).encodeJSON()
+		if err != nil {
+			return nil, err
+		}
+		builder.Add(jsVal)
+	}
+
+	return builder.Build(), nil
+}
+
 type stmtFingerprintIDArray []roachpb.StmtFingerprintID
 
 func (s *stmtFingerprintIDArray) decodeJSON(js json.JSON) error {

pkg/sql/sqlstats/ssmemstorage/ss_mem_iterator.go

@@ -94,6 +94,7 @@ func (s *StmtStatsIterator) Next() bool {
 			Failed:                   stmtKey.failed,
 			App:                      s.container.appName,
 			Database:                 database,
+			PlanHash:                 stmtKey.planHash,
 			TransactionFingerprintID: stmtKey.transactionFingerprintID,
 		},
 		ID:    stmtFingerprintID,

pkg/sql/sqlstats/ssmemstorage/ss_mem_storage.go

@@ -49,6 +49,7 @@ type planKey struct {
 	failed         bool
 	implicitTxn    bool
 	database       string
+	planHash       uint64
 }
 
 func (p planKey) size() int64 {
@@ -255,6 +256,7 @@ func NewTempContainerFromExistingStmtStats(
 				failed:         statistics[i].Key.KeyData.Failed,
 				implicitTxn:    statistics[i].Key.KeyData.ImplicitTxn,
 				database:       statistics[i].Key.KeyData.Database,
+				planHash:       statistics[i].Key.KeyData.PlanHash,
 			},
 			transactionFingerprintID: statistics[i].Key.KeyData.TransactionFingerprintID,
 		}
@@ -472,6 +474,7 @@ func (s *Container) getStatsForStmt(
 	implicitTxn bool,
 	database string,
 	failed bool,
+	planHash uint64,
 	transactionFingerprintID roachpb.TransactionFingerprintID,
 	createIfNonexistent bool,
 ) (
@@ -489,6 +492,7 @@ func (s *Container) getStatsForStmt(
 			failed:         failed,
 			implicitTxn:    implicitTxn,
 			database:       database,
+			planHash:       planHash,
 		},
 		transactionFingerprintID: transactionFingerprintID,
 	}
@@ -662,6 +666,7 @@ func (s *Container) MergeApplicationStatementStats(
 					failed:         statistics.Key.Failed,
 					implicitTxn:    statistics.Key.ImplicitTxn,
 					database:       statistics.Key.Database,
+					planHash:       statistics.Key.PlanHash,
 				},
 				transactionFingerprintID: statistics.Key.TransactionFingerprintID,
 			}
@@ -916,6 +921,6 @@ type transactionCounts struct {
 
 func constructStatementFingerprintIDFromStmtKey(key stmtKey) roachpb.StmtFingerprintID {
 	return roachpb.ConstructStatementFingerprintID(
-		key.anonymizedStmt, key.failed, key.implicitTxn, key.database,
+		key.anonymizedStmt, key.failed, key.implicitTxn, key.database, key.planHash,
 	)
 }

pkg/sql/sqlstats/ssmemstorage/ss_mem_writer.go

@@ -74,6 +74,7 @@ func (s *Container) RecordStatement(
 		key.ImplicitTxn,
 		key.Database,
 		key.Failed,
+		key.PlanHash,
 		key.TransactionFingerprintID,
 		createIfNonExistent,
 	)
@@ -123,6 +124,7 @@ func (s *Container) RecordStatement(
 	stats.mu.data.RowsWritten.Record(stats.mu.data.Count, float64(value.RowsWritten))
 	stats.mu.data.LastExecTimestamp = s.getTimeNow()
 	stats.mu.data.Nodes = util.CombineUniqueInt64(stats.mu.data.Nodes, value.Nodes)
+	stats.mu.data.PlanGists = util.CombineUniqueString(stats.mu.data.PlanGists, []string{value.PlanGist})
 	// Note that some fields derived from tracing statements (such as
 	// BytesSentOverNetwork) are not updated here because they are collected
 	// on-demand.
@@ -170,6 +172,7 @@ func (s *Container) RecordStatementExecStats(
 			key.ImplicitTxn,
 			key.Database,
 			key.Failed,
+			key.PlanHash,
 			key.TransactionFingerprintID,
 			false, /* createIfNotExists */
 		)

pkg/sql/sqlstats/ssprovider.go

@@ -196,6 +196,7 @@ type RecordedStmtStats struct {
 	Nodes           []int64
 	StatementType   tree.StatementType
 	Plan            *roachpb.ExplainTreePlanNode
+	PlanGist        string
 	StatementError  error
 }
 

pkg/ui/workspaces/cluster-ui/src/statementsPage/statementsPage.fixture.ts

@@ -92,6 +92,7 @@ const statementStats: Required<IStatementStatistics> = {
     mean: 2,
     squared_diffs: 0.005,
   },
+  plan_gists: [""],
   exec_stats: execStats,
   last_exec_timestamp: {
     seconds: Long.fromInt(1599670292),

pkg/ui/workspaces/cluster-ui/src/util/appStats/appStats.spec.ts

@@ -274,6 +274,7 @@ function randomStats(
       nanos: 111613000,
     },
     nodes: [Long.fromInt(1), Long.fromInt(3), Long.fromInt(4)],
+    plan_gists: [""],
   };
 }
 

pkg/ui/workspaces/cluster-ui/src/util/appStats/appStats.ts

@@ -174,6 +174,7 @@ export function addStatementStats(
         ? a.last_exec_timestamp
         : b.last_exec_timestamp,
     nodes: uniqueLong([...a.nodes, ...b.nodes]),
+    plan_gists: [""],
   };
 }