xds: include the target label to WRR metrics (#11141)

temawi · web-flow · commit 35a171bc1d54 · 2024-05-01T15:20:38.000-07:00
diff --git a/xds/src/main/java/io/grpc/xds/WeightedRoundRobinLoadBalancer.java b/xds/src/main/java/io/grpc/xds/WeightedRoundRobinLoadBalancer.java
@@ -430,31 +430,33 @@ private void updateWeight() {
       for (int i = 0; i < children.size(); i++) {
         double newWeight = ((WeightedChildLbState) children.get(i)).getWeight(staleEndpoints,
             notYetUsableEndpoints);
-        // TODO: add target and locality labels once available
+        // TODO: add locality label once available
         helper.getMetricRecorder()
-            .recordDoubleHistogram(ENDPOINT_WEIGHTS_HISTOGRAM, newWeight, ImmutableList.of(""),
+            .recordDoubleHistogram(ENDPOINT_WEIGHTS_HISTOGRAM, newWeight,
+                ImmutableList.of(helper.getChannelTarget()),
                 ImmutableList.of(""));
         newWeights[i] = newWeight > 0 ? (float) newWeight : 0.0f;
       }
       if (staleEndpoints.get() > 0) {
-        // TODO: add target and locality labels once available
+        // TODO: add locality label once available
         helper.getMetricRecorder()
             .addLongCounter(ENDPOINT_WEIGHT_STALE_COUNTER, staleEndpoints.get(),
-                ImmutableList.of(""),
+                ImmutableList.of(helper.getChannelTarget()),
                 ImmutableList.of(""));
       }
       if (notYetUsableEndpoints.get() > 0) {
-        // TODO: add target and locality labels once available
+        // TODO: add locality label once available
         helper.getMetricRecorder()
             .addLongCounter(ENDPOINT_WEIGHT_NOT_YET_USEABLE_COUNTER, notYetUsableEndpoints.get(),
-                ImmutableList.of(""), ImmutableList.of(""));
+                ImmutableList.of(helper.getChannelTarget()), ImmutableList.of(""));
       }
 
       this.scheduler = new StaticStrideScheduler(newWeights, sequence);
       if (this.scheduler.usesRoundRobin()) {
-        // TODO: add target and locality labels once available
+        // TODO: locality label once available
         helper.getMetricRecorder()
-            .addLongCounter(RR_FALLBACK_COUNTER, 1, ImmutableList.of(""), ImmutableList.of(""));
+            .addLongCounter(RR_FALLBACK_COUNTER, 1, ImmutableList.of(helper.getChannelTarget()),
+                ImmutableList.of(""));
       }
     }
 
diff --git a/xds/src/test/java/io/grpc/xds/WeightedRoundRobinLoadBalancerTest.java b/xds/src/test/java/io/grpc/xds/WeightedRoundRobinLoadBalancerTest.java
@@ -144,6 +144,8 @@ public void uncaughtException(Thread t, Throwable e) {
           }
       });
 
+  private String channelTarget = "channel-target";
+
   public WeightedRoundRobinLoadBalancerTest() {
     testHelperInstance = new TestHelper();
     helper = mock(Helper.class, delegatesTo(testHelperInstance));
@@ -1238,7 +1240,7 @@ private void verifyLongCounterRecord(String name, int times, long value) {
           public boolean matches(LongCounterMetricInstrument longCounterInstrument) {
             return longCounterInstrument.getName().equals(name);
           }
-        }), eq(value), eq(Lists.newArrayList("")), eq(Lists.newArrayList("")));
+        }), eq(value), eq(Lists.newArrayList(channelTarget)), eq(Lists.newArrayList("")));
   }
 
   // Verifies that the MetricRecorder has been called to record a given double histogram value the
@@ -1250,7 +1252,7 @@ private void verifyDoubleHistogramRecord(String name, int times, double value) {
           public boolean matches(DoubleHistogramMetricInstrument doubleHistogramInstrument) {
             return doubleHistogramInstrument.getName().equals(name);
           }
-        }), eq(value), eq(Lists.newArrayList("")), eq(Lists.newArrayList("")));
+        }), eq(value), eq(Lists.newArrayList(channelTarget)), eq(Lists.newArrayList("")));
   }
 
   private int getNumFilteredPendingTasks() {
@@ -1326,5 +1328,10 @@ public Map<Subchannel, SubchannelStateListener> getSubchannelStateListeners() {
     public MetricRecorder getMetricRecorder() {
       return mockMetricRecorder;
     }
+
+    @Override
+    public String getChannelTarget() {
+      return channelTarget;
+    }
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -144,6 +144,8 @@ public void uncaughtException(Thread t, Throwable e) {`
`144`	`144`	`}`
`145`	`145`	`});`
`146`	`146`
	`147`	`+ private String channelTarget = "channel-target";`
	`148`	`+`
`147`	`149`	`public WeightedRoundRobinLoadBalancerTest() {`
`148`	`150`	`testHelperInstance = new TestHelper();`
`149`	`151`	`helper = mock(Helper.class, delegatesTo(testHelperInstance));`
`@@ -1238,7 +1240,7 @@ private void verifyLongCounterRecord(String name, int times, long value) {`
`1238`	`1240`	`public boolean matches(LongCounterMetricInstrument longCounterInstrument) {`
`1239`	`1241`	`return longCounterInstrument.getName().equals(name);`
`1240`	`1242`	`}`
`1241`		`- }), eq(value), eq(Lists.newArrayList("")), eq(Lists.newArrayList("")));`
	`1243`	`+ }), eq(value), eq(Lists.newArrayList(channelTarget)), eq(Lists.newArrayList("")));`
`1242`	`1244`	`}`
`1243`	`1245`
`1244`	`1246`	`// Verifies that the MetricRecorder has been called to record a given double histogram value the`
`@@ -1250,7 +1252,7 @@ private void verifyDoubleHistogramRecord(String name, int times, double value) {`
`1250`	`1252`	`public boolean matches(DoubleHistogramMetricInstrument doubleHistogramInstrument) {`
`1251`	`1253`	`return doubleHistogramInstrument.getName().equals(name);`
`1252`	`1254`	`}`
`1253`		`- }), eq(value), eq(Lists.newArrayList("")), eq(Lists.newArrayList("")));`
	`1255`	`+ }), eq(value), eq(Lists.newArrayList(channelTarget)), eq(Lists.newArrayList("")));`
`1254`	`1256`	`}`
`1255`	`1257`
`1256`	`1258`	`private int getNumFilteredPendingTasks() {`
`@@ -1326,5 +1328,10 @@ public Map<Subchannel, SubchannelStateListener> getSubchannelStateListeners() {`
`1326`	`1328`	`public MetricRecorder getMetricRecorder() {`
`1327`	`1329`	`return mockMetricRecorder;`
`1328`	`1330`	`}`
	`1331`	`+`
	`1332`	`+ @Override`
	`1333`	`+ public String getChannelTarget() {`
	`1334`	`+ return channelTarget;`
	`1335`	`+ }`
`1329`	`1336`	`}`
`1330`	`1337`	`}`