KKcorps commented on code in PR #8877: URL: https://github.com/apache/pinot/pull/8877#discussion_r911358944
########## pinot-controller/src/main/java/org/apache/pinot/controller/helix/core/realtime/MissingConsumingSegmentFinder.java: ########## @@ -0,0 +1,221 @@ +/** + * 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.pinot.controller.helix.core.realtime; + +import com.google.common.annotations.VisibleForTesting; +import com.google.common.base.Preconditions; +import java.time.Duration; +import java.time.Instant; +import java.util.Collections; +import java.util.HashMap; +import java.util.Map; +import org.apache.helix.AccessOption; +import org.apache.helix.ZNRecord; +import org.apache.helix.model.IdealState; +import org.apache.helix.store.zk.ZkHelixPropertyStore; +import org.apache.pinot.common.metadata.ZKMetadataProvider; +import org.apache.pinot.common.metadata.segment.SegmentZKMetadata; +import org.apache.pinot.common.metrics.ControllerGauge; +import org.apache.pinot.common.metrics.ControllerMeter; +import org.apache.pinot.common.metrics.ControllerMetrics; +import org.apache.pinot.common.utils.LLCSegmentName; +import org.apache.pinot.controller.helix.core.PinotTableIdealStateBuilder; +import org.apache.pinot.spi.stream.OffsetCriteria; +import org.apache.pinot.spi.stream.PartitionLevelStreamConfig; +import org.apache.pinot.spi.stream.StreamConsumerFactoryProvider; +import org.apache.pinot.spi.stream.StreamPartitionMsgOffset; +import org.apache.pinot.spi.stream.StreamPartitionMsgOffsetFactory; +import org.apache.pinot.spi.utils.CommonConstants.Helix.StateModel.SegmentStateModel; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + + +/** + * For a given table, this class finds out if there is any partition group for which there's no consuming segment in + * ideal state. If so, it emits three metrics: + * - Total number of partitions with missing consuming segments including + * - Number of newly added partitions for which there's no consuming segment (there's no completed segment either) + * - Maximum duration (in minutes) that a partition hasn't had a consuming segment + */ +public class MissingConsumingSegmentFinder { + private static final Logger LOGGER = LoggerFactory.getLogger(MissingConsumingSegmentFinder.class); + + private final String _realtimeTableName; + private final SegmentMetadataFetcher _segmentMetadataFetcher; + private final Map<Integer, StreamPartitionMsgOffset> _partitionGroupIdToLargestStreamOffsetMap; + private final StreamPartitionMsgOffsetFactory _streamPartitionMsgOffsetFactory; + + private ControllerMetrics _controllerMetrics; + + public MissingConsumingSegmentFinder(String realtimeTableName, ZkHelixPropertyStore<ZNRecord> propertyStore, + ControllerMetrics controllerMetrics, PartitionLevelStreamConfig streamConfig) { + _realtimeTableName = realtimeTableName; + _controllerMetrics = controllerMetrics; + _segmentMetadataFetcher = new SegmentMetadataFetcher(propertyStore, controllerMetrics); + _streamPartitionMsgOffsetFactory = + StreamConsumerFactoryProvider.create(streamConfig).createStreamMsgOffsetFactory(); + + // create partition group id to largest stream offset map + _partitionGroupIdToLargestStreamOffsetMap = new HashMap<>(); + streamConfig.setOffsetCriteria(OffsetCriteria.LARGEST_OFFSET_CRITERIA); + try { + PinotTableIdealStateBuilder.getPartitionGroupMetadataList(streamConfig, Collections.emptyList()) + .forEach(metadata -> { + _partitionGroupIdToLargestStreamOffsetMap.put(metadata.getPartitionGroupId(), metadata.getStartOffset()); + }); + } catch (Exception e) { + LOGGER.warn("Problem encountered in fetching stream metadata for topic: {} of table: {}. " + + "Continue finding missing consuming segment only with ideal state information.", + streamConfig.getTopicName(), streamConfig.getTableNameWithType()); + } + } + + @VisibleForTesting + MissingConsumingSegmentFinder(String realtimeTableName, SegmentMetadataFetcher segmentMetadataFetcher, + Map<Integer, StreamPartitionMsgOffset> partitionGroupIdToLargestStreamOffsetMap, + StreamPartitionMsgOffsetFactory streamPartitionMsgOffsetFactory) { + _realtimeTableName = realtimeTableName; + _segmentMetadataFetcher = segmentMetadataFetcher; + _partitionGroupIdToLargestStreamOffsetMap = partitionGroupIdToLargestStreamOffsetMap; + _streamPartitionMsgOffsetFactory = streamPartitionMsgOffsetFactory; + } + + public void findAndEmitMetrics(IdealState idealState) { + MissingSegmentInfo info = findMissingSegments(idealState.getRecord().getMapFields(), Instant.now()); + _controllerMetrics.setValueOfTableGauge(_realtimeTableName, ControllerGauge.MISSING_CONSUMING_SEGMENT_TOTAL_COUNT, + info._totalCount); + _controllerMetrics + .setValueOfTableGauge(_realtimeTableName, ControllerGauge.MISSING_CONSUMING_SEGMENT_NEW_PARTITION_COUNT, + info._newPartitionGroupCount); + _controllerMetrics + .setValueOfTableGauge(_realtimeTableName, ControllerGauge.MISSING_CONSUMING_SEGMENT_MAX_DURATION_MINUTES, + info._maxDurationInMinutes); + } + + @VisibleForTesting + MissingSegmentInfo findMissingSegments(Map<String, Map<String, String>> idealStateMap, Instant now) { + // create the maps + Map<Integer, LLCSegmentName> partitionGroupIdToLatestConsumingSegmentMap = new HashMap<>(); + Map<Integer, LLCSegmentName> partitionGroupIdToLatestCompletedSegmentMap = new HashMap<>(); + idealStateMap.forEach((segmentName, instanceToStatusMap) -> { + LLCSegmentName llcSegmentName = LLCSegmentName.of(segmentName); + if (llcSegmentName != null) { // Skip the uploaded realtime segments that don't conform to llc naming + if (instanceToStatusMap.containsValue(SegmentStateModel.CONSUMING)) { + updateMap(partitionGroupIdToLatestConsumingSegmentMap, llcSegmentName); + } else if (instanceToStatusMap.containsValue(SegmentStateModel.ONLINE)) { + updateMap(partitionGroupIdToLatestCompletedSegmentMap, llcSegmentName); + } + } + }); + + MissingSegmentInfo missingSegmentInfo = new MissingSegmentInfo(); + if (!_partitionGroupIdToLargestStreamOffsetMap.isEmpty()) { + _partitionGroupIdToLargestStreamOffsetMap.forEach((partitionGroupId, largestStreamOffset) -> { + if (!partitionGroupIdToLatestConsumingSegmentMap.containsKey(partitionGroupId)) { + LLCSegmentName latestCompletedSegment = partitionGroupIdToLatestCompletedSegmentMap.get(partitionGroupId); + if (latestCompletedSegment == null) { + // There's no consuming or completed segment for this partition group. Possibilities: + // 1) it's a new partition group that has not yet been detected + // 2) the first consuming segment has been deleted from ideal state manually + missingSegmentInfo._newPartitionGroupCount++; + missingSegmentInfo._totalCount++; + } else { + // completed segment is available, but there's no consuming segment + SegmentZKMetadata segmentZKMetadata = _segmentMetadataFetcher + .fetchSegmentZkMetadata(_realtimeTableName, latestCompletedSegment.getSegmentName()); + StreamPartitionMsgOffset completedSegmentEndOffset = + _streamPartitionMsgOffsetFactory.create(segmentZKMetadata.getEndOffset()); + if (completedSegmentEndOffset.compareTo(largestStreamOffset) < 0) { Review Comment: I was only concerned about `.compareTo` working for Kinesis or not but after looking at the code it should. -- 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: commits-unsubscr...@pinot.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@pinot.apache.org For additional commands, e-mail: commits-h...@pinot.apache.org
