feat(statements): show plan_cache_hits field

pingcap · Sep 26, 2023 · 55afb7b · 55afb7b
1 parent 7f677ed
commit 55afb7b
Show file tree

Hide file tree

Showing 8 changed files with 26 additions and 0 deletions.
diff --git a/pkg/apiserver/statement/models.go b/pkg/apiserver/statement/models.go
@@ -84,6 +84,8 @@ type Model struct {
 	AggBinaryPlan            string  `json:"binary_plan" agg:"ANY_VALUE(binary_plan)"`
 	AggPlanDigest            string  `json:"plan_digest" agg:"ANY_VALUE(plan_digest)"`
 	AggPlanHint              *string `json:"plan_hint" agg:"ANY_VALUE(plan_hint)"`
+	AggPlanCacheHits         int     `json:"plan_cache_hits" agg:"SUM(plan_cache_hits)"`
+
 	// RocksDB
 	AggMaxRocksdbDeleteSkippedCount uint `json:"max_rocksdb_delete_skipped_count" agg:"MAX(max_rocksdb_delete_skipped_count)"`
 	AggAvgRocksdbDeleteSkippedCount uint `json:"avg_rocksdb_delete_skipped_count" agg:"CAST(SUM(exec_count * avg_rocksdb_delete_skipped_count) / SUM(exec_count) as SIGNED)"`

diff --git a/ui/packages/tidb-dashboard-client/src/client/api/models/statement-model.ts b/ui/packages/tidb-dashboard-client/src/client/api/models/statement-model.ts
@@ -416,6 +416,12 @@ export interface StatementModel {
      * @memberof StatementModel
      */
     'plan'?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof StatementModel
+     */
+    'plan_cache_hits'?: number;
     /**
      * 
      * @type {boolean}

diff --git a/ui/packages/tidb-dashboard-client/swagger/spec.json b/ui/packages/tidb-dashboard-client/swagger/spec.json
@@ -5440,6 +5440,9 @@
                     "description": "deprecated, replaced by BinaryPlanText",
                     "type": "string"
                 },
+                "plan_cache_hits": {
+                    "type": "integer"
+                },
                 "plan_can_be_bound": {
                     "type": "boolean"
                 },

diff --git a/ui/packages/tidb-dashboard-lib/src/apps/Statement/pages/Detail/PlanDetailTabBasic.tsx b/ui/packages/tidb-dashboard-lib/src/apps/Statement/pages/Detail/PlanDetailTabBasic.tsx
@@ -33,6 +33,10 @@ export const tabBasicItems = (data: StatementModel) => [
     key: 'exec_count',
     value: <ValueWithTooltip.Short value={data.exec_count} />
   },
+  {
+    key: 'plan_cache_hits',
+    value: <ValueWithTooltip.Short value={data.plan_cache_hits} />
+  },
   {
     key: 'sum_latency',
     value: getValueFormat('ns')(data.sum_latency || 0, 1)

diff --git a/ui/packages/tidb-dashboard-lib/src/apps/Statement/translations/en.yaml b/ui/packages/tidb-dashboard-lib/src/apps/Statement/translations/en.yaml
@@ -104,6 +104,8 @@ statement:
     exec_count_tooltip: Total execution count for this kind of statement
     plan_count: '# Plans'
     plan_count_tooltip: Number of distinct execution plans of this statement in current time range
+    plan_cache_hits: '# Plan Cache Hits'
+    plan_cache_hits_tooltip: Number of times the execution plan cache is hit
     avg_latency: Mean Latency
     avg_latency_tooltip: Execution time of single query
     avg_mem: Mean Memory

diff --git a/ui/packages/tidb-dashboard-lib/src/apps/Statement/translations/zh.yaml b/ui/packages/tidb-dashboard-lib/src/apps/Statement/translations/zh.yaml
@@ -102,6 +102,8 @@ statement:
     exec_count_tooltip: 该类 SQL 语句在时间段内被执行的总次数
     plan_count: 计划数
     plan_count_tooltip: 该类 SQL 语句在时间段内的不同执行计划数量
+    plan_cache_hits: 计划缓存命中次数
+    plan_cache_hits_tooltip: 该类 SQL 语句在时间段内的计划缓存命中次数
     avg_latency: 平均耗时
     avg_latency_tooltip: 单条 SQL 查询的执行时间
     avg_mem: 平均内存

diff --git a/ui/packages/tidb-dashboard-lib/src/apps/Statement/utils/tableColumns.tsx b/ui/packages/tidb-dashboard-lib/src/apps/Statement/utils/tableColumns.tsx
@@ -186,6 +186,7 @@ export function statementColumns(
       maxWidth: 300,
       columnActionsMode: ColumnActionsMode.clickable
     }),
+    tcf.bar.single('plan_cache_hits', 'short', rows),
     avgMaxColumn(tcf, 'avg_mem', 'bytes', rows),
     avgMaxColumn(tcf, 'avg_disk', 'bytes', rows),
     errorsWarningsColumn(tcf, rows),

diff --git a/ui/packages/tidb-dashboard-lib/src/client/models.ts b/ui/packages/tidb-dashboard-lib/src/client/models.ts
@@ -3168,6 +3168,12 @@ export interface StatementModel {
      * @memberof StatementModel
      */
     'plan'?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof StatementModel
+     */
+    'plan_cache_hits'?: number;
     /**
      * 
      * @type {boolean}