skywalker0618 commented on code in PR #20735: URL: https://github.com/apache/hudi/pull/20735#discussion_r4647966937
########## hudi-flink-datasource/hudi-flink/src/main/java/org/apache/hudi/metrics/FlinkStreamReadLagMetrics.java: ########## @@ -0,0 +1,210 @@ +/* + * 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.hudi.metrics; + +import org.apache.hudi.common.table.timeline.HoodieInstantTimeGenerator; +import org.apache.hudi.common.util.VisibleForTesting; +import org.apache.hudi.source.split.HoodieSourceSplitLagInfo; + +import lombok.extern.slf4j.Slf4j; +import org.apache.flink.metrics.MetricGroup; + +import java.text.ParseException; +import java.time.Clock; +import java.time.Duration; +import java.util.Collection; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.TreeMap; + +/** + * Metrics of how far the streaming read lags behind the commits of the table, tracked by the split + * enumerator. + * + * <p>A commit is pending until every split that reads it is finished: either it is not discovered yet, + * or some of its splits are queued or being read. The lag is computed when the gauge is read, so it keeps growing while the readers stall. The methods are + * called from the coordinator thread and the gauges are read by the metric reporter thread. + * + * <p>Splits that the readers restore from their own state are not known to the enumerator, so they are + * not counted until they are added back. + */ +@Slf4j +public class FlinkStreamReadLagMetrics extends HoodieFlinkMetrics { + + private final Clock clock; + + /** + * Lag info of the discovered splits that are not finished yet, keyed by split id. + */ + private final Map<String, HoodieSourceSplitLagInfo> pendingSplits = new HashMap<>(); + + /** + * Number of pending splits that read each commit, keyed by instant time. + */ + private final Map<String, Integer> inFlightCommits = new HashMap<>(); + + /** + * Number of pending splits by the completion time of the oldest commit they read. + */ + private final TreeMap<String, Integer> oldestCompletionTimes = new TreeMap<>(); + + private int undiscoveredCommits; + + /** + * Completion time of the oldest undiscovered commit, null if there is none. + */ + private String oldestUndiscoveredCompletionTime; + + private long pendingRecords; + + private long pendingBytes; + + public FlinkStreamReadLagMetrics(MetricGroup metricGroup, String tableName) { + this(metricGroup, tableName, Clock.systemUTC()); + } + + @VisibleForTesting + FlinkStreamReadLagMetrics(MetricGroup metricGroup, String tableName, Clock clock) { + super(metricGroup.addGroup("table", tableName)); + this.clock = clock; + } + + @Override + public void registerMetrics() { + metricGroup.gauge("readLagSeconds", this::getReadLagSeconds); + metricGroup.gauge("pendingCommits", this::getPendingCommits); + metricGroup.gauge("undiscoveredCommits", this::getUndiscoveredCommits); + metricGroup.gauge("inFlightCommits", this::getInFlightCommits); + metricGroup.gauge("pendingSplits", this::getPendingSplits); + metricGroup.gauge("pendingRecords", this::getPendingRecords); + metricGroup.gauge("pendingBytes", this::getPendingBytes); + } + + /** + * Starts tracking the splits that were discovered, restored or added back, keyed by split id. Splits + * that are already tracked are ignored. + */ + public synchronized void addSplits(Map<String, HoodieSourceSplitLagInfo> lagInfos) { + lagInfos.forEach((splitId, lagInfo) -> { + if (pendingSplits.putIfAbsent(splitId, lagInfo) == null) { + add(lagInfo); + } + }); + } + + /** + * Replaces the lag info of the splits that are still tracked, keyed by split id. + */ + public synchronized void updateSplits(Map<String, HoodieSourceSplitLagInfo> lagInfos) { + lagInfos.forEach((splitId, lagInfo) -> { + HoodieSourceSplitLagInfo previous = pendingSplits.get(splitId); + if (previous != null) { + remove(previous); + pendingSplits.put(splitId, lagInfo); + add(lagInfo); + } + }); + } + + /** + * Stops tracking the splits whose records were all emitted. Splits that are not tracked are ignored. + */ + public synchronized void finishSplits(Collection<String> splitIds) { + for (String splitId : splitIds) { + HoodieSourceSplitLagInfo lagInfo = pendingSplits.remove(splitId); + if (lagInfo != null) { + remove(lagInfo); + } + } + } + + /** + * Sets the completion times of the completed commits that are not discovered yet, in ascending order. + */ + public synchronized void setUndiscoveredCommits(List<String> completionTimes) { + this.undiscoveredCommits = completionTimes.size(); + this.oldestUndiscoveredCompletionTime = completionTimes.isEmpty() ? null : completionTimes.get(0); + } + + /** + * Returns the seconds since the oldest pending commit completed, 0 if no commit is pending. + */ + private synchronized long getReadLagSeconds() { + String oldest = oldestUndiscoveredCompletionTime; + if (!oldestCompletionTimes.isEmpty() && (oldest == null || oldestCompletionTimes.firstKey().compareTo(oldest) < 0)) { + oldest = oldestCompletionTimes.firstKey(); + } + if (oldest == null) { + return 0L; + } + try { + return Duration.between(HoodieInstantTimeGenerator.parseDateFromInstantTime(oldest).toInstant(), clock.instant()).getSeconds(); Review Comment: Done, added UTs too. -- 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. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
