execdetails

package
v1.1.0-beta.0...-1fef0d9 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 30, 2026 License: Apache-2.0 Imports: 21 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// CopTimeStr represents the sum of cop-task time spend in TiDB distSQL.
	CopTimeStr = "Cop_time"
	// WaitTimeStr means the time of all coprocessor wait.
	WaitTimeStr = "Wait_time"
	// LockKeysTimeStr means the time interval between pessimistic lock wait start and lock got obtain
	LockKeysTimeStr = "LockKeys_time"
	// RequestCountStr means the request count.
	RequestCountStr = "Request_count"
	// WaitPrewriteBinlogTimeStr means the time of waiting prewrite binlog finished when transaction committing.
	WaitPrewriteBinlogTimeStr = "Wait_prewrite_binlog_time"
	// GetCommitTSTimeStr means the time of getting commit ts.
	GetCommitTSTimeStr = "Get_commit_ts_time"
	// GetLatestTsTimeStr means the time of getting latest ts in async commit and 1pc.
	GetLatestTsTimeStr = "Get_latest_ts_time"
	// CommitBackoffTimeStr means the time of commit backoff.
	CommitBackoffTimeStr = "Commit_backoff_time"
	// BackoffTypesStr means the backoff type.
	BackoffTypesStr = "Backoff_types"
	// SlowestPrewriteRPCDetailStr means the details of the slowest RPC during the transaction 2pc prewrite process.
	SlowestPrewriteRPCDetailStr = "Slowest_prewrite_rpc_detail"
	// CommitPrimaryRPCDetailStr means the details of the slowest RPC during the transaction 2pc commit process.
	CommitPrimaryRPCDetailStr = "Commit_primary_rpc_detail"
	// ResolveLockTimeStr means the time of resolving lock.
	ResolveLockTimeStr = "Resolve_lock_time"
	// LocalLatchWaitTimeStr means the time of waiting in local latch.
	LocalLatchWaitTimeStr = "Local_latch_wait_time"
	// TxnRetryStr means the count of transaction retry.
	TxnRetryStr = "Txn_retry"
	// GetSnapshotTimeStr means the time spent on getting an engine snapshot.
	GetSnapshotTimeStr = "Get_snapshot_time"
	// RocksdbDeleteSkippedCountStr means the count of rocksdb delete skipped count.
	RocksdbDeleteSkippedCountStr = "Rocksdb_delete_skipped_count"
	// RocksdbKeySkippedCountStr means the count of rocksdb key skipped count.
	RocksdbKeySkippedCountStr = "Rocksdb_key_skipped_count"
	// RocksdbBlockCacheHitCountStr means the count of rocksdb block cache hit.
	RocksdbBlockCacheHitCountStr = "Rocksdb_block_cache_hit_count"
	// RocksdbBlockReadCountStr means the count of rocksdb block read.
	RocksdbBlockReadCountStr = "Rocksdb_block_read_count"
	// RocksdbBlockReadByteStr means the bytes of rocksdb block read.
	RocksdbBlockReadByteStr = "Rocksdb_block_read_byte"
	// RocksdbBlockReadTimeStr means the time spent on rocksdb block read.
	RocksdbBlockReadTimeStr = "Rocksdb_block_read_time"

	// ProcessTimeStr represents the sum of process time of all the coprocessor tasks.
	ProcessTimeStr = "Process_time"
	// BackoffTimeStr means the time of all back-off.
	BackoffTimeStr = "Backoff_time"
	// TotalKeysStr means the total scan keys.
	TotalKeysStr = "Total_keys"
	// ProcessKeysStr means the total processed keys.
	ProcessKeysStr = "Process_keys"
	// PreWriteTimeStr means the time of pre-write.
	PreWriteTimeStr = "Prewrite_time"
	// CommitTimeStr means the time of commit.
	CommitTimeStr = "Commit_time"
	// WriteKeysStr means the count of keys in the transaction.
	WriteKeysStr = "Write_keys"
	// WriteSizeStr means the key/value size in the transaction.
	WriteSizeStr = "Write_size"
	// PrewriteRegionStr means the count of region when pre-write.
	PrewriteRegionStr = "Prewrite_region"
)
View Source 
const (
	// TpBasicRuntimeStats is the tp for BasicRuntimeStats.
	TpBasicRuntimeStats int = iota
	// TpRuntimeStatsWithCommit is the tp for RuntimeStatsWithCommit.
	TpRuntimeStatsWithCommit
	// TpRuntimeStatsWithConcurrencyInfo is the tp for RuntimeStatsWithConcurrencyInfo.
	TpRuntimeStatsWithConcurrencyInfo
	// TpSnapshotRuntimeStats is the tp for SnapshotRuntimeStats.
	TpSnapshotRuntimeStats
	// TpHashJoinRuntimeStats is the tp for HashJoinRuntimeStats.
	TpHashJoinRuntimeStats
	// TpHashJoinRuntimeStatsV2 is the tp for hashJoinRuntimeStatsV2.
	TpHashJoinRuntimeStatsV2
	// TpIndexLookUpJoinRuntimeStats is the tp for IndexLookUpJoinRuntimeStats.
	TpIndexLookUpJoinRuntimeStats
	// TpRuntimeStatsWithSnapshot is the tp for RuntimeStatsWithSnapshot.
	TpRuntimeStatsWithSnapshot
	// TpJoinRuntimeStats is the tp for JoinRuntimeStats.
	TpJoinRuntimeStats
	// TpSelectResultRuntimeStats is the tp for SelectResultRuntimeStats.
	TpSelectResultRuntimeStats
	// TpInsertRuntimeStat is the tp for InsertRuntimeStat
	TpInsertRuntimeStat
	// TpIndexLookUpRunTimeStats is the tp for IndexLookUpRunTimeStats
	TpIndexLookUpRunTimeStats
	// TpSlowQueryRuntimeStat is the tp for SlowQueryRuntimeStat
	TpSlowQueryRuntimeStat
	// TpHashAggRuntimeStat is the tp for HashAggRuntimeStat
	TpHashAggRuntimeStat
	// TpIndexMergeRunTimeStats is the tp for IndexMergeRunTimeStats
	TpIndexMergeRunTimeStats
	// TpBasicCopRunTimeStats is the tp for BasicCopRunTimeStats
	TpBasicCopRunTimeStats
	// TpUpdateRuntimeStats is the tp for UpdateRuntimeStats
	TpUpdateRuntimeStats
	// TpFKCheckRuntimeStats is the tp for FKCheckRuntimeStats
	TpFKCheckRuntimeStats
	// TpFKCascadeRuntimeStats is the tp for FKCascadeRuntimeStats
	TpFKCascadeRuntimeStats
	// TpRURuntimeStats is the tp for RURuntimeStats
	TpRURuntimeStats
)
View Source 
const MaxDetailsNumsForOneQuery = 1000

MaxDetailsNumsForOneQuery is the max number of details to keep for P90 for one query.

Variables

View Source 
var RUV2MetricsCtxKey = ruv2MetricsKeyType{}

RUV2MetricsCtxKey is used to carry statement-level RUv2 metrics in context.Context.

View Source 
var StmtExecDetailKey = stmtExecDetailKeyType{}

StmtExecDetailKey used to carry StmtExecDetail info in context.Context.

Functions

func ContextWithInitializedExecDetails 

func ContextWithInitializedExecDetails(ctx context.Context) context.Context

ContextWithInitializedExecDetails returns a context with initialized stmt execution, execution and resource usage details.

func FormatDuration 

func FormatDuration(d time.Duration) string

FormatDuration uses to format duration, this function will prune precision before format duration. Pruning precision is for human readability. The prune rule is:

  1. if the duration was less than 1us, return the original string.
  2. readable value >=10, keep 1 decimal, otherwise, keep 2 decimal. such as: 9.412345ms -> 9.41ms 10.412345ms -> 10.4ms 5.999s -> 6s 100.45µs -> 100.5µs

func FormatRUV2Metrics 

func FormatRUV2Metrics(metrics *RUV2Metrics, weights RUV2Weights, tiKVRU, tiFlashRU float64) string

FormatRUV2Metrics formats RUv2 metrics into a compact detail string.

func FormatRUV2Summary 

func FormatRUV2Summary(metrics *RUV2Metrics, weights RUV2Weights, tiKVRU, tiFlashRU float64) (total string, detail string)

FormatRUV2Summary formats the RUv2 total and detailed metrics in one pass.

func FormatRUV2Total 

func FormatRUV2Total(metrics *RUV2Metrics, weights RUV2Weights, tiKVRU, tiFlashRU float64) string

FormatRUV2Total formats the RUv2 total into a slow log string.

func MergeTiFlashRUConsumption 

func MergeTiFlashRUConsumption(executionSummaries []*tipb.ExecutorExecutionSummary, ruDetails *util.RUDetails) error

MergeTiFlashRUConsumption merge execution summaries from selectResponse into ruDetails.

Types

type BasicRuntimeStats 

type BasicRuntimeStats struct {
	// contains filtered or unexported fields
}

BasicRuntimeStats is the basic runtime stats.

func (*BasicRuntimeStats) Clone 

func (*BasicRuntimeStats) Clone() RuntimeStats

Clone implements the RuntimeStats interface. BasicRuntimeStats shouldn't implement Clone interface because all executors with the same executor_id should share the same BasicRuntimeStats, duplicated BasicRuntimeStats are easy to cause mistakes.

func (*BasicRuntimeStats) GetActRows 

func (e *BasicRuntimeStats) GetActRows() int64

GetActRows return total rows of BasicRuntimeStats.

func (*BasicRuntimeStats) GetTime 

func (e *BasicRuntimeStats) GetTime() int64

GetTime get the int64 total time

func (*BasicRuntimeStats) Merge 

func (e *BasicRuntimeStats) Merge(rs RuntimeStats)

Merge implements the RuntimeStats interface.

func (*BasicRuntimeStats) Record 

func (e *BasicRuntimeStats) Record(d time.Duration, rowNum int)

Record records executor's execution.

func (*BasicRuntimeStats) RecordClose 

func (e *BasicRuntimeStats) RecordClose(d time.Duration)

RecordClose records executor's close time.

func (*BasicRuntimeStats) RecordOpen 

func (e *BasicRuntimeStats) RecordOpen(d time.Duration)

RecordOpen records executor's open time.

func (*BasicRuntimeStats) SetRowNum 

func (e *BasicRuntimeStats) SetRowNum(rowNum int64)

SetRowNum sets the row num.

func (*BasicRuntimeStats) String 

func (e *BasicRuntimeStats) String() string

String implements the RuntimeStats interface.

func (*BasicRuntimeStats) Tp 

func (*BasicRuntimeStats) Tp() int

Tp implements the RuntimeStats interface.

type ConcurrencyInfo 

type ConcurrencyInfo struct {
	// contains filtered or unexported fields
}

ConcurrencyInfo is used to save the concurrency information of the executor operator

func NewConcurrencyInfo 

func NewConcurrencyInfo(name string, num int) *ConcurrencyInfo

NewConcurrencyInfo creates new executor's concurrencyInfo.

type CopExecDetails 

type CopExecDetails struct {
	ScanDetail    *util.ScanDetail
	TimeDetail    util.TimeDetail
	CalleeAddress string
	BackoffTime   time.Duration
	BackoffSleep  map[string]time.Duration
	BackoffTimes  map[string]int
}

CopExecDetails contains cop execution detail information.

type CopRuntimeStats 

type CopRuntimeStats struct {
	// contains filtered or unexported fields
}

CopRuntimeStats collects cop tasks' execution info.

func (*CopRuntimeStats) GetActRows 

func (crs *CopRuntimeStats) GetActRows() int64

GetActRows return total rows of CopRuntimeStats.

func (*CopRuntimeStats) GetTasks 

func (crs *CopRuntimeStats) GetTasks() int32

GetTasks return total tasks of CopRuntimeStats

func (*CopRuntimeStats) String 

func (crs *CopRuntimeStats) String() string

type CopTasksDetails 

type CopTasksDetails struct {
	NumCopTasks int

	ProcessTimeStats TaskTimeStats
	WaitTimeStats    TaskTimeStats

	BackoffTimeStatsMap map[string]TaskTimeStats
	TotBackoffTimes     map[string]int
}

CopTasksDetails collects some useful information of cop-tasks during execution.

func (*CopTasksDetails) ToZapFields 

func (d *CopTasksDetails) ToZapFields() (fields []zap.Field)

ToZapFields wraps the CopTasksDetails as zap.Fileds.

type CopTasksSummary 

type CopTasksSummary struct {
	NumCopTasks       int
	MaxProcessAddress string
	MaxProcessTime    time.Duration
	TotProcessTime    time.Duration
	MaxWaitAddress    string
	MaxWaitTime       time.Duration
	TotWaitTime       time.Duration
}

CopTasksSummary collects some summary information of cop-tasks for statement summary.

type Duration 

type Duration time.Duration

Duration is a wrapper of time.Duration to implement the canGetFloat64 interface.

func (Duration) GetFloat64 

func (d Duration) GetFloat64() float64

GetFloat64 implements the canGetFloat64 interface.

type DurationWithAddr 

type DurationWithAddr struct {
	D    time.Duration
	Addr string
}

DurationWithAddr is a wrapper of time.Duration and string to implement the canGetFloat64 interface.

func (DurationWithAddr) GetFloat64 

func (d DurationWithAddr) GetFloat64() float64

GetFloat64 implements the canGetFloat64 interface.

type ExecDetails 

type ExecDetails struct {
	CopExecDetails
	CommitDetail         *util.CommitDetails
	LockKeysDetail       *util.LockKeysDetails
	SharedLockKeysDetail *util.LockKeysDetails
	CopTime              time.Duration
	LockKeysDuration     time.Duration
	RequestCount         int
}

ExecDetails contains execution detail information.

func (ExecDetails) String 

func (d ExecDetails) String() string

String implements the fmt.Stringer interface.

func (ExecDetails) ToZapFields 

func (d ExecDetails) ToZapFields() (fields []zap.Field)

ToZapFields wraps the ExecDetails as zap.Fields.

type Int64 

type Int64 int64

Int64 is a wrapper of int64 to implement the canGetFloat64 interface.

func (Int64) GetFloat64 

func (i Int64) GetFloat64() float64

GetFloat64 implements the canGetFloat64 interface.

type P90BackoffSummary 

type P90BackoffSummary struct {
	ReqTimes          int
	BackoffPercentile Percentile[DurationWithAddr]
	TotBackoffTime    time.Duration
	TotBackoffTimes   int
}

P90BackoffSummary contains execution summary for a backoff type.

type P90Summary 

type P90Summary struct {
	NumCopTasks int

	ProcessTimePercentile Percentile[DurationWithAddr]
	WaitTimePercentile    Percentile[DurationWithAddr]

	BackoffInfo map[string]*P90BackoffSummary
}

P90Summary contains execution summary for cop tasks.

func (*P90Summary) Merge 

func (d *P90Summary) Merge(backoffSleep map[string]time.Duration, backoffTimes map[string]int, calleeAddress string, timeDetail util.TimeDetail)

Merge merges DetailsNeedP90 into P90Summary.

func (*P90Summary) Reset 

func (d *P90Summary) Reset()

Reset resets all fields in DetailsNeedP90Summary.

type Percentile 

type Percentile[valueType canGetFloat64] struct {
	// contains filtered or unexported fields
}

Percentile is a struct to calculate the percentile of a series of values.

func (*Percentile[valueType]) Add 

func (p *Percentile[valueType]) Add(value valueType)

Add adds a value to calculate the percentile.

func (*Percentile[valueType]) GetMax 

func (p *Percentile[valueType]) GetMax() valueType

GetMax returns the max value.

func (*Percentile[valueType]) GetMin 

func (p *Percentile[valueType]) GetMin() valueType

GetMin returns the min value.

func (*Percentile[valueType]) GetPercentile 

func (p *Percentile[valueType]) GetPercentile(f float64) float64

GetPercentile returns the percentile `f` of the values.

func (*Percentile[valueType]) MergePercentile 

func (p *Percentile[valueType]) MergePercentile(p2 *Percentile[valueType])

MergePercentile merges two Percentile.

func (*Percentile[valueType]) Size 

func (p *Percentile[valueType]) Size() int

Size returns the size of the values.

func (*Percentile[valueType]) Sum 

func (p *Percentile[valueType]) Sum() float64

Sum returns the sum of the values.

type RURuntimeStats 

type RURuntimeStats struct {
	*util.RUDetails
	Metrics   *RUV2Metrics
	Weights   RUV2Weights
	RUVersion rmclient.RUVersion
}

RURuntimeStats wraps RU details and statement-level RU v2 metrics for EXPLAIN output. RUVersion controls which RU accounting version produces output:

  • 1 (v1): shows RRU + WRU
  • 2 (v2): shows total RU from v2 metrics
  • 0 / unknown: defaults to v1

func (*RURuntimeStats) Clone 

func (e *RURuntimeStats) Clone() RuntimeStats

Clone implements the RuntimeStats interface.

func (*RURuntimeStats) Merge 

func (e *RURuntimeStats) Merge(other RuntimeStats)

Merge implements the RuntimeStats interface.

func (*RURuntimeStats) String 

func (e *RURuntimeStats) String() string

String implements the RuntimeStats interface.

func (*RURuntimeStats) Tp 

func (*RURuntimeStats) Tp() int

Tp implements the RuntimeStats interface.

type RUV2Metrics 

type RUV2Metrics struct {
	// contains filtered or unexported fields
}

RUV2Metrics stores statement-level RUv2 metrics.

func NewRUV2Metrics 

func NewRUV2Metrics() *RUV2Metrics

NewRUV2Metrics creates a new RUv2 metrics container.

func RUV2MetricsFromContext 

func RUV2MetricsFromContext(ctx context.Context) *RUV2Metrics

RUV2MetricsFromContext returns the RUv2 metrics stored in ctx.

func (*RUV2Metrics) AddExecutorL5InsertRows 

func (m *RUV2Metrics) AddExecutorL5InsertRows(delta int64)

AddExecutorL5InsertRows records affected insert rows for RUv2 accounting.

func (*RUV2Metrics) AddExecutorMetric 

func (m *RUV2Metrics) AddExecutorMetric(level int, label string, delta int64)

AddExecutorMetric records a statement-level executor metric for the given RUv2 level.

func (*RUV2Metrics) AddPlanCnt 

func (m *RUV2Metrics) AddPlanCnt(delta int64)

AddPlanCnt records plan builder invocations for the current statement.

func (*RUV2Metrics) AddPlanDeriveStatsPaths 

func (m *RUV2Metrics) AddPlanDeriveStatsPaths(delta int64)

AddPlanDeriveStatsPaths records derived stats paths for the current statement.

func (*RUV2Metrics) AddResourceManagerReadCnt 

func (m *RUV2Metrics) AddResourceManagerReadCnt(delta int64)

AddResourceManagerReadCnt records TiKV read RPCs charged to resource management.

func (*RUV2Metrics) AddResourceManagerWriteCnt 

func (m *RUV2Metrics) AddResourceManagerWriteCnt(delta int64)

AddResourceManagerWriteCnt records TiKV write RPCs charged to resource management.

func (*RUV2Metrics) AddResultChunkCells 

func (m *RUV2Metrics) AddResultChunkCells(delta int64)

AddResultChunkCells records result cells written by the current statement.

func (*RUV2Metrics) AddSessionParserTotal 

func (m *RUV2Metrics) AddSessionParserTotal(delta int64)

AddSessionParserTotal records parser executions for the current statement.

func (*RUV2Metrics) AddTiKVCoprocessorExecutorIterations 

func (m *RUV2Metrics) AddTiKVCoprocessorExecutorIterations(delta int64)

AddTiKVCoprocessorExecutorIterations records TiKV coprocessor iteration counters.

func (*RUV2Metrics) AddTiKVCoprocessorResponseBytes 

func (m *RUV2Metrics) AddTiKVCoprocessorResponseBytes(delta int64)

AddTiKVCoprocessorResponseBytes records TiKV coprocessor response bytes.

func (*RUV2Metrics) AddTiKVCoprocessorWorkTotal 

func (m *RUV2Metrics) AddTiKVCoprocessorWorkTotal(label string, delta int64)

AddTiKVCoprocessorWorkTotal records TiKV executor input counters by executor type.

func (*RUV2Metrics) AddTiKVKVEngineCacheMiss 

func (m *RUV2Metrics) AddTiKVKVEngineCacheMiss(delta int64)

AddTiKVKVEngineCacheMiss records TiKV kv_engine_cache_miss counters from ExecDetailsV2.

func (*RUV2Metrics) AddTiKVRaftstoreStoreWriteTriggerWB 

func (m *RUV2Metrics) AddTiKVRaftstoreStoreWriteTriggerWB(delta int64)

AddTiKVRaftstoreStoreWriteTriggerWB records TiKV raftstore write trigger bytes.

func (*RUV2Metrics) AddTiKVStorageProcessedKeysBatchGet 

func (m *RUV2Metrics) AddTiKVStorageProcessedKeysBatchGet(delta int64)

AddTiKVStorageProcessedKeysBatchGet records TiKV batch-get processed keys.

func (*RUV2Metrics) AddTiKVStorageProcessedKeysGet 

func (m *RUV2Metrics) AddTiKVStorageProcessedKeysGet(delta int64)

AddTiKVStorageProcessedKeysGet records TiKV get processed keys.

func (*RUV2Metrics) AddTxnCnt 

func (m *RUV2Metrics) AddTxnCnt(delta int64)

AddTxnCnt records transaction completions attributed to the current statement.

func (*RUV2Metrics) CalculateRUValues 

func (m *RUV2Metrics) CalculateRUValues(weights RUV2Weights) (tidbRU float64)

CalculateRUValues calculates the current TiDB RU from the metrics using the provided weights. The weights specify how each component is weighted in the RU calculation. Returns the calculated TiDB RU as a float64.

func (*RUV2Metrics) Clone 

func (m *RUV2Metrics) Clone() *RUV2Metrics

Clone returns a copy of the current metrics for reporting.

func (*RUV2Metrics) ExecutorL5InsertRows 

func (m *RUV2Metrics) ExecutorL5InsertRows() int64

ExecutorL5InsertRows returns affected insert rows for RUv2 accounting.

func (*RUV2Metrics) IsZero 

func (m *RUV2Metrics) IsZero() bool

IsZero checks whether all metrics are zero.

func (*RUV2Metrics) Merge 

func (m *RUV2Metrics) Merge(other *RUV2Metrics)

Merge merges another metrics container into the receiver.

func (*RUV2Metrics) PlanCnt 

func (m *RUV2Metrics) PlanCnt() int64

PlanCnt returns plan builder invocations for the current statement.

func (*RUV2Metrics) PlanDeriveStatsPaths 

func (m *RUV2Metrics) PlanDeriveStatsPaths() int64

PlanDeriveStatsPaths returns derived stats paths for the current statement.

func (*RUV2Metrics) ResourceManagerReadCnt 

func (m *RUV2Metrics) ResourceManagerReadCnt() int64

ResourceManagerReadCnt returns TiKV read RPCs charged to resource management.

func (*RUV2Metrics) ResourceManagerWriteCnt 

func (m *RUV2Metrics) ResourceManagerWriteCnt() int64

ResourceManagerWriteCnt returns TiKV write RPCs charged to resource management.

func (*RUV2Metrics) ResultChunkCells 

func (m *RUV2Metrics) ResultChunkCells() int64

ResultChunkCells returns result cells written by the current statement.

func (*RUV2Metrics) SessionParserTotal 

func (m *RUV2Metrics) SessionParserTotal() int64

SessionParserTotal returns parser executions for the current statement.

func (*RUV2Metrics) TiKVCoprocessorExecutorIterations 

func (m *RUV2Metrics) TiKVCoprocessorExecutorIterations() int64

TiKVCoprocessorExecutorIterations returns TiKV coprocessor iteration counters.

func (*RUV2Metrics) TiKVCoprocessorResponseBytes 

func (m *RUV2Metrics) TiKVCoprocessorResponseBytes() int64

TiKVCoprocessorResponseBytes returns TiKV coprocessor response bytes.

func (*RUV2Metrics) TiKVKVEngineCacheMiss 

func (m *RUV2Metrics) TiKVKVEngineCacheMiss() int64

TiKVKVEngineCacheMiss returns TiKV kv_engine_cache_miss counters from ExecDetailsV2.

func (*RUV2Metrics) TiKVRaftstoreStoreWriteTriggerWB 

func (m *RUV2Metrics) TiKVRaftstoreStoreWriteTriggerWB() int64

TiKVRaftstoreStoreWriteTriggerWB returns TiKV raftstore write trigger bytes.

func (*RUV2Metrics) TiKVStorageProcessedKeysBatchGet 

func (m *RUV2Metrics) TiKVStorageProcessedKeysBatchGet() int64

TiKVStorageProcessedKeysBatchGet returns TiKV batch-get processed keys.

func (*RUV2Metrics) TiKVStorageProcessedKeysGet 

func (m *RUV2Metrics) TiKVStorageProcessedKeysGet() int64

TiKVStorageProcessedKeysGet returns TiKV get processed keys.

func (*RUV2Metrics) TotalRU 

func (m *RUV2Metrics) TotalRU(weights RUV2Weights, tiKVRU, tiFlashRU float64) float64

TotalRU returns the statement RU v2 total as TiDB + TiKV + TiFlash.

func (*RUV2Metrics) TxnCnt 

func (m *RUV2Metrics) TxnCnt() int64

TxnCnt returns transaction completions attributed to the current statement.

type RUV2Weights 

type RUV2Weights struct {
	RUScale float64

	ResultChunkCells        float64
	ExecutorL1              float64
	ExecutorL2              float64
	ExecutorL3              float64
	ExecutorL5InsertRows    float64
	PlanCnt                 float64
	PlanDeriveStatsPaths    float64
	ResourceManagerReadCnt  float64
	ResourceManagerWriteCnt float64
	SessionParserTotal      float64
	TxnCnt                  float64
}

RUV2Weights contains the TiDB-side RU v2 weights needed to calculate scaled statement RU values.

type RootRuntimeStats 

type RootRuntimeStats struct {
	// contains filtered or unexported fields
}

RootRuntimeStats is the executor runtime stats that combine with multiple runtime stats.

func NewRootRuntimeStats 

func NewRootRuntimeStats() *RootRuntimeStats

NewRootRuntimeStats returns a new RootRuntimeStats

func (*RootRuntimeStats) GetActRows 

func (e *RootRuntimeStats) GetActRows() int64

GetActRows return total rows of RootRuntimeStats.

func (*RootRuntimeStats) MergeStats 

func (e *RootRuntimeStats) MergeStats() (basic *BasicRuntimeStats, groups []RuntimeStats)

MergeStats merges stats in the RootRuntimeStats and return the stats suitable for display directly.

func (*RootRuntimeStats) String 

func (e *RootRuntimeStats) String() string

String implements the RuntimeStats interface.

type RuntimeStats 

type RuntimeStats interface {
	String() string
	Merge(RuntimeStats)
	Clone() RuntimeStats
	Tp() int
}

RuntimeStats is used to express the executor runtime information.

type RuntimeStatsColl 

type RuntimeStatsColl struct {
	// contains filtered or unexported fields
}

RuntimeStatsColl collects executors's execution info.

func NewRuntimeStatsColl 

func NewRuntimeStatsColl(reuse *RuntimeStatsColl) *RuntimeStatsColl

NewRuntimeStatsColl creates new executor collector. Reuse the object to reduce allocation when *RuntimeStatsColl is not nil.

func (*RuntimeStatsColl) ExistsCopStats 

func (e *RuntimeStatsColl) ExistsCopStats(planID int) bool

ExistsCopStats checks if the planID exists in the copStats collection.

func (*RuntimeStatsColl) ExistsRootStats 

func (e *RuntimeStatsColl) ExistsRootStats(planID int) bool

ExistsRootStats checks if the planID exists in the rootStats collection.

func (*RuntimeStatsColl) GetBasicRuntimeStats 

func (e *RuntimeStatsColl) GetBasicRuntimeStats(planID int, initNewExecutorStats bool) *BasicRuntimeStats

GetBasicRuntimeStats gets basicRuntimeStats for a executor When rootStat/rootStat's basicRuntimeStats is nil, the behavior is decided by initNewExecutorStats argument: 1. If true, it created a new one, and increase basicRuntimeStats' executorCount 2. Else, it returns nil

func (*RuntimeStatsColl) GetCopCountAndRows 

func (e *RuntimeStatsColl) GetCopCountAndRows(planID int) (int32, int64)

GetCopCountAndRows returns the total cop-tasks count and total rows of all cop-tasks.

func (*RuntimeStatsColl) GetCopStats 

func (e *RuntimeStatsColl) GetCopStats(planID int) *CopRuntimeStats

GetCopStats gets the CopRuntimeStats specified by planID.

func (*RuntimeStatsColl) GetPlanActRows 

func (e *RuntimeStatsColl) GetPlanActRows(planID int) int64

GetPlanActRows returns the actual rows of the plan.

func (*RuntimeStatsColl) GetRootStats 

func (e *RuntimeStatsColl) GetRootStats(planID int) *RootRuntimeStats

GetRootStats gets execStat for a executor.

func (*RuntimeStatsColl) GetStmtCopRuntimeStats 

func (e *RuntimeStatsColl) GetStmtCopRuntimeStats() StmtCopRuntimeStats

GetStmtCopRuntimeStats gets execStat for a executor.

func (*RuntimeStatsColl) RecordCopStats 

func (e *RuntimeStatsColl) RecordCopStats(planID int, storeType kv.StoreType, scan *util.ScanDetail, time util.TimeDetail, summary *tipb.ExecutorExecutionSummary) int

RecordCopStats records a specific cop tasks's execution detail.

func (*RuntimeStatsColl) RecordOneCopTask 

func (e *RuntimeStatsColl) RecordOneCopTask(planID int, storeType kv.StoreType, summary *tipb.ExecutorExecutionSummary) int

RecordOneCopTask records a specific cop tasks's execution summary.

func (*RuntimeStatsColl) RegisterStats 

func (e *RuntimeStatsColl) RegisterStats(planID int, info RuntimeStats)

RegisterStats register execStat for a executor.

type RuntimeStatsWithCommit 

type RuntimeStatsWithCommit struct {
	Commit         *util.CommitDetails
	LockKeys       *util.LockKeysDetails
	SharedLockKeys *util.LockKeysDetails
	TxnCnt         int
}

RuntimeStatsWithCommit is the RuntimeStats with commit detail.

func (*RuntimeStatsWithCommit) Clone 

func (e *RuntimeStatsWithCommit) Clone() RuntimeStats

Clone implements the RuntimeStats interface.

func (*RuntimeStatsWithCommit) Merge 

func (e *RuntimeStatsWithCommit) Merge(rs RuntimeStats)

Merge implements the RuntimeStats interface.

func (*RuntimeStatsWithCommit) MergeCommitDetails 

func (e *RuntimeStatsWithCommit) MergeCommitDetails(detail *util.CommitDetails)

MergeCommitDetails merges the commit details.

func (*RuntimeStatsWithCommit) String 

func (e *RuntimeStatsWithCommit) String() string

String implements the RuntimeStats interface.

func (*RuntimeStatsWithCommit) Tp 

func (*RuntimeStatsWithCommit) Tp() int

Tp implements the RuntimeStats interface.

type RuntimeStatsWithConcurrencyInfo 

type RuntimeStatsWithConcurrencyInfo struct {

	// protect concurrency
	sync.Mutex
	// contains filtered or unexported fields
}

RuntimeStatsWithConcurrencyInfo is the BasicRuntimeStats with ConcurrencyInfo.

func (*RuntimeStatsWithConcurrencyInfo) Clone 

func (e *RuntimeStatsWithConcurrencyInfo) Clone() RuntimeStats

Clone implements the RuntimeStats interface.

func (*RuntimeStatsWithConcurrencyInfo) Merge 

func (*RuntimeStatsWithConcurrencyInfo) Merge(RuntimeStats)

Merge implements the RuntimeStats interface.

func (*RuntimeStatsWithConcurrencyInfo) SetConcurrencyInfo 

func (e *RuntimeStatsWithConcurrencyInfo) SetConcurrencyInfo(infos ...*ConcurrencyInfo)

SetConcurrencyInfo sets the concurrency informations. We must clear the concurrencyInfo first when we call the SetConcurrencyInfo. When the num <= 0, it means the exector operator is not executed parallel.

func (*RuntimeStatsWithConcurrencyInfo) String 

func (e *RuntimeStatsWithConcurrencyInfo) String() string

String implements the RuntimeStats interface.

func (*RuntimeStatsWithConcurrencyInfo) Tp 

func (*RuntimeStatsWithConcurrencyInfo) Tp() int

Tp implements the RuntimeStats interface.

type StmtCopRuntimeStats 

type StmtCopRuntimeStats struct {
	// TiflashNetworkStats stats all mpp tasks' network traffic info, nil if no any mpp tasks' network traffic
	TiflashNetworkStats *TiFlashNetworkTrafficSummary
}

StmtCopRuntimeStats stores the cop runtime stats of the total statement

type StmtExecDetails 

type StmtExecDetails struct {
	WriteSQLRespDuration time.Duration
}

StmtExecDetails contains stmt level execution detail info.

func GetExecDetailsFromContext 

func GetExecDetailsFromContext(ctx context.Context) (stmtDetail StmtExecDetails, tikvExecDetail util.ExecDetails, ruDetails *util.RUDetails)

GetExecDetailsFromContext gets stmt execution, execution and resource usage details from context.

type SyncExecDetails 

type SyncExecDetails struct {
	// contains filtered or unexported fields
}

SyncExecDetails is a synced version of `ExecDetails` and its `P90Summary`

func (*SyncExecDetails) CopTasksDetails 

func (s *SyncExecDetails) CopTasksDetails() *CopTasksDetails

CopTasksDetails returns some useful information of cop-tasks during execution.

func (*SyncExecDetails) CopTasksSummary 

func (s *SyncExecDetails) CopTasksSummary() *CopTasksSummary

CopTasksSummary returns some summary information of cop-tasks for statement summary.

func (*SyncExecDetails) GetExecDetails 

func (s *SyncExecDetails) GetExecDetails() ExecDetails

GetExecDetails returns the exec details inside. It's actually not safe, because the `ExecDetails` still contains some reference, which is not protected after returning outside.

func (*SyncExecDetails) MergeCopExecDetails 

func (s *SyncExecDetails) MergeCopExecDetails(details *CopExecDetails, copTime time.Duration)

MergeCopExecDetails merges a CopExecDetails into self.

func (*SyncExecDetails) MergeExecDetails 

func (s *SyncExecDetails) MergeExecDetails(commitDetails *util.CommitDetails)

MergeExecDetails merges a single region execution details into self, used to print the information in slow query log.

func (*SyncExecDetails) MergeLockKeysExecDetails 

func (s *SyncExecDetails) MergeLockKeysExecDetails(lockKeys *util.LockKeysDetails)

MergeLockKeysExecDetails merges lock keys execution details into self.

func (*SyncExecDetails) MergeSharedLockKeysExecDetails 

func (s *SyncExecDetails) MergeSharedLockKeysExecDetails(lockKeys *util.LockKeysDetails)

MergeSharedLockKeysExecDetails merges shared lock keys execution details into self.

func (*SyncExecDetails) Reset 

func (s *SyncExecDetails) Reset()

Reset resets the content inside

type TaskTimeStats 

type TaskTimeStats struct {
	AvgTime    time.Duration
	P90Time    time.Duration
	MaxAddress string
	MaxTime    time.Duration
	TotTime    time.Duration
}

TaskTimeStats is used for recording time-related statistical metrics, including dimensions such as average values, percentile values, maximum values, etc. It is suitable for scenarios involving latency statistics, wait time analysis, and similar use cases.

func (TaskTimeStats) FormatFloatFields 

func (s TaskTimeStats) FormatFloatFields() (avgStr, p90Str, maxStr string)

FormatFloatFields returns the AvgTime, P90Time and MaxTime in float format.

func (TaskTimeStats) String 

func (s TaskTimeStats) String(numCopTasks int, spaceMarkStr, avgStr, p90Str, maxStr, addrStr string) string

String returns the TaskTimeStats fields as a string.

type TiFlashNetworkTrafficSummary 

type TiFlashNetworkTrafficSummary struct {
	// contains filtered or unexported fields
}

TiFlashNetworkTrafficSummary is used to express network traffic in tiflash

func (*TiFlashNetworkTrafficSummary) Clone 

func (networkTraffic *TiFlashNetworkTrafficSummary) Clone() TiFlashNetworkTrafficSummary

Clone implements the deep copy of * TiFlashNetworkTrafficSummary

func (*TiFlashNetworkTrafficSummary) Empty 

func (networkTraffic *TiFlashNetworkTrafficSummary) Empty() bool

Empty check whether TiFlashNetworkTrafficSummary is Empty, if no any network traffic, we regard it as empty

func (*TiFlashNetworkTrafficSummary) GetInterZoneTrafficBytes 

func (networkTraffic *TiFlashNetworkTrafficSummary) GetInterZoneTrafficBytes() uint64

GetInterZoneTrafficBytes returns the inter zone network traffic bytes involved between tiflash instances.

func (*TiFlashNetworkTrafficSummary) Merge 

func (networkTraffic *TiFlashNetworkTrafficSummary) Merge(other TiFlashNetworkTrafficSummary)

Merge make sum to merge the information in TiFlashNetworkTrafficSummary

func (*TiFlashNetworkTrafficSummary) String 

func (networkTraffic *TiFlashNetworkTrafficSummary) String() string

String dumps TiFlashNetworkTrafficSummary info as string

func (*TiFlashNetworkTrafficSummary) UpdateTiKVExecDetails 

func (networkTraffic *TiFlashNetworkTrafficSummary) UpdateTiKVExecDetails(tikvDetails *util.ExecDetails)

UpdateTiKVExecDetails update tikvDetails with TiFlashNetworkTrafficSummary's values

type TiFlashScanContext 

type TiFlashScanContext struct {
	// contains filtered or unexported fields
}

TiFlashScanContext is used to express the table scan information in tiflash

func (*TiFlashScanContext) Clone 

func (context *TiFlashScanContext) Clone() TiFlashScanContext

Clone implements the deep copy of * TiFlashshScanContext

func (*TiFlashScanContext) Empty 

func (context *TiFlashScanContext) Empty() bool

Empty check whether TiFlashScanContext is Empty, if scan no pack and skip no pack, we regard it as empty

func (*TiFlashScanContext) Merge 

func (context *TiFlashScanContext) Merge(other TiFlashScanContext)

Merge make sum to merge the information in TiFlashScanContext

func (*TiFlashScanContext) String 

func (context *TiFlashScanContext) String() string

type TiFlashWaitSummary 

type TiFlashWaitSummary struct {
	// contains filtered or unexported fields
}

TiFlashWaitSummary is used to express all kinds of wait information in tiflash

func (*TiFlashWaitSummary) CanBeIgnored 

func (waitSummary *TiFlashWaitSummary) CanBeIgnored() bool

CanBeIgnored check whether TiFlashWaitSummary can be ignored, not all tidb executors have significant tiflash wait summary

func (*TiFlashWaitSummary) Clone 

func (waitSummary *TiFlashWaitSummary) Clone() TiFlashWaitSummary

Clone implements the deep copy of * TiFlashWaitSummary

func (*TiFlashWaitSummary) Merge 

func (waitSummary *TiFlashWaitSummary) Merge(other TiFlashWaitSummary)

Merge make sum to merge the information in TiFlashWaitSummary

func (*TiFlashWaitSummary) String 

func (waitSummary *TiFlashWaitSummary) String() string

String dumps TiFlashWaitSummary info as string

type TiflashStats 

type TiflashStats struct {
	// contains filtered or unexported fields
}

TiflashStats contains tiflash execution stats.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.