ui: show whether statement hints were applied in DB console

This commit adds a field to the "plan details" shown for statements in
the "statement activity" page of the DB console. The new field indicates
whether any statement hints from `system.statement_hints` were applied
to the statement.

Informs #121502

Release note (sql change): Plan details in the "statement activity" page
of the DB console now show whether any hints from `system.statement_hints`
werer applied to the statement execution.

Author: DrewKimball

pkg/sql/appstatspb/app_stats.go

@@ -214,6 +214,7 @@ func (s *StatementStatistics) Add(other *StatementStatistics) {
 	s.Count += other.Count
 	s.FailureCount += other.FailureCount
 	s.GenericCount += other.GenericCount
+	s.StmtHintsCount += other.StmtHintsCount
 }
 
 // AlmostEqual compares two StatementStatistics and their contained NumericStats

pkg/sql/appstatspb/app_stats.proto

@@ -138,6 +138,10 @@ message StatementStatistics {
   // generic_count is the count of executions that used a generic query plan.
   optional int64 generic_count = 36 [(gogoproto.nullable) = false];
 
+  // stmt_hints_count is the count of executions that applied a hint from the
+  // system.statement_hints table.
+  optional int64 stmt_hints_count = 37 [(gogoproto.nullable) = false];
+
   // Note: be sure to update `sql/app_stats.go` when adding/removing fields here!
 
   reserved 13, 14, 17, 18, 19, 20;

pkg/sql/executor_statement_metrics.go

@@ -225,6 +225,7 @@ func (ex *connExecutor) recordStatementSummary(
 			FingerprintID:        stmtFingerprintID,
 			QuerySummary:         stmt.StmtSummary,
 			Generic:              flags.IsSet(planFlagGeneric),
+			AppliedStmtHints:     len(stmt.Hints) > 0,
 			DistSQL:              flags.ShouldBeDistributed(),
 			Vec:                  flags.IsSet(planFlagVectorized),
 			ImplicitTxn:          implicitTxn,

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

@@ -54,6 +54,7 @@ func TestSQLStatsJsonEncoding(t *testing.T) {
          "firstAttemptCnt": {{.Int64}},
          "failureCount":    {{.Int64}},
          "genericCount":    {{.Int64}},
+         "stmtHintsCount":  {{.Int64}},
          "maxRetries":      {{.Int64}},
          "lastExecAt":      "{{stringifyTime .Time}}",
          "numRows": {

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

@@ -345,6 +345,7 @@ func (s *innerStmtStats) jsonFields() jsonFields {
 		{"lastErrorCode", (*jsonString)(&s.LastErrorCode)},
 		{"failureCount", (*jsonInt)(&s.FailureCount)},
 		{"genericCount", (*jsonInt)(&s.GenericCount)},
+		{"stmtHintsCount", (*jsonInt)(&s.StmtHintsCount)},
 		{"sqlType", (*jsonString)(&s.SQLType)},
 	}
 }

pkg/sql/sqlstats/ssmemstorage/ss_mem_writer.go

@@ -80,6 +80,9 @@ func (s *Container) RecordStatement(ctx context.Context, value *sqlstats.Recorde
 	if value.Generic {
 		stats.mu.data.GenericCount++
 	}
+	if value.AppliedStmtHints {
+		stats.mu.data.StmtHintsCount++
+	}
 	if value.AutoRetryCount == 0 {
 		stats.mu.data.FirstAttemptCount++
 	} else if int64(value.AutoRetryCount) > stats.mu.data.MaxRetries {

pkg/sql/sqlstats/ssmemstorage/ss_mem_writer_test.go

@@ -119,6 +119,7 @@ func TestContainer_Add(t *testing.T) {
 			RowsWritten:        5,
 			Failed:             true,
 			Generic:            true,
+			AppliedStmtHints:   true,
 			StatementError:     errors.New("test error"),
 		}
 		require.NoError(t, src.RecordStatement(ctx, stmtStats))
@@ -161,6 +162,7 @@ func TestContainer_Add(t *testing.T) {
 			RowsWritten:        80,
 			Failed:             true,
 			Generic:            true,
+			AppliedStmtHints:   true,
 			StatementError:     errors.New("test error"),
 		}
 		reducedTxnFingerprintID := appstatspb.TransactionFingerprintID(321)
@@ -208,6 +210,7 @@ func verifyStmtStatsMultiple(
 	require.Equal(t, destStmtStats.mu.data.Count, int64(count))
 	require.Equal(t, destStmtStats.mu.data.FailureCount, int64(count))
 	require.Equal(t, destStmtStats.mu.data.GenericCount, int64(count))
+	require.Equal(t, destStmtStats.mu.data.StmtHintsCount, int64(count))
 	require.InEpsilon(t, float64(stmtStats.RowsAffected), destStmtStats.mu.data.NumRows.Mean, epsilon)
 	require.InEpsilon(t, float64(stmtStats.RowsAffected), destStmtStats.mu.data.NumRows.Mean, epsilon)
 	require.InEpsilon(t, stmtStats.IdleLatencySec, destStmtStats.mu.data.IdleLat.Mean, epsilon)

pkg/sql/sqlstats/ssprovider.go

@@ -71,6 +71,7 @@ type RecordedStmtStats struct {
 	AutoRetryCount           int
 	Failed                   bool
 	Generic                  bool
+	AppliedStmtHints         bool
 	AutoRetryReason          error
 	RowsAffected             int
 	IdleLatencySec           float64

pkg/ui/workspaces/cluster-ui/src/statementDetails/planDetails/planDetails.tsx

@@ -193,6 +193,10 @@ function ExplainPlan({
               label="Generic Query Plan"
               value={RenderCount(plan.stats.generic_count, plan.stats.count)}
             />
+            <SummaryCardItem
+              label="Statement Hints"
+              value={RenderCount(plan.stats.stmt_hints_count, plan.stats.count)}
+            />
             <SummaryCardItem
               label="Distributed"
               value={RenderCount(

pkg/ui/workspaces/cluster-ui/src/statementDetails/planDetails/plansTable.tsx

@@ -33,6 +33,7 @@ const planDetailsColumnLabels = {
   avgExecTime: "Average Execution Time",
   avgRowsRead: "Average Rows Read",
   generic: "Generic Query Plan",
+  stmtHints: "Statement Hints",
   distSQL: "Distributed",
   execCount: "Execution Count",
   fullScan: "Full Scan",
@@ -163,6 +164,17 @@ export const planDetailsTableTitles: PlanDetailsTableTitleType = {
       </Tooltip>
     );
   },
+  stmtHints: () => {
+    return (
+      <Tooltip
+        style="tableTitle"
+        placement="bottom"
+        content={"If hints from statement_hints were applied."}
+      >
+        {planDetailsColumnLabels.stmtHints}
+      </Tooltip>
+    );
+  },
   distSQL: () => {
     return (
       <Tooltip
@@ -380,6 +392,14 @@ export function makeExplainPlanColumns(
       sort: (item: PlanHashStats) =>
         RenderCount(item.stats.generic_count, item.stats.count),
     },
+    {
+      name: "stmtHints",
+      title: planDetailsTableTitles.stmtHints(),
+      cell: (item: PlanHashStats) =>
+        RenderCount(item.stats.stmt_hints_count, item.stats.count),
+      sort: (item: PlanHashStats) =>
+        RenderCount(item.stats.stmt_hints_count, item.stats.count),
+    },
     {
       name: "distSQL",
       title: planDetailsTableTitles.distSQL(),