Skip to content

[FLINK-38695][table-runtime] Fix wrong metric about left cache request count in DeltaJoinCache #27252

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
wants to merge 2 commits into
base: master
Choose a base branch
from
+166 −8
Open

[FLINK-38695][table-runtime] Fix wrong metric about left cache request count in DeltaJoinCache #27252

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c6b9ab9
[FLINK-38695][table-runtime] Fix wrong metric about left cache reques…
xuyangzhong Nov 19, 2025
c4cc379
add more tests
xuyangzhong Nov 20, 2025
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
17 changes: 9 additions & 8 deletions ...src/main/java/org/apache/flink/table/runtime/operators/join/deltajoin/DeltaJoinCache.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,16 +41,17 @@
* <p>Note: This cache is not thread-safe although its inner {@link Cache} is thread-safe.
*/
@NotThreadSafe
@VisibleForTesting
public class DeltaJoinCache {

private static final String LEFT_CACHE_METRIC_PREFIX = "deltaJoin.leftCache.";
private static final String RIGHT_CACHE_METRIC_PREFIX = "deltaJoin.rightCache.";
protected static final String LEFT_CACHE_METRIC_PREFIX = "deltaJoin.leftCache.";
protected static final String RIGHT_CACHE_METRIC_PREFIX = "deltaJoin.rightCache.";

private static final String METRIC_HIT_RATE = "hitRate";
private static final String METRIC_REQUEST_COUNT = "requestCount";
private static final String METRIC_HIT_COUNT = "hitCount";
private static final String METRIC_KEY_SIZE = "keySize";
private static final String METRIC_TOTAL_NON_EMPTY_VALUE_SIZE = "totalNonEmptyValues";
protected static final String METRIC_HIT_RATE = "hitRate";
protected static final String METRIC_REQUEST_COUNT = "requestCount";
protected static final String METRIC_HIT_COUNT = "hitCount";
protected static final String METRIC_KEY_SIZE = "keySize";
protected static final String METRIC_TOTAL_NON_EMPTY_VALUE_SIZE = "totalNonEmptyValues";

// use LinkedHashMap to keep order
private final Cache<RowData, LinkedHashMap<RowData, Object>> leftCache;
Expand Down Expand Up @@ -87,7 +88,7 @@ public void registerMetrics(MetricGroup metricGroup) {
: Long.valueOf(leftHitCount.get()).doubleValue()
/ leftRequestCount.get());
metricGroup.<Long, Gauge<Long>>gauge(
LEFT_CACHE_METRIC_PREFIX + METRIC_REQUEST_COUNT, rightRequestCount::get);
LEFT_CACHE_METRIC_PREFIX + METRIC_REQUEST_COUNT, leftRequestCount::get);
metricGroup.<Long, Gauge<Long>>gauge(
LEFT_CACHE_METRIC_PREFIX + METRIC_HIT_COUNT, leftHitCount::get);
metricGroup.<Long, Gauge<Long>>gauge(
Expand Down
157 changes: 157 additions & 0 deletions ...test/java/org/apache/flink/table/runtime/operators/join/deltajoin/DeltaJoinCacheTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,157 @@
/*
* 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.table.runtime.operators.join.deltajoin;

import org.apache.flink.metrics.Gauge;
import org.apache.flink.metrics.Metric;
import org.apache.flink.runtime.metrics.groups.UnregisteredMetricGroups;
import org.apache.flink.table.data.RowData;
import org.apache.flink.testutils.junit.extensions.parameterized.Parameter;
import org.apache.flink.testutils.junit.extensions.parameterized.ParameterizedTestExtension;
import org.apache.flink.testutils.junit.extensions.parameterized.Parameters;
import org.apache.flink.util.function.TriConsumer;

import org.apache.flink.shaded.guava33.com.google.common.collect.Maps;

import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.TestTemplate;
import org.junit.jupiter.api.extension.ExtendWith;

import java.util.Arrays;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.function.BiConsumer;

import static org.apache.flink.table.runtime.operators.join.deltajoin.DeltaJoinCache.LEFT_CACHE_METRIC_PREFIX;
import static org.apache.flink.table.runtime.operators.join.deltajoin.DeltaJoinCache.METRIC_HIT_COUNT;
import static org.apache.flink.table.runtime.operators.join.deltajoin.DeltaJoinCache.METRIC_HIT_RATE;
import static org.apache.flink.table.runtime.operators.join.deltajoin.DeltaJoinCache.METRIC_KEY_SIZE;
import static org.apache.flink.table.runtime.operators.join.deltajoin.DeltaJoinCache.METRIC_REQUEST_COUNT;
import static org.apache.flink.table.runtime.operators.join.deltajoin.DeltaJoinCache.METRIC_TOTAL_NON_EMPTY_VALUE_SIZE;
import static org.apache.flink.table.runtime.operators.join.deltajoin.DeltaJoinCache.RIGHT_CACHE_METRIC_PREFIX;
import static org.apache.flink.table.runtime.util.StreamRecordUtils.row;
import static org.assertj.core.api.Assertions.assertThat;

/** Test for {@link DeltaJoinCache}. */
@ExtendWith(ParameterizedTestExtension.class)
class DeltaJoinCacheTest {

private static final Long LEFT_CACHE_SIZE = 3L;
private static final Long RIGHT_CACHE_SIZE = 2L;

@Parameters(name = "testRightCache = {0}")
private static List<Boolean> parameters() {
return Arrays.asList(false, true);
}

@Parameter private boolean testRightCache;

private DeltaJoinCache cache;
private Runnable requestCacheFunc;
private Runnable hitCacheFunc;
private BiConsumer<RowData, LinkedHashMap<RowData, Object>> buildCacheFunc;
private TriConsumer<RowData, RowData, Object> upsertCacheFunc;

@BeforeEach
void before() {
cache = new DeltaJoinCache(LEFT_CACHE_SIZE, RIGHT_CACHE_SIZE);

requestCacheFunc =
() -> {
if (testRightCache) {
cache.requestRightCache();
} else {
cache.requestLeftCache();
}
};
hitCacheFunc =
() -> {
if (testRightCache) {
cache.hitRightCache();
} else {
cache.hitLeftCache();
}
};
buildCacheFunc = (key, ukDataMap) -> cache.buildCache(key, ukDataMap, testRightCache);
upsertCacheFunc = (key, uk, data) -> cache.upsertCache(key, uk, data, testRightCache);
}

@TestTemplate
void testReportMetrics() {
Map<String, Metric> allMetrics = new HashMap<>();
cache.registerMetrics(
new UnregisteredMetricGroups.UnregisteredOperatorMetricGroup() {
@Override
protected void addMetric(String name, Metric metric) {
allMetrics.put(name, metric);
super.addMetric(name, metric);
}
});

assertReportMetricsInternal(allMetrics, 0, 0, 0.0, 0, 0);
requestCacheFunc.run();
assertReportMetricsInternal(allMetrics, 1, 0, 0.0, 0, 0);
hitCacheFunc.run();
assertReportMetricsInternal(allMetrics, 1, 1, 1.0, 0, 0);
requestCacheFunc.run();
assertReportMetricsInternal(allMetrics, 2, 1, 0.5, 0, 0);

buildCacheFunc.accept(row("ck1"), Maps.newLinkedHashMap());
assertReportMetricsInternal(allMetrics, 2, 1, 0.5, 1, 0);
buildCacheFunc.accept(
row("ck2"),
Maps.newLinkedHashMap(Map.of(row("pk1"), 1, row("pk2"), 2, row("pk3"), 3)));
assertReportMetricsInternal(allMetrics, 2, 1, 0.5, 2, 3);
upsertCacheFunc.accept(row("ck1"), row("pk4"), 4);
assertReportMetricsInternal(allMetrics, 2, 1, 0.5, 2, 4);
}

@SuppressWarnings("unchecked")
private void assertReportMetricsInternal(
Map<String, Metric> actualAllMetrics,
long expectedRequestCount,
long expectedHitCount,
double expectedHitRate,
long expectedKeySize,
long expectedNonEmptyValueSize) {
String prefix = testRightCache ? RIGHT_CACHE_METRIC_PREFIX : LEFT_CACHE_METRIC_PREFIX;

String hitRate = prefix + METRIC_HIT_RATE;
assertThat(((Gauge<Double>) actualAllMetrics.get(hitRate)).getValue())
.isEqualTo(expectedHitRate);

String requestCount = prefix + METRIC_REQUEST_COUNT;
assertThat(((Gauge<Long>) actualAllMetrics.get(requestCount)).getValue())
.isEqualTo(expectedRequestCount);

String hitCount = prefix + METRIC_HIT_COUNT;
assertThat(((Gauge<Long>) actualAllMetrics.get(hitCount)).getValue())
.isEqualTo(expectedHitCount);

String keySize = prefix + METRIC_KEY_SIZE;
assertThat(((Gauge<Long>) actualAllMetrics.get(keySize)).getValue())
.isEqualTo(expectedKeySize);

String totalNonEmptyValueSize = prefix + METRIC_TOTAL_NON_EMPTY_VALUE_SIZE;
assertThat(((Gauge<Long>) actualAllMetrics.get(totalNonEmptyValueSize)).getValue())
.isEqualTo(expectedNonEmptyValueSize);
}
}