Upsert small segment merger task in minions #14477
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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.pinot.plugin.minion.tasks.upsertcompactmerge; | ||
|
|
||
| import java.io.File; | ||
| import java.util.ArrayList; | ||
| import java.util.Collections; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.Objects; | ||
| import java.util.Optional; | ||
| import java.util.Set; | ||
| import java.util.TreeMap; | ||
| import java.util.stream.Collectors; | ||
| import org.apache.pinot.common.metadata.segment.SegmentZKMetadataCustomMapModifier; | ||
| import org.apache.pinot.common.restlet.resources.ValidDocIdsType; | ||
| import org.apache.pinot.common.utils.SegmentUtils; | ||
| import org.apache.pinot.core.common.MinionConstants; | ||
| import org.apache.pinot.core.minion.PinotTaskConfig; | ||
| import org.apache.pinot.core.segment.processing.framework.DefaultSegmentNumRowProvider; | ||
| import org.apache.pinot.core.segment.processing.framework.SegmentProcessorConfig; | ||
| import org.apache.pinot.core.segment.processing.framework.SegmentProcessorFramework; | ||
| import org.apache.pinot.minion.MinionConf; | ||
| import org.apache.pinot.plugin.minion.tasks.BaseMultipleSegmentsConversionExecutor; | ||
| import org.apache.pinot.plugin.minion.tasks.MinionTaskUtils; | ||
| import org.apache.pinot.plugin.minion.tasks.SegmentConversionResult; | ||
| import org.apache.pinot.segment.local.segment.readers.CompactedPinotSegmentRecordReader; | ||
| import org.apache.pinot.segment.spi.creator.name.UploadedRealtimeSegmentNameGenerator; | ||
| import org.apache.pinot.segment.spi.index.metadata.SegmentMetadataImpl; | ||
| import org.apache.pinot.spi.config.table.TableConfig; | ||
| import org.apache.pinot.spi.data.Schema; | ||
| import org.apache.pinot.spi.data.readers.RecordReader; | ||
| import org.apache.pinot.spi.utils.builder.TableNameBuilder; | ||
| import org.roaringbitmap.RoaringBitmap; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
|
|
||
| /** | ||
| * Minion task that compacts and merges multiple segments of an upsert table and uploads it back as one single | ||
| * segment. This helps in keeping the segment count in check and also prevents a lot of small segments created over | ||
| * time. | ||
| */ | ||
| public class UpsertCompactMergeTaskExecutor extends BaseMultipleSegmentsConversionExecutor { | ||
tibrewalpratik17 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| private static final Logger LOGGER = LoggerFactory.getLogger(UpsertCompactMergeTaskExecutor.class); | ||
|
|
||
| public UpsertCompactMergeTaskExecutor(MinionConf minionConf) { | ||
| super(minionConf); | ||
| } | ||
|
|
||
| @Override | ||
| protected List<SegmentConversionResult> convert(PinotTaskConfig pinotTaskConfig, List<File> segmentDirs, | ||
| File workingDir) | ||
| throws Exception { | ||
| int numInputSegments = segmentDirs.size(); | ||
| _eventObserver.notifyProgress(pinotTaskConfig, "Converting segments: " + numInputSegments); | ||
| String taskType = pinotTaskConfig.getTaskType(); | ||
| Map<String, String> configs = pinotTaskConfig.getConfigs(); | ||
| LOGGER.info("Starting task: {} with configs: {}", taskType, configs); | ||
| long startMillis = System.currentTimeMillis(); | ||
|
|
||
| String tableNameWithType = configs.get(MinionConstants.TABLE_NAME_KEY); | ||
| TableConfig tableConfig = getTableConfig(tableNameWithType); | ||
| Schema schema = getSchema(tableNameWithType); | ||
|
|
||
| SegmentProcessorConfig.Builder segmentProcessorConfigBuilder = | ||
| new SegmentProcessorConfig.Builder().setTableConfig(tableConfig).setSchema(schema); | ||
|
|
||
| // Progress observer | ||
| segmentProcessorConfigBuilder.setProgressObserver(p -> _eventObserver.notifyProgress(_pinotTaskConfig, p)); | ||
|
|
||
| // get list of segment metadata | ||
| List<SegmentMetadataImpl> segmentMetadataList = segmentDirs.stream().map(x -> { | ||
| try { | ||
| return new SegmentMetadataImpl(x); | ||
| } catch (Exception e) { | ||
| throw new RuntimeException(String.format("Error fetching segment-metadata for segmentDir: %s", x), e); | ||
| } | ||
| }).collect(Collectors.toList()); | ||
|
|
||
| // validate if partitionID is same for all small segments. Get partition id value for new segment. | ||
| int partitionID = getCommonPartitionIDForSegments(segmentMetadataList); | ||
|
|
||
| // get the max creation time of the small segments. This will be the index creation time for the new segment. | ||
| Optional<Long> maxCreationTimeOfMergingSegments = | ||
| segmentMetadataList.stream().map(SegmentMetadataImpl::getIndexCreationTime).reduce(Long::max); | ||
| if (maxCreationTimeOfMergingSegments.isEmpty()) { | ||
|
There was a problem hiding this comment. Just to confirm: There was a problem hiding this comment. Yes we have added the check in generator code to ensure |
||
| String message = "No valid creation time found for the new merged segment. This might be due to " | ||
| + "missing creation time for merging segments"; | ||
| LOGGER.error(message); | ||
| throw new RuntimeException(message); | ||
| } | ||
|
|
||
| // validate if crc of deepstore copies is same as that in ZK of segments | ||
| List<String> originalSegmentCrcFromTaskGenerator = | ||
| List.of(configs.get(MinionConstants.ORIGINAL_SEGMENT_CRC_KEY).split(",")); | ||
| validateCRCForInputSegments(segmentMetadataList, originalSegmentCrcFromTaskGenerator); | ||
|
|
||
| // Fetch validDocID snapshot from server and get record-reader for compacted reader. | ||
| List<RecordReader> recordReaders = segmentMetadataList.stream().map(x -> { | ||
| RoaringBitmap validDocIds = MinionTaskUtils.getValidDocIdFromServerMatchingCrc(tableNameWithType, x.getName(), | ||
| ValidDocIdsType.SNAPSHOT.name(), MINION_CONTEXT, x.getCrc()); | ||
| if (validDocIds == null) { | ||
| // no valid crc match found or no validDocIds obtained from all servers | ||
| // error out the task instead of silently failing so that we can track it via task-error metrics | ||
| String message = String.format("No validDocIds found from all servers. They either failed to download " | ||
| + "or did not match crc from segment copy obtained from deepstore / servers. " + "Expected crc: %s", ""); | ||
| LOGGER.error(message); | ||
| throw new IllegalStateException(message); | ||
| } | ||
| return new CompactedPinotSegmentRecordReader(x.getIndexDir(), validDocIds); | ||
| }).collect(Collectors.toList()); | ||
|
|
||
| // create new UploadedRealtimeSegment | ||
| segmentProcessorConfigBuilder.setCustomCreationTime(maxCreationTimeOfMergingSegments.get()); | ||
| segmentProcessorConfigBuilder.setSegmentNameGenerator( | ||
| new UploadedRealtimeSegmentNameGenerator(TableNameBuilder.extractRawTableName(tableNameWithType), partitionID, | ||
| System.currentTimeMillis(), MinionConstants.UpsertCompactMergeTask.MERGED_SEGMENT_NAME_PREFIX, null)); | ||
| SegmentProcessorConfig segmentProcessorConfig = segmentProcessorConfigBuilder.build(); | ||
| List<File> outputSegmentDirs; | ||
| try { | ||
| _eventObserver.notifyProgress(_pinotTaskConfig, "Generating segments"); | ||
| outputSegmentDirs = new SegmentProcessorFramework(segmentProcessorConfig, workingDir, | ||
| SegmentProcessorFramework.convertRecordReadersToRecordReaderFileConfig(recordReaders), | ||
| Collections.emptyList(), new DefaultSegmentNumRowProvider(Integer.parseInt( | ||
| configs.get(MinionConstants.UpsertCompactMergeTask.MAX_NUM_RECORDS_PER_SEGMENT_KEY)))).process(); | ||
| } finally { | ||
| for (RecordReader recordReader : recordReaders) { | ||
| recordReader.close(); | ||
| } | ||
| } | ||
|
|
||
| long endMillis = System.currentTimeMillis(); | ||
| LOGGER.info("Finished task: {} with configs: {}. Total time: {}ms", taskType, configs, (endMillis - startMillis)); | ||
|
|
||
| List<SegmentConversionResult> results = new ArrayList<>(); | ||
| for (File outputSegmentDir : outputSegmentDirs) { | ||
|
There was a problem hiding this comment. just to be sure, could one task generate multiple new segments or just one? If multiple segments could be created, then how to handle cases when some segments failed to get uploaded. There was a problem hiding this comment. Current implementation ensures generating one segment. But if you think about it even if we generate multiple segments, we don't need to think about rollback much. It's just that whatever segments got uploaded, validDocIds will be uploaded for those and the corresponding segments would be discarded as their docs will be invalid (assuming takeSnapshot has run once). There was a problem hiding this comment. I see. For M:N merging, I think the computation of There was a problem hiding this comment.
Yeah or we ensure always selecting complete 'x' segments while creating N segments such that sum over x = M. For the sake of simplicity, we are resolving this in task-generation itself currently ensuring to generate multiple X:1 subtasks instead. |
||
| String outputSegmentName = outputSegmentDir.getName(); | ||
| results.add(new SegmentConversionResult.Builder().setFile(outputSegmentDir).setSegmentName(outputSegmentName) | ||
| .setTableNameWithType(tableNameWithType).build()); | ||
| } | ||
| return results; | ||
| } | ||
|
|
||
| @Override | ||
| protected SegmentZKMetadataCustomMapModifier getSegmentZKMetadataCustomMapModifier(PinotTaskConfig pinotTaskConfig, | ||
| SegmentConversionResult segmentConversionResult) { | ||
| Map<String, String> updateMap = new TreeMap<>(); | ||
| updateMap.put(MinionConstants.UpsertCompactMergeTask.TASK_TYPE + MinionConstants.TASK_TIME_SUFFIX, | ||
| String.valueOf(System.currentTimeMillis())); | ||
| updateMap.put(MinionConstants.UpsertCompactMergeTask.TASK_TYPE | ||
| + MinionConstants.UpsertCompactMergeTask.MERGED_SEGMENTS_ZK_SUFFIX, | ||
| pinotTaskConfig.getConfigs().get(MinionConstants.SEGMENT_NAME_KEY)); | ||
| return new SegmentZKMetadataCustomMapModifier(SegmentZKMetadataCustomMapModifier.ModifyMode.UPDATE, updateMap); | ||
| } | ||
|
|
||
| int getCommonPartitionIDForSegments(List<SegmentMetadataImpl> segmentMetadataList) { | ||
| List<String> segmentNames = | ||
| segmentMetadataList.stream().map(SegmentMetadataImpl::getName).collect(Collectors.toList()); | ||
| Set<Integer> partitionIDSet = segmentNames.stream().map(x -> { | ||
| Integer segmentPartitionId = SegmentUtils.getPartitionIdFromRealtimeSegmentName(x); | ||
| if (segmentPartitionId == null) { | ||
| throw new IllegalStateException(String.format("Partition id not found for %s", x)); | ||
| } | ||
| return segmentPartitionId; | ||
| }).collect(Collectors.toSet()); | ||
| if (partitionIDSet.size() > 1) { | ||
| throw new IllegalStateException( | ||
| "Found segments with different partition ids during task execution: " + partitionIDSet); | ||
| } | ||
| return partitionIDSet.iterator().next(); | ||
| } | ||
|
|
||
| void validateCRCForInputSegments(List<SegmentMetadataImpl> segmentMetadataList, List<String> expectedCRCList) { | ||
| for (int i = 0; i < segmentMetadataList.size(); i++) { | ||
| SegmentMetadataImpl segmentMetadata = segmentMetadataList.get(i); | ||
| if (!Objects.equals(segmentMetadata.getCrc(), expectedCRCList.get(i))) { | ||
| String message = String.format("Crc mismatched between ZK and deepstore copy of segment: %s. Expected crc " | ||
| + "from ZK: %s, crc from deepstore: %s", segmentMetadata.getName(), expectedCRCList.get(i), | ||
| segmentMetadata.getCrc()); | ||
| LOGGER.error(message); | ||
| throw new IllegalStateException(message); | ||
| } | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
broad question: say we run both merge compaction and the segment refresh task for a table. How do we ensure that there aren't any race conditions, because it could be that the two tasks end up processing the same set of segments concurrently.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So with merge-compaction we would end up creating a new segment and refresh would just go and do a replaceSegment flow in metadata-manager. For refresh of LLC segment we should be good as the newly generated UploadedRealtimeSegment would override the keys which it should.
For refresh of UploadedRealtimeSegment, there's an issue right now where we use creation time to resolve for the latest uploaded segment, now there can be an edge case where creation time is same for both then whichever gets refreshed / uploaded later would dominate. But overall if you see it doesn't matter in the broad sense because for upserts we would still point to just one record per key.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Correctness wise we should be fine I guess, but this will still impede or impact the Segment Refresh task. Can you create a separate issue for this with some context on the problem so we could pick it up later?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
#14633