zhijiangW commented on a change in pull request #8455: [FLINK-12284,FLINK-12637][Network,Metrics]Fix the incorrect inputBufferUsage metric in credit-based network mode URL: https://github.com/apache/flink/pull/8455#discussion_r297496220
########## File path: flink-runtime/src/test/java/org/apache/flink/runtime/io/network/partition/consumer/InputBuffersMetricsTest.java ########## @@ -0,0 +1,203 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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 org.apache.flink.runtime.io.network.partition.consumer; + +import org.apache.flink.api.java.tuple.Tuple3; +import org.apache.flink.core.fs.CloseableRegistry; +import org.apache.flink.runtime.io.network.NettyShuffleEnvironment; +import org.apache.flink.runtime.io.network.NettyShuffleEnvironmentBuilder; +import org.apache.flink.runtime.io.network.TestingConnectionManager; +import org.apache.flink.runtime.io.network.buffer.Buffer; +import org.apache.flink.runtime.io.network.metrics.CreditBasedInputBuffersUsageGauge; +import org.apache.flink.runtime.io.network.metrics.ExclusiveBuffersUsageGauge; +import org.apache.flink.runtime.io.network.metrics.FloatingBuffersUsageGauge; +import org.apache.flink.runtime.io.network.partition.ResultPartitionID; +import org.apache.flink.runtime.io.network.partition.ResultPartitionType; +import org.apache.flink.util.TestLogger; + +import org.junit.Test; + +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +import static org.junit.Assert.assertEquals; + +/** + * Tests the metrics for input buffers usage. + */ +public class InputBuffersMetricsTest extends TestLogger { + + @Test + public void testBufferUsageMetrics() throws IOException, InterruptedException { + + int numberOfRemoteChannelsGate1 = 2; + int numberOfLocalChannelsGate1 = 0; + int numberOfRemoteChannelsGate2 = 1; + int numberOfLocalChannelsGate2 = 1; + + int numberOfRemoteChannelsTotal = numberOfRemoteChannelsGate1 + numberOfRemoteChannelsGate2; + int numberOfInputGates = 2; + + int buffersPerChannel = 2; + int extraNetworkBuffersPerGate = 8; + + final CloseableRegistry closeableRegistry = new CloseableRegistry(); + + final NettyShuffleEnvironment network = new NettyShuffleEnvironmentBuilder() + .setNetworkBuffersPerChannel(buffersPerChannel) + .setFloatingNetworkBuffersPerGate(extraNetworkBuffersPerGate) + .build(); + + final Tuple3<SingleInputGate, List<RemoteInputChannel>, List<LocalInputChannel>> tuple1 = buildInputGate(network, + numberOfRemoteChannelsGate1, + numberOfLocalChannelsGate1); + final Tuple3<SingleInputGate, List<RemoteInputChannel>, List<LocalInputChannel>> tuple2 = buildInputGate(network, + numberOfRemoteChannelsGate2, + numberOfLocalChannelsGate2); + + final SingleInputGate inputGate1 = tuple1.f0; + final SingleInputGate inputGate2 = tuple2.f0; + + try { + + assertEquals(tuple1.f1.size(), numberOfRemoteChannelsGate1 + numberOfLocalChannelsGate1); + RemoteInputChannel remoteInputChannel1 = tuple1.f1.get(0); + RemoteInputChannel remoteInputChannel2 = tuple1.f1.get(1); + + SingleInputGate[] inputGates = new SingleInputGate[]{tuple1.f0, tuple2.f0}; + FloatingBuffersUsageGauge floatingBuffersUsageGauge = new FloatingBuffersUsageGauge(inputGates); + ExclusiveBuffersUsageGauge exclusiveBuffersUsageGauge = new ExclusiveBuffersUsageGauge(inputGates); + CreditBasedInputBuffersUsageGauge inputBufferPoolUsageGauge = new CreditBasedInputBuffersUsageGauge(floatingBuffersUsageGauge, + exclusiveBuffersUsageGauge, inputGates); + + assertEquals(0.0, floatingBuffersUsageGauge.getValue(), 0.0); + assertEquals(0.0, exclusiveBuffersUsageGauge.getValue(), 0.0); + assertEquals(0.0, inputBufferPoolUsageGauge.getValue(), 0.0); + + assertEquals(buffersPerChannel * numberOfRemoteChannelsGate1, exclusiveBuffersUsageGauge.calculateTotalBuffers(inputGate1)); + assertEquals(extraNetworkBuffersPerGate, floatingBuffersUsageGauge.calculateTotalBuffers(inputGate1)); + + assertEquals(buffersPerChannel * numberOfRemoteChannelsGate2, exclusiveBuffersUsageGauge.calculateTotalBuffers(inputGate2)); + assertEquals(extraNetworkBuffersPerGate, floatingBuffersUsageGauge.calculateTotalBuffers(inputGate2)); + + // test for exclusive buffer used + drainBuffer(buffersPerChannel, remoteInputChannel1, closeableRegistry); + + int totalBuffers = extraNetworkBuffersPerGate * numberOfInputGates + buffersPerChannel * numberOfRemoteChannelsTotal; + + assertEquals(buffersPerChannel, exclusiveBuffersUsageGauge.calculateUsedBuffers(inputGate1)); + assertEquals((double) buffersPerChannel / (buffersPerChannel * numberOfRemoteChannelsTotal), exclusiveBuffersUsageGauge.getValue(), 0.0001); + assertEquals((double) buffersPerChannel / totalBuffers, inputBufferPoolUsageGauge.getValue(), 0.0001); + + drainBuffer(buffersPerChannel, remoteInputChannel2, closeableRegistry); + + assertEquals(buffersPerChannel * numberOfRemoteChannelsGate1, exclusiveBuffersUsageGauge.calculateUsedBuffers(inputGate1)); + assertEquals((double) buffersPerChannel * numberOfRemoteChannelsGate1 / (buffersPerChannel * numberOfRemoteChannelsTotal), + exclusiveBuffersUsageGauge.getValue(), 0.0001); + assertEquals((double) buffersPerChannel * numberOfRemoteChannelsGate1 / totalBuffers, + inputBufferPoolUsageGauge.getValue(), 0.0001); + + // test for floating buffer used + remoteInputChannel1.requestSubpartition(0); + + int backlog = 3; + int requestFloatingTotal = buffersPerChannel + backlog; + + remoteInputChannel1.onSenderBacklog(backlog); + + assertEquals(requestFloatingTotal, remoteInputChannel1.unsynchronizedGetFloatingBuffersAvailable()); + + drainBuffer(requestFloatingTotal, remoteInputChannel1, closeableRegistry); + + assertEquals(0, remoteInputChannel1.unsynchronizedGetFloatingBuffersAvailable()); + assertEquals(buffersPerChannel * numberOfRemoteChannelsGate1, exclusiveBuffersUsageGauge.calculateUsedBuffers(inputGate1)); + assertEquals((double) buffersPerChannel * numberOfRemoteChannelsGate1 / (buffersPerChannel * numberOfRemoteChannelsTotal), + exclusiveBuffersUsageGauge.getValue(), 0.0001); + assertEquals((double) (buffersPerChannel * numberOfRemoteChannelsGate1 + requestFloatingTotal) / totalBuffers, + inputBufferPoolUsageGauge.getValue(), 0.0001); + } finally { + inputGate1.close(); + inputGate2.close(); + closeableRegistry.close(); + network.close(); + } + } + + private void drainBuffer(int boundary, RemoteInputChannel channel, CloseableRegistry closeableRegistry) throws IOException { + for (int i = 0; i < boundary; i++) { + Buffer buffer = channel.requestBuffer(); + if (buffer != null) { + closeableRegistry.registerCloseable(buffer::recycleBuffer); + } else { + break; + } + } + } + + private RemoteInputChannel buildRemoteChannel(int channelIndex, Review comment: formatting: make every parameter in separate line and with a tab indentation. ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
