minor: Add logs and metrics observability to the segment upgrade path that fires while using concurrent locking #19651
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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,85 @@ | ||
| /* | ||
| * 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.druid.indexing.common; | ||
|
|
||
| import org.apache.druid.java.util.emitter.service.ServiceMetricEvent; | ||
| import org.apache.druid.metadata.PendingSegmentRecord; | ||
| import org.apache.druid.query.DruidMetrics; | ||
| import org.apache.druid.segment.realtime.appenderator.SegmentIdWithShardSpec; | ||
|
|
||
| /** | ||
| * Metric names and dimension values for the re-announcement of pending segments upgraded by a concurrent REPLACE. | ||
| * <ul> | ||
| * <li>the task action emits {@link #COUNT} (how many upgrades a commit produced),</li> | ||
| * <li>the supervisor emits {@link #NOTIFIED}, {@link #UNMATCHED} and {@link #SEND_FAILED} as it fans requests out,</li> | ||
| * <li>the streaming task emits {@link #ANNOUNCED} and {@link #SKIPPED} (with a {@code reason}) as it applies them.</li> | ||
| * </ul> | ||
| * Two reconciliations bound the visibility gap: | ||
| * <ul> | ||
| * <li>per segment, {@link #UNMATCHED} counts upgrades that reached no running task (delayed until handoff);</li> | ||
| * <li>per task, {@link #NOTIFIED} should equal {@link #ANNOUNCED} + {@link #SKIPPED} + {@link #SEND_FAILED}, | ||
| * since every notified task either announces, skips, or fails to receive the request. A shortfall means a | ||
| * notification was silently dropped.</li> | ||
| * </ul> | ||
| */ | ||
| public class SegmentUpgradeMetrics | ||
| { | ||
| /** Number of upgraded pending segments a REPLACE commit created and handed to the supervisor. Task-action dims. */ | ||
| public static final String COUNT = "ingest/realtime/segmentUpgrade/count"; | ||
|
|
||
| /** A notification was sent to a running task (once per task). Supervisor dims plus {@code taskId}. */ | ||
| public static final String NOTIFIED = "ingest/realtime/segmentUpgrade/notified"; | ||
|
|
||
| /** A record matched no running task and will not be re-announced until handoff. Supervisor dims. */ | ||
| public static final String UNMATCHED = "ingest/realtime/segmentUpgrade/unmatched"; | ||
|
|
||
| /** An upgrade request failed to reach a task over the wire. Supervisor dims plus {@code taskId}. */ | ||
| public static final String SEND_FAILED = "ingest/realtime/segmentUpgrade/sendFailed"; | ||
|
|
||
| /** A task announced an upgraded segment under the new version. Task dims. */ | ||
| public static final String ANNOUNCED = "ingest/realtime/segmentUpgrade/announced"; | ||
|
|
||
| /** | ||
| * A task received an upgrade request but did not announce it. The {@code reason} dimension carries | ||
| * {@link org.apache.druid.segment.realtime.appenderator.StreamAppenderator.PendingSegmentUpgradeResult#getReason()}. | ||
| * Task dims. | ||
| */ | ||
| public static final String SKIPPED = "ingest/realtime/segmentUpgrade/skipped"; | ||
|
|
||
| /** | ||
| * Adds the upgraded pending segment's {@code interval} and {@code version} to a metric builder so that every | ||
| * segment-upgrade metric can be sliced by the specific segment being re-announced. Mirrors | ||
| * {@code IndexTaskUtils.setSegmentDimensions}, which serves the same purpose for {@code DataSegment}s. | ||
| */ | ||
| public static ServiceMetricEvent.Builder setSegmentDimensions( | ||
|
Contributor
There was a problem hiding this comment. Nit: Maybe move this method to |
||
| ServiceMetricEvent.Builder metricBuilder, | ||
| PendingSegmentRecord pendingSegmentRecord | ||
| ) | ||
| { | ||
| final SegmentIdWithShardSpec id = pendingSegmentRecord.getId(); | ||
| return metricBuilder | ||
| .setDimension(DruidMetrics.INTERVAL, id.getInterval().toString()) | ||
| .setDimension(DruidMetrics.VERSION, id.getVersion()); | ||
| } | ||
|
|
||
| private SegmentUpgradeMetrics() | ||
| { | ||
| } | ||
| } | ||
This file contains hidden or 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 hidden or 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 |
|---|---|---|
|
|
@@ -60,6 +60,7 @@ | |
| import java.util.HashSet; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.OptionalInt; | ||
| import java.util.Set; | ||
| import java.util.concurrent.ConcurrentHashMap; | ||
| import java.util.concurrent.Future; | ||
|
|
@@ -511,8 +512,11 @@ public boolean checkPointDataSourceMetadata( | |
| * Registers a new version of the given pending segment on a supervisor. This | ||
| * allows the supervisor to include the pending segment in queries fired against | ||
| * that segment version. | ||
| * | ||
| * @return the number of tasks notified if the segment was registered on a seekable stream supervisor, or | ||
| * {@link OptionalInt#empty()} if no such supervisor was found or the registration failed | ||
| */ | ||
| public OptionalInt registerUpgradedPendingSegmentOnSupervisor( | ||
| String supervisorId, | ||
| PendingSegmentRecord upgradedPendingSegment | ||
| ) | ||
|
|
@@ -529,12 +533,11 @@ public boolean registerUpgradedPendingSegmentOnSupervisor( | |
| Pair<Supervisor, SupervisorSpec> supervisor = supervisors.get(supervisorId); | ||
| Preconditions.checkNotNull(supervisor, "supervisor could not be found"); | ||
| if (!(supervisor.lhs instanceof SeekableStreamSupervisor)) { | ||
| return OptionalInt.empty(); | ||
| } | ||
|
|
||
| SeekableStreamSupervisor<?, ?, ?> seekableStreamSupervisor = (SeekableStreamSupervisor<?, ?, ?>) supervisor.lhs; | ||
| return OptionalInt.of(seekableStreamSupervisor.registerNewVersionOfPendingSegment(upgradedPendingSegment)); | ||
| } | ||
| catch (Exception e) { | ||
| log.error( | ||
|
|
@@ -545,7 +548,7 @@ public boolean registerUpgradedPendingSegmentOnSupervisor( | |
| supervisorId | ||
| ); | ||
| } | ||
| return OptionalInt.empty(); | ||
| } | ||
|
|
||
| /** | ||
|
|
||
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.
We should probably rename this metric from
counttopersistedto signify that this is the count that was actually persisted to the metadata store.Also, rephrased the text a bit.