Skip to content

client/resource_group: add client-side demand observability #10604

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
okJiang wants to merge 6 commits into
base: master
Choose a base branch
from
Open

client/resource_group: add client-side demand observability #10604

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
645236a
client/resource_group: add client-side demand observability
okJiang Apr 20, 2026
cede109
client/resource_group: fix static lint
okJiang Apr 21, 2026
ff892b9
client/resource_group: guard demand stats
okJiang Jun 4, 2026
369e6aa
client/resource_group: fix rebased test call
okJiang Jul 10, 2026
b8a835c
client/resource_group: remove successful token wait logs
lhy1024 Jul 13, 2026
916fcba
client/resource_group: preserve successful wait metric semantics
lhy1024 Jul 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions client/go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ require (
github.com/cespare/xxhash/v2 v2.3.0 // indirect
github.com/davecgh/go-spew v1.1.1 // indirect
github.com/golang/protobuf v1.5.4 // indirect
github.com/kylelemons/godebug v1.1.0 // indirect
Comment thread
coderabbitai[bot] marked this conversation as resolved.
github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
github.com/pkg/errors v0.9.1 // indirect
github.com/pmezard/go-difflib v1.0.0 // indirect
Expand Down
2 changes: 2 additions & 0 deletions client/go.sum
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@ github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3x
github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE=
github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
github.com/kylelemons/godebug v1.1.0 h1:RPNrshWIDI6G2gRW9EHilWtl7Z6Sb1BR0xunSBf0SNc=
github.com/kylelemons/godebug v1.1.0/go.mod h1:9/0rRGxNHcop5bhtWyNeEfOS8JIWk580+fNqagV/RAw=
github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 h1:C3w9PqII01/Oq1c1nUAm88MOHcQC9l5mIlSMApZMrHA=
github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822/go.mod h1:+n7T8mK8HuQTcFwEeznm/DIxMOiR9yIdICNftLE1DvQ=
github.com/nxadm/tail v1.4.8 h1:nPr65rt6Y5JFSKQO7qToXr7pePgD6Gwiw05lkbyAQTE=
Expand Down
31 changes: 27 additions & 4 deletions client/resource_group/controller/global_controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -435,7 +435,7 @@ func (c *ResourceGroupsController) Start(ctx context.Context) {
continue
}
// If the resource group is marked as tombstone before, re-create the resource group controller.
newGC, err := newGroupCostController(group, c.ruConfig, c.lowTokenNotifyChan, c.tokenBucketUpdateChan)
newGC, err := newGroupCostController(group, c.clientUniqueID, c.ruConfig, c.lowTokenNotifyChan, c.tokenBucketUpdateChan)
if err != nil {
log.Warn("[resource group controller] re-create resource group cost controller for tombstone failed",
zap.String("name", name), zap.Error(err))
Expand Down Expand Up @@ -574,7 +574,7 @@ func (c *ResourceGroupsController) tryGetResourceGroupController(
return gc, nil
}
// Initialize the resource group controller.
gc, err = newGroupCostController(group, c.ruConfig, c.lowTokenNotifyChan, c.tokenBucketUpdateChan)
gc, err = newGroupCostController(group, c.clientUniqueID, c.ruConfig, c.lowTokenNotifyChan, c.tokenBucketUpdateChan)
if err != nil {
return nil, err
}
Expand Down Expand Up @@ -610,7 +610,7 @@ func (c *ResourceGroupsController) tombstoneGroupCostController(name string) {
return
}
// Create a default resource group controller for the tombstone resource group independently.
gc, err := newGroupCostController(defaultGC.getMeta(), c.ruConfig, c.lowTokenNotifyChan, c.tokenBucketUpdateChan)
gc, err := newGroupCostController(defaultGC.getMeta(), c.clientUniqueID, c.ruConfig, c.lowTokenNotifyChan, c.tokenBucketUpdateChan)
if err != nil {
log.Warn("[resource group controller] create default resource group cost controller for tombstone failed",
zap.String("name", name), zap.Error(err))
Expand Down Expand Up @@ -639,6 +639,19 @@ func (c *ResourceGroupsController) cleanUpResourceGroup() {
c.groupsController.Delete(resourceGroupName)
metrics.ResourceGroupStatusGauge.DeleteLabelValues(resourceGroupName, resourceGroupName)
gc.metrics.deletePagingLabels(resourceGroupName)
metrics.TokenConsumedHistogram.DeleteLabelValues(resourceGroupName)
metrics.TokenConsumedByTypeCounter.DeleteLabelValues(resourceGroupName, "rru")
metrics.TokenConsumedByTypeCounter.DeleteLabelValues(resourceGroupName, "wru")
metrics.TokenBalanceGauge.DeleteLabelValues(resourceGroupName)
metrics.FillRateGauge.DeleteLabelValues(resourceGroupName)
metrics.BurstLimitGauge.DeleteLabelValues(resourceGroupName)
metrics.AvgRUPerSecGauge.DeleteLabelValues(resourceGroupName)
metrics.DemandRUPerSecGauge.DeleteLabelValues(resourceGroupName)
metrics.ThrottledGauge.DeleteLabelValues(resourceGroupName)
metrics.ReadByteCost.DeleteLabelValues(resourceGroupName)
metrics.WriteByteCost.DeleteLabelValues(resourceGroupName)
metrics.KVCPUCost.DeleteLabelValues(resourceGroupName)
metrics.SQLCPUCost.DeleteLabelValues(resourceGroupName)
return true
}
gc.inactive = true
Expand Down Expand Up @@ -723,7 +736,17 @@ func (c *ResourceGroupsController) sendTokenBucketRequests(ctx context.Context,
metrics.SuccessfulTokenRequestDuration.Observe(latency.Seconds())
}
if !notifyMsg.startTime.IsZero() && time.Since(notifyMsg.startTime) > slowNotifyFilterDuration {
log.Warn("[resource group controller] slow token bucket request", zap.String("source", source), zap.Duration("cost", time.Since(notifyMsg.startTime)))
groupNames := make([]string, 0, len(req.Requests))
for _, request := range req.Requests {
groupNames = append(groupNames, request.GetResourceGroupName())
}
log.Warn(
"[resource group controller] slow token bucket request",
zap.String("source", source),
zap.Duration("cost", time.Since(notifyMsg.startTime)),
zap.Uint64("client_unique_id", c.clientUniqueID),
zap.Strings("resource_groups", groupNames),
)
}
logControllerTrace("[resource group controller] token bucket response", zap.Time("now", time.Now()), zap.Any("resp", resp), zap.String("source", source), zap.Duration("latency", latency))
c.tokenResponseChan <- resp
Expand Down
61 changes: 60 additions & 1 deletion client/resource_group/controller/global_controller_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ import (
"github.com/tikv/pd/client/errs"
"github.com/tikv/pd/client/opt"
"github.com/tikv/pd/client/pkg/utils/testutil"
"github.com/tikv/pd/client/resource_group/controller/metrics"
)

func TestMain(m *testing.M) {
Expand Down Expand Up @@ -304,6 +305,64 @@ func TestTryGetController(t *testing.T) {
re.NotEmpty(consumption)
}

func TestCleanupResourceGroupMetrics(t *testing.T) {
re := require.New(t)
ctx, cancel := context.WithCancel(context.Background())
defer cancel()

mockProvider := newMockResourceGroupProvider()
controller, err := NewResourceGroupController(ctx, 1, mockProvider, nil, constants.NullKeyspaceID)
re.NoError(err)

testResourceGroup := &rmpb.ResourceGroup{
Name: "cleanup-group",
Mode: rmpb.GroupMode_RUMode,
RUSettings: &rmpb.GroupRequestUnitSettings{
RU: &rmpb.TokenBucket{
Settings: &rmpb.TokenLimitSettings{FillRate: 1000},
},
},
}
mockProvider.On("GetResourceGroup", mock.Anything, "cleanup-group", mock.Anything).Return(testResourceGroup, nil)

gc, err := controller.tryGetResourceGroupController(ctx, "cleanup-group", false)
re.NoError(err)
re.NotNil(gc)

metrics.ResourceGroupStatusGauge.WithLabelValues("cleanup-group", "cleanup-group").Set(1)
metrics.TokenConsumedHistogram.WithLabelValues("cleanup-group").Observe(1)
metrics.TokenConsumedByTypeCounter.WithLabelValues("cleanup-group", "rru").Add(1)
metrics.TokenConsumedByTypeCounter.WithLabelValues("cleanup-group", "wru").Add(1)
metrics.TokenBalanceGauge.WithLabelValues("cleanup-group").Set(1)
metrics.FillRateGauge.WithLabelValues("cleanup-group").Set(1)
metrics.BurstLimitGauge.WithLabelValues("cleanup-group").Set(1)
metrics.AvgRUPerSecGauge.WithLabelValues("cleanup-group").Set(1)
metrics.DemandRUPerSecGauge.WithLabelValues("cleanup-group").Set(1)
metrics.ThrottledGauge.WithLabelValues("cleanup-group").Set(1)
metrics.ReadByteCost.WithLabelValues("cleanup-group").Add(1)
metrics.WriteByteCost.WithLabelValues("cleanup-group").Add(1)
metrics.KVCPUCost.WithLabelValues("cleanup-group").Add(1)
metrics.SQLCPUCost.WithLabelValues("cleanup-group").Add(1)

gc.inactive = true
controller.cleanUpResourceGroup()

re.False(metrics.ResourceGroupStatusGauge.DeleteLabelValues("cleanup-group", "cleanup-group"))
re.False(metrics.TokenConsumedHistogram.DeleteLabelValues("cleanup-group"))
re.False(metrics.TokenConsumedByTypeCounter.DeleteLabelValues("cleanup-group", "rru"))
re.False(metrics.TokenConsumedByTypeCounter.DeleteLabelValues("cleanup-group", "wru"))
re.False(metrics.TokenBalanceGauge.DeleteLabelValues("cleanup-group"))
re.False(metrics.FillRateGauge.DeleteLabelValues("cleanup-group"))
re.False(metrics.BurstLimitGauge.DeleteLabelValues("cleanup-group"))
re.False(metrics.AvgRUPerSecGauge.DeleteLabelValues("cleanup-group"))
re.False(metrics.DemandRUPerSecGauge.DeleteLabelValues("cleanup-group"))
re.False(metrics.ThrottledGauge.DeleteLabelValues("cleanup-group"))
re.False(metrics.ReadByteCost.DeleteLabelValues("cleanup-group"))
re.False(metrics.WriteByteCost.DeleteLabelValues("cleanup-group"))
re.False(metrics.KVCPUCost.DeleteLabelValues("cleanup-group"))
re.False(metrics.SQLCPUCost.DeleteLabelValues("cleanup-group"))
}

func TestGetResourceGroup(t *testing.T) {
re := require.New(t)
ctx, cancel := context.WithCancel(context.Background())
Expand Down Expand Up @@ -436,7 +495,7 @@ func TestGetResourceGroupRuntimeState(t *testing.T) {
},
},
}
gc, err := newGroupCostController(group, DefaultRUConfig(), make(chan notifyMsg), make(chan *groupCostController))
gc, err := newGroupCostController(group, 1001, DefaultRUConfig(), make(chan notifyMsg), make(chan *groupCostController))
re.NoError(err)

controller := &ResourceGroupsController{}
Expand Down
Loading
Loading