-
Notifications
You must be signed in to change notification settings - Fork 674
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
118 changed files
with
4,724 additions
and
1,769 deletions.
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
219 changes: 219 additions & 0 deletions
219
solr/core/src/java/org/apache/solr/cluster/maintenance/InactiveShardRemover.java
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,219 @@ | ||
| /* | ||
| * 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.solr.cluster.maintenance; | ||
|
|
||
| import com.google.common.annotations.VisibleForTesting; | ||
| import java.lang.invoke.MethodHandles; | ||
| import java.util.Collection; | ||
| import java.util.HashSet; | ||
| import java.util.Objects; | ||
| import java.util.concurrent.Executors; | ||
| import java.util.concurrent.ScheduledExecutorService; | ||
| import java.util.concurrent.TimeUnit; | ||
| import java.util.stream.Collectors; | ||
| import org.apache.solr.api.ConfigurablePlugin; | ||
| import org.apache.solr.client.solrj.SolrResponse; | ||
| import org.apache.solr.client.solrj.request.CollectionAdminRequest; | ||
| import org.apache.solr.cloud.ClusterSingleton; | ||
| import org.apache.solr.common.cloud.ClusterState; | ||
| import org.apache.solr.common.cloud.DocCollection; | ||
| import org.apache.solr.common.cloud.Slice; | ||
| import org.apache.solr.common.cloud.ZkStateReader; | ||
| import org.apache.solr.common.util.ExecutorUtil; | ||
| import org.apache.solr.common.util.SolrNamedThreadFactory; | ||
| import org.apache.solr.core.CoreContainer; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| /** | ||
| * This Cluster Singleton can be configured to periodically find and remove {@link | ||
| * org.apache.solr.common.cloud.Slice.State#INACTIVE} Shards that are left behind after a Shard is | ||
| * split | ||
| */ | ||
| public class InactiveShardRemover | ||
| implements ClusterSingleton, ConfigurablePlugin<InactiveShardRemoverConfig> { | ||
|
|
||
| private static final Logger log = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass()); | ||
|
|
||
| public static final String PLUGIN_NAME = ".inactive-shard-remover"; | ||
|
|
||
| static class DeleteActor { | ||
|
|
||
| private final CoreContainer coreContainer; | ||
|
|
||
| DeleteActor(final CoreContainer coreContainer) { | ||
| this.coreContainer = coreContainer; | ||
| } | ||
|
|
||
| void delete(final Slice slice) { | ||
| CollectionAdminRequest.DeleteShard deleteRequest = | ||
| CollectionAdminRequest.deleteShard(slice.getCollection(), slice.getName()); | ||
| try { | ||
| SolrResponse response = | ||
| coreContainer.getZkController().getSolrCloudManager().request(deleteRequest); | ||
| if (response.getException() != null) { | ||
| throw response.getException(); | ||
| } | ||
| } catch (Exception e) { | ||
| log.warn("An exception occurred when deleting an inactive shard", e); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private State state = State.STOPPED; | ||
|
|
||
| private final CoreContainer coreContainer; | ||
|
|
||
| private final DeleteActor deleteActor; | ||
|
|
||
| private ScheduledExecutorService executor; | ||
|
|
||
| private long scheduleIntervalSeconds; | ||
|
|
||
| private long ttlSeconds; | ||
|
|
||
| private int maxDeletesPerCycle; | ||
|
|
||
| /** Constructor invoked via Reflection */ | ||
| public InactiveShardRemover(final CoreContainer cc) { | ||
| this(cc, new DeleteActor(cc)); | ||
| } | ||
|
|
||
| public InactiveShardRemover(final CoreContainer cc, final DeleteActor deleteActor) { | ||
| this.coreContainer = cc; | ||
| this.deleteActor = deleteActor; | ||
| } | ||
|
|
||
| @Override | ||
| public void configure(final InactiveShardRemoverConfig cfg) { | ||
| Objects.requireNonNull(cfg, "config must be specified"); | ||
| cfg.validate(); | ||
| this.scheduleIntervalSeconds = cfg.scheduleIntervalSeconds; | ||
| this.maxDeletesPerCycle = cfg.maxDeletesPerCycle; | ||
| this.ttlSeconds = cfg.ttlSeconds; | ||
| } | ||
|
|
||
| @Override | ||
| public String getName() { | ||
| return PLUGIN_NAME; | ||
| } | ||
|
|
||
| @Override | ||
| public State getState() { | ||
| return state; | ||
| } | ||
|
|
||
| @Override | ||
| public void start() throws Exception { | ||
| state = State.STARTING; | ||
| executor = Executors.newScheduledThreadPool(1, new SolrNamedThreadFactory(PLUGIN_NAME)); | ||
| executor.scheduleAtFixedRate( | ||
| this::deleteInactiveSlices, | ||
| scheduleIntervalSeconds, | ||
| scheduleIntervalSeconds, | ||
| TimeUnit.SECONDS); | ||
| state = State.RUNNING; | ||
| } | ||
|
|
||
| @Override | ||
| public void stop() { | ||
| if (state == State.RUNNING) { | ||
| state = State.STOPPING; | ||
| ExecutorUtil.shutdownNowAndAwaitTermination(executor); | ||
| } | ||
| state = State.STOPPED; | ||
| } | ||
|
|
||
| @VisibleForTesting | ||
| void deleteInactiveSlices() { | ||
| final ClusterState clusterState = coreContainer.getZkController().getClusterState(); | ||
| Collection<Slice> inactiveSlices = | ||
| clusterState.getCollectionsMap().values().stream() | ||
| .flatMap(v -> collectInactiveSlices(v).stream()) | ||
| .collect(Collectors.toSet()); | ||
|
|
||
| if (log.isInfoEnabled()) { | ||
| log.info( | ||
| "Found {} inactive Shards to delete, {} will be deleted", | ||
| inactiveSlices.size(), | ||
| Math.min(inactiveSlices.size(), maxDeletesPerCycle)); | ||
| } | ||
|
|
||
| inactiveSlices.stream().limit(maxDeletesPerCycle).forEach(this::deleteShard); | ||
| } | ||
|
|
||
| private Collection<Slice> collectInactiveSlices(final DocCollection docCollection) { | ||
| final Collection<Slice> slices = new HashSet<>(docCollection.getSlices()); | ||
| slices.removeAll(docCollection.getActiveSlices()); | ||
| return slices.stream().filter(this::isExpired).collect(Collectors.toSet()); | ||
| } | ||
|
|
||
| private void deleteShard(final Slice s) { | ||
| deleteActor.delete(s); | ||
| } | ||
|
|
||
| /** | ||
| * An Inactive Shard is expired if it has not undergone a state change in the period of time | ||
| * defined by {@link InactiveShardRemover#ttlSeconds}. If it is expired, it is eligible for | ||
| * removal. | ||
| */ | ||
| private boolean isExpired(final Slice slice) { | ||
|
|
||
| final String collectionName = slice.getCollection(); | ||
| final String sliceName = slice.getName(); | ||
|
|
||
| if (slice.getState() != Slice.State.INACTIVE) { | ||
| return false; | ||
| } | ||
|
|
||
| final String lastChangeTimestamp = slice.getStr(ZkStateReader.STATE_TIMESTAMP_PROP); | ||
| if (lastChangeTimestamp == null || lastChangeTimestamp.isEmpty()) { | ||
| log.warn( | ||
| "Collection {} Shard {} has no last change timestamp and will not be deleted", | ||
| collectionName, | ||
| sliceName); | ||
| return false; | ||
| } | ||
|
|
||
| final long epochTimestampNs; | ||
| try { | ||
| epochTimestampNs = Long.parseLong(lastChangeTimestamp); | ||
| } catch (NumberFormatException e) { | ||
| log.warn( | ||
| "Collection {} Shard {} has an invalid last change timestamp and will not be deleted", | ||
| collectionName, | ||
| sliceName); | ||
| return false; | ||
| } | ||
|
|
||
| long currentEpochTimeNs = | ||
| coreContainer.getZkController().getSolrCloudManager().getTimeSource().getEpochTimeNs(); | ||
| long delta = TimeUnit.NANOSECONDS.toSeconds(currentEpochTimeNs - epochTimestampNs); | ||
|
|
||
| boolean expired = delta >= ttlSeconds; | ||
| if (log.isDebugEnabled()) { | ||
| log.debug( | ||
| "collection {} shard {} last state change {} seconds ago. Expired={}", | ||
| slice.getCollection(), | ||
| slice.getName(), | ||
| delta, | ||
| expired); | ||
| } | ||
| return expired; | ||
| } | ||
| } |
60 changes: 60 additions & 0 deletions
60
solr/core/src/java/org/apache/solr/cluster/maintenance/InactiveShardRemoverConfig.java
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,60 @@ | ||
| /* | ||
| * 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.solr.cluster.maintenance; | ||
|
|
||
| import org.apache.solr.common.SolrException; | ||
| import org.apache.solr.common.annotation.JsonProperty; | ||
| import org.apache.solr.common.util.ReflectMapWriter; | ||
|
|
||
| public class InactiveShardRemoverConfig implements ReflectMapWriter { | ||
|
|
||
| public static final long DEFAULT_SCHEDULE_INTERVAL_SECONDS = 900L; // 15 minutes | ||
|
|
||
| public static final long DEFAULT_TTL_SECONDS = 900L; // 15 minutes | ||
|
|
||
| public static final int DEFAULT_MAX_DELETES_PER_CYCLE = 20; | ||
|
|
||
| @JsonProperty public long scheduleIntervalSeconds; | ||
|
|
||
| @JsonProperty public long ttlSeconds; | ||
|
|
||
| @JsonProperty public int maxDeletesPerCycle; | ||
|
|
||
| /** Default constructor required for deserialization */ | ||
| public InactiveShardRemoverConfig() { | ||
| this(DEFAULT_SCHEDULE_INTERVAL_SECONDS, DEFAULT_TTL_SECONDS, DEFAULT_MAX_DELETES_PER_CYCLE); | ||
| } | ||
|
|
||
| public InactiveShardRemoverConfig( | ||
| final long scheduleIntervalSeconds, final long ttlSeconds, final int maxDeletesPerCycle) { | ||
| this.scheduleIntervalSeconds = scheduleIntervalSeconds; | ||
| this.ttlSeconds = ttlSeconds; | ||
| this.maxDeletesPerCycle = maxDeletesPerCycle; | ||
| } | ||
|
|
||
| public void validate() { | ||
| if (scheduleIntervalSeconds <= 0) { | ||
| throw new SolrException( | ||
| SolrException.ErrorCode.BAD_REQUEST, "scheduleIntervalSeconds must be greater than 0"); | ||
| } | ||
| if (maxDeletesPerCycle <= 0) { | ||
| throw new SolrException( | ||
| SolrException.ErrorCode.BAD_REQUEST, "maxDeletesPerCycle must be greater than 0"); | ||
| } | ||
| } | ||
| } |
19 changes: 19 additions & 0 deletions
19
solr/core/src/java/org/apache/solr/cluster/maintenance/package-info.java
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,19 @@ | ||
| /* | ||
| * 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. | ||
| */ | ||
|
|
||
| /** Cluster Singleton plugins that are used to perform maintenance tasks within the cluster. */ | ||
| package org.apache.solr.cluster.maintenance; |
Oops, something went wrong.