-
Notifications
You must be signed in to change notification settings - Fork 720
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
*: add region heartbeat duration breakdown metrics
Signed-off-by: nolouch <[email protected]>
- Loading branch information
Showing
11 changed files
with
445 additions
and
82 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,245 @@ | ||
// Copyright 2024 TiKV Project Authors. | ||
// | ||
// Licensed under the Apache License, Version 2.0 (the "License"); | ||
// you may not use this file except in compliance with the License. | ||
// You may obtain a copy of the License at | ||
// | ||
// http://www.apache.org/licenses/LICENSE-2.0 | ||
// | ||
// Unless required by applicable law or agreed to in writing, software | ||
// distributed under the License is distributed on an "AS IS" BASIS, | ||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
// See the License for the specific language governing permissions and | ||
// limitations under the License. | ||
|
||
package core | ||
|
||
import ( | ||
"time" | ||
|
||
"github.com/prometheus/client_golang/prometheus" | ||
"go.uber.org/zap" | ||
) | ||
|
||
var ( | ||
// HeartbeatBreakdownHandleDurationSum is the summary of the processing time of handle the heartbeat stage. | ||
HeartbeatBreakdownHandleDurationSum = prometheus.NewCounterVec( | ||
prometheus.CounterOpts{ | ||
Namespace: "pd", | ||
Subsystem: "core", | ||
Name: "heartbeat_breakdown_handle_duration_seconds_sum", | ||
Help: "Bucketed histogram of processing time (s) of handle the heartbeat stage.", | ||
}, []string{"name"}) | ||
|
||
// HeartbeatBreakdownHandleCount is the summary of the processing count of handle the heartbeat stage. | ||
HeartbeatBreakdownHandleCount = prometheus.NewCounterVec( | ||
prometheus.CounterOpts{ | ||
Namespace: "pd", | ||
Subsystem: "core", | ||
Name: "heartbeat_breakdown_handle_duration_seconds_count", | ||
Help: "Bucketed histogram of processing count of handle the heartbeat stage.", | ||
}, []string{"name"}) | ||
// AcquireRegionsLockWaitDurationSum is the summary of the processing time of waiting for acquiring regions lock. | ||
AcquireRegionsLockWaitDurationSum = prometheus.NewCounterVec( | ||
prometheus.CounterOpts{ | ||
Namespace: "pd", | ||
Subsystem: "core", | ||
Name: "acquire_regions_lock_wait_duration_seconds_sum", | ||
Help: "Bucketed histogram of processing time (s) of waiting for acquiring regions lock.", | ||
}, []string{"type"}) | ||
// AcquireRegionsLockWaitCount is the summary of the processing count of waiting for acquiring regions lock. | ||
AcquireRegionsLockWaitCount = prometheus.NewCounterVec( | ||
prometheus.CounterOpts{ | ||
Namespace: "pd", | ||
Subsystem: "core", | ||
Name: "acquire_regions_lock_wait_duration_seconds_count", | ||
Help: "Bucketed histogram of processing count of waiting for acquiring regions lock.", | ||
}, []string{"name"}) | ||
|
||
// lock statistics | ||
waitRegionsLockDurationSum = AcquireRegionsLockWaitDurationSum.WithLabelValues("WaitRegionsLock") | ||
waitRegionsLockCount = AcquireRegionsLockWaitCount.WithLabelValues("WaitRegionsLock") | ||
waitSubRegionsLockDurationSum = AcquireRegionsLockWaitDurationSum.WithLabelValues("WaitSubRegionsLock") | ||
waitSubRegionsLockCount = AcquireRegionsLockWaitCount.WithLabelValues("WaitSubRegionsLock") | ||
|
||
// heartbeat breakdown statistics | ||
preCheckDurationSum = HeartbeatBreakdownHandleDurationSum.WithLabelValues("PreCheck") | ||
preCheckCount = HeartbeatBreakdownHandleCount.WithLabelValues("PreCheck") | ||
asyncHotStatsDurationSum = HeartbeatBreakdownHandleDurationSum.WithLabelValues("AsyncHotStatsDuration") | ||
asyncHotStatsCount = HeartbeatBreakdownHandleCount.WithLabelValues("AsyncHotStatsDuration") | ||
regionGuideDurationSum = HeartbeatBreakdownHandleDurationSum.WithLabelValues("RegionGuide") | ||
regionGuideCount = HeartbeatBreakdownHandleCount.WithLabelValues("RegionGuide") | ||
checkOverlapsDurationSum = HeartbeatBreakdownHandleDurationSum.WithLabelValues("SaveCache_CheckOverlaps") | ||
checkOverlapsCount = HeartbeatBreakdownHandleCount.WithLabelValues("SaveCache_CheckOverlaps") | ||
validateRegionDurationSum = HeartbeatBreakdownHandleDurationSum.WithLabelValues("SaveCache_InvalidRegion") | ||
validateRegionCount = HeartbeatBreakdownHandleCount.WithLabelValues("SaveCache_InvalidRegion") | ||
setRegionDurationSum = HeartbeatBreakdownHandleDurationSum.WithLabelValues("SaveCache_SetRegion") | ||
setRegionCount = HeartbeatBreakdownHandleCount.WithLabelValues("SaveCache_SetRegion") | ||
updateSubTreeDurationSum = HeartbeatBreakdownHandleDurationSum.WithLabelValues("SaveCache_UpdateSubTree") | ||
updateSubTreeCount = HeartbeatBreakdownHandleCount.WithLabelValues("SaveCache_UpdateSubTree") | ||
otherDurationSum = HeartbeatBreakdownHandleDurationSum.WithLabelValues("Other") | ||
otherCount = HeartbeatBreakdownHandleCount.WithLabelValues("Other") | ||
) | ||
|
||
func init() { | ||
prometheus.MustRegister(HeartbeatBreakdownHandleDurationSum) | ||
prometheus.MustRegister(HeartbeatBreakdownHandleCount) | ||
prometheus.MustRegister(AcquireRegionsLockWaitDurationSum) | ||
prometheus.MustRegister(AcquireRegionsLockWaitCount) | ||
} | ||
|
||
type saveCacheStats struct { | ||
startTime time.Time | ||
lastCheckTime time.Time | ||
checkOverlapsDuration time.Duration | ||
validateRegionDuration time.Duration | ||
setRegionDuration time.Duration | ||
updateSubTreeDuration time.Duration | ||
} | ||
|
||
// RegionHeartbeatProcessTracer is used to trace the process of handling region heartbeat. | ||
type RegionHeartbeatProcessTracer interface { | ||
Begin() | ||
OnPreCheckFinished() | ||
OnAsyncHotStatsFinished() | ||
OnRegionGuideFinished() | ||
OnSaveCacheBegin() | ||
OnSaveCacheFinished() | ||
OnCheckOverlapsFinished() | ||
OnValidateRegionFinished() | ||
OnSetRegionFinished() | ||
OnUpdateSubTreeFinished() | ||
OnAllStageFinished() | ||
LogFields() []zap.Field | ||
} | ||
|
||
type noopHeartbeatProcessTracer struct{} | ||
|
||
// NewNoopHeartbeatProcessTracer returns a noop heartbeat process tracer. | ||
func NewNoopHeartbeatProcessTracer() RegionHeartbeatProcessTracer { | ||
return &noopHeartbeatProcessTracer{} | ||
} | ||
|
||
func (n *noopHeartbeatProcessTracer) Begin() {} | ||
func (n *noopHeartbeatProcessTracer) OnPreCheckFinished() {} | ||
func (n *noopHeartbeatProcessTracer) OnAsyncHotStatsFinished() {} | ||
func (n *noopHeartbeatProcessTracer) OnRegionGuideFinished() {} | ||
func (n *noopHeartbeatProcessTracer) OnSaveCacheBegin() {} | ||
func (n *noopHeartbeatProcessTracer) OnSaveCacheFinished() {} | ||
func (n *noopHeartbeatProcessTracer) OnCheckOverlapsFinished() {} | ||
func (n *noopHeartbeatProcessTracer) OnValidateRegionFinished() {} | ||
func (n *noopHeartbeatProcessTracer) OnSetRegionFinished() {} | ||
func (n *noopHeartbeatProcessTracer) OnUpdateSubTreeFinished() {} | ||
func (n *noopHeartbeatProcessTracer) OnAllStageFinished() {} | ||
func (n *noopHeartbeatProcessTracer) LogFields() []zap.Field { | ||
return nil | ||
} | ||
|
||
type regionHeartbeatProcessTracer struct { | ||
startTime time.Time | ||
lastCheckTime time.Time | ||
preCheckDuration time.Duration | ||
asyncHotStatsDuration time.Duration | ||
regionGuideDuration time.Duration | ||
saveCacheStats saveCacheStats | ||
OtherDuration time.Duration | ||
} | ||
|
||
// NewHeartbeatProcessTracer returns a heartbeat process tracer. | ||
func NewHeartbeatProcessTracer() RegionHeartbeatProcessTracer { | ||
return ®ionHeartbeatProcessTracer{} | ||
} | ||
|
||
func (h *regionHeartbeatProcessTracer) Begin() { | ||
now := time.Now() | ||
h.startTime = now | ||
h.lastCheckTime = now | ||
} | ||
|
||
func (h *regionHeartbeatProcessTracer) OnPreCheckFinished() { | ||
now := time.Now() | ||
h.preCheckDuration = now.Sub(h.lastCheckTime) | ||
h.lastCheckTime = now | ||
preCheckDurationSum.Add(h.preCheckDuration.Seconds()) | ||
preCheckCount.Inc() | ||
} | ||
|
||
func (h *regionHeartbeatProcessTracer) OnAsyncHotStatsFinished() { | ||
now := time.Now() | ||
h.asyncHotStatsDuration = now.Sub(h.lastCheckTime) | ||
h.lastCheckTime = now | ||
asyncHotStatsDurationSum.Add(h.preCheckDuration.Seconds()) | ||
asyncHotStatsCount.Inc() | ||
} | ||
|
||
func (h *regionHeartbeatProcessTracer) OnRegionGuideFinished() { | ||
now := time.Now() | ||
h.regionGuideDuration = now.Sub(h.lastCheckTime) | ||
h.lastCheckTime = now | ||
regionGuideDurationSum.Add(h.regionGuideDuration.Seconds()) | ||
regionGuideCount.Inc() | ||
} | ||
|
||
func (h *regionHeartbeatProcessTracer) OnSaveCacheBegin() { | ||
now := time.Now() | ||
h.saveCacheStats.startTime = now | ||
h.saveCacheStats.lastCheckTime = now | ||
h.lastCheckTime = now | ||
} | ||
|
||
func (h *regionHeartbeatProcessTracer) OnSaveCacheFinished() { | ||
// update the outer checkpoint time | ||
h.lastCheckTime = time.Now() | ||
} | ||
|
||
func (h *regionHeartbeatProcessTracer) OnCheckOverlapsFinished() { | ||
now := time.Now() | ||
h.saveCacheStats.checkOverlapsDuration = now.Sub(h.lastCheckTime) | ||
h.saveCacheStats.lastCheckTime = now | ||
checkOverlapsDurationSum.Add(h.saveCacheStats.checkOverlapsDuration.Seconds()) | ||
checkOverlapsCount.Inc() | ||
} | ||
|
||
func (h *regionHeartbeatProcessTracer) OnValidateRegionFinished() { | ||
now := time.Now() | ||
h.saveCacheStats.validateRegionDuration = now.Sub(h.saveCacheStats.lastCheckTime) | ||
h.saveCacheStats.lastCheckTime = now | ||
validateRegionDurationSum.Add(h.saveCacheStats.validateRegionDuration.Seconds()) | ||
validateRegionCount.Inc() | ||
} | ||
|
||
func (h *regionHeartbeatProcessTracer) OnSetRegionFinished() { | ||
now := time.Now() | ||
h.saveCacheStats.setRegionDuration = now.Sub(h.saveCacheStats.lastCheckTime) | ||
h.saveCacheStats.lastCheckTime = now | ||
setRegionDurationSum.Add(h.saveCacheStats.setRegionDuration.Seconds()) | ||
setRegionCount.Inc() | ||
} | ||
|
||
func (h *regionHeartbeatProcessTracer) OnUpdateSubTreeFinished() { | ||
now := time.Now() | ||
h.saveCacheStats.updateSubTreeDuration = now.Sub(h.saveCacheStats.lastCheckTime) | ||
h.saveCacheStats.lastCheckTime = now | ||
updateSubTreeDurationSum.Add(h.saveCacheStats.updateSubTreeDuration.Seconds()) | ||
updateSubTreeCount.Inc() | ||
} | ||
|
||
func (h *regionHeartbeatProcessTracer) OnAllStageFinished() { | ||
now := time.Now() | ||
h.OtherDuration = now.Sub(h.lastCheckTime) | ||
otherDurationSum.Add(h.OtherDuration.Seconds()) | ||
otherCount.Inc() | ||
} | ||
|
||
func (h *regionHeartbeatProcessTracer) LogFields() []zap.Field { | ||
return []zap.Field{ | ||
zap.Duration("pre-check-duration", h.preCheckDuration), | ||
zap.Duration("async-hot-stats-duration", h.asyncHotStatsDuration), | ||
zap.Duration("region-guide-duration", h.regionGuideDuration), | ||
zap.Duration("check-overlaps-duration", h.saveCacheStats.checkOverlapsDuration), | ||
zap.Duration("validate-region-duration", h.saveCacheStats.validateRegionDuration), | ||
zap.Duration("set-region-duration", h.saveCacheStats.setRegionDuration), | ||
zap.Duration("update-sub-tree-duration", h.saveCacheStats.updateSubTreeDuration), | ||
zap.Duration("other-duration", h.OtherDuration), | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.