Skip to content
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.

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

xds: add LRS named metrics support #7027

Merged
merged 1 commit into from
Mar 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
19 changes: 17 additions & 2 deletions xds/internal/balancer/clusterimpl/balancer_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@ import (
"google.golang.org/grpc/xds/internal/xdsclient"
"google.golang.org/grpc/xds/internal/xdsclient/bootstrap"
"google.golang.org/grpc/xds/internal/xdsclient/load"

v3orcapb "github.com/cncf/xds/go/xds/data/orca/v3"
)

const (
Expand All @@ -51,6 +53,9 @@ const (

testClusterName = "test-cluster"
testServiceName = "test-eds-service"

testNamedMetricsKey1 = "test-named1"
testNamedMetricsKey2 = "test-named2"
)

var (
Expand All @@ -68,6 +73,7 @@ var (
cmpopts.EquateEmpty(),
cmpopts.IgnoreFields(load.Data{}, "ReportInterval"),
}
toleranceCmpOpt = cmpopts.EquateApprox(0, 1e-5)
)

type s struct {
Expand Down Expand Up @@ -629,7 +635,10 @@ func (s) TestLoadReporting(t *testing.T) {
if gotSCSt.SubConn != sc1 {
return fmt.Errorf("picker.Pick, got %v, %v, want SubConn=%v", gotSCSt, err, sc1)
}
gotSCSt.Done(balancer.DoneInfo{})
lr := &v3orcapb.OrcaLoadReport{
NamedMetrics: map[string]float64{testNamedMetricsKey1: 3.14, testNamedMetricsKey2: 2.718},
}
gotSCSt.Done(balancer.DoneInfo{ServerLoad: lr})
}
for i := 0; i < errorCount; i++ {
gotSCSt, err := p.Pick(balancer.PickInfo{})
Expand Down Expand Up @@ -671,7 +680,13 @@ func (s) TestLoadReporting(t *testing.T) {
if reqStats.InProgress != 0 {
t.Errorf("got inProgress %v, want %v", reqStats.InProgress, 0)
}

wantLoadStats := map[string]load.ServerLoadData{
testNamedMetricsKey1: {Count: 5, Sum: 15.7}, // aggregation of 5 * 3.14 = 15.7
testNamedMetricsKey2: {Count: 5, Sum: 13.59}, // aggregation of 5 * 2.718 = 13.59
}
if diff := cmp.Diff(wantLoadStats, localityData.LoadStats, toleranceCmpOpt); diff != "" {
t.Errorf("localityData.LoadStats returned unexpected diff (-want +got):\n%s", diff)
}
b.Close()
if err := xdsC.WaitForCancelReportLoad(ctx); err != nil {
t.Fatalf("unexpected error waiting form load report to be canceled: %v", err)
Expand Down
12 changes: 1 addition & 11 deletions xds/internal/balancer/clusterimpl/picker.go
Original file line number Diff line number Diff line change
Expand Up @@ -68,11 +68,6 @@ func (d *dropper) drop() (ret bool) {
return d.w.Next().(bool)
}

const (
serverLoadCPUName = "cpu_utilization"
serverLoadMemoryName = "mem_utilization"
)

// loadReporter wraps the methods from the loadStore that are used here.
type loadReporter interface {
CallStarted(locality string)
Expand Down Expand Up @@ -163,12 +158,7 @@ func (d *picker) Pick(info balancer.PickInfo) (balancer.PickResult, error) {
if !ok || load == nil {
return
}
d.loadStore.CallServerLoad(lIDStr, serverLoadCPUName, load.CpuUtilization)
d.loadStore.CallServerLoad(lIDStr, serverLoadMemoryName, load.MemUtilization)
for n, c := range load.RequestCost {
d.loadStore.CallServerLoad(lIDStr, n, c)
}
for n, c := range load.Utilization {
for n, c := range load.NamedMetrics {
d.loadStore.CallServerLoad(lIDStr, n, c)
}
}
Expand Down
41 changes: 40 additions & 1 deletion xds/internal/xdsclient/transport/loadreport_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ import (

v3corepb "github.com/envoyproxy/go-control-plane/envoy/config/core/v3"
"github.com/google/go-cmp/cmp"
"github.com/google/go-cmp/cmp/cmpopts"
"github.com/google/uuid"
"google.golang.org/grpc/internal/testutils/xds/fakeserver"
"google.golang.org/grpc/xds/internal/testutils"
Expand All @@ -35,6 +36,22 @@ import (
v3lrspb "github.com/envoyproxy/go-control-plane/envoy/service/load_stats/v3"
)

const (
testLocality1 = `{"region":"test-region1"}`
testLocality2 = `{"region":"test-region2"}`
testKey1 = "test-key1"
testKey2 = "test-key2"
)

var (
toleranceCmpOpt = cmpopts.EquateApprox(0, 1e-5)
ignoreOrderCmpOpt = protocmp.FilterField(&v3endpointpb.ClusterStats{}, "upstream_locality_stats",
cmpopts.SortSlices(func(a, b protocmp.Message) bool {
return a.String() < b.String()
}),
)
)

func (s) TestReportLoad(t *testing.T) {
// Create a fake xDS management server listening on a local port.
mgmtServer, cleanup := startFakeManagementServer(t)
Expand Down Expand Up @@ -74,6 +91,13 @@ func (s) TestReportLoad(t *testing.T) {

// Push some loads on the received store.
store1.PerCluster("cluster1", "eds1").CallDropped("test")
store1.PerCluster("cluster1", "eds1").CallStarted(testLocality1)
store1.PerCluster("cluster1", "eds1").CallServerLoad(testLocality1, testKey1, 3.14)
store1.PerCluster("cluster1", "eds1").CallServerLoad(testLocality1, testKey1, 2.718)
store1.PerCluster("cluster1", "eds1").CallFinished(testLocality1, nil)
store1.PerCluster("cluster1", "eds1").CallStarted(testLocality2)
store1.PerCluster("cluster1", "eds1").CallServerLoad(testLocality2, testKey2, 1.618)
store1.PerCluster("cluster1", "eds1").CallFinished(testLocality2, nil)

// Ensure the initial request is received.
req, err := mgmtServer.LRSRequestChan.Receive(ctx)
Expand Down Expand Up @@ -115,8 +139,23 @@ func (s) TestReportLoad(t *testing.T) {
ClusterServiceName: "eds1",
TotalDroppedRequests: 1,
DroppedRequests: []*v3endpointpb.ClusterStats_DroppedRequests{{Category: "test", DroppedCount: 1}},
UpstreamLocalityStats: []*v3endpointpb.UpstreamLocalityStats{
{
Locality: &v3corepb.Locality{Region: "test-region1"},
LoadMetricStats: []*v3endpointpb.EndpointLoadMetricStats{
// TotalMetricValue is the aggregation of 3.14 + 2.718 = 5.858
{MetricName: testKey1, NumRequestsFinishedWithMetric: 2, TotalMetricValue: 5.858}},
TotalSuccessfulRequests: 1,
},
{
Locality: &v3corepb.Locality{Region: "test-region2"},
LoadMetricStats: []*v3endpointpb.EndpointLoadMetricStats{
{MetricName: testKey2, NumRequestsFinishedWithMetric: 1, TotalMetricValue: 1.618}},
TotalSuccessfulRequests: 1,
},
},
}
if diff := cmp.Diff(wantLoad, gotLoad[0], protocmp.Transform()); diff != "" {
if diff := cmp.Diff(wantLoad, gotLoad[0], protocmp.Transform(), toleranceCmpOpt, ignoreOrderCmpOpt); diff != "" {
t.Fatalf("Unexpected diff in LRS request (-got, +want):\n%s", diff)
}

Expand Down
Loading