CASSSIDECAR-374: Implement durable operational job tracker #359
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,233 @@ | ||
| /* | ||
| * 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.cassandra.sidecar.job; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.Collections; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.UUID; | ||
| import java.util.concurrent.ConcurrentHashMap; | ||
| import java.util.function.Function; | ||
| import java.util.stream.Collectors; | ||
|
|
||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| import com.google.inject.Inject; | ||
| import com.google.inject.Singleton; | ||
| import org.apache.cassandra.sidecar.common.data.OperationalJobStatus; | ||
| import org.apache.cassandra.sidecar.concurrent.TaskExecutorPool; | ||
| import org.apache.cassandra.sidecar.config.ServiceConfiguration; | ||
| import org.apache.cassandra.sidecar.job.storage.OperationalJobRecord; | ||
| import org.apache.cassandra.sidecar.job.storage.StorageProvider; | ||
| import org.jetbrains.annotations.NotNull; | ||
| import org.jetbrains.annotations.Nullable; | ||
|
|
||
| /** | ||
| * A durable implementation of {@link OperationalJobTracker} that persists job state | ||
| * via a {@link StorageProvider}. A local {@link ConcurrentHashMap} caches live | ||
| * {@link OperationalJob} references for the current process, since executing jobs | ||
| * with Vert.x promises cannot be reconstituted from storage. Once a job completes, | ||
| * it is removed from the local map, and subsequent lookups are served from storage. | ||
| */ | ||
| @Singleton | ||
| public class DurableOperationalJobTracker implements OperationalJobTracker | ||
| { | ||
| private static final Logger LOGGER = LoggerFactory.getLogger(DurableOperationalJobTracker.class); | ||
| private static final int MAX_STATUS_UPDATE_ATTEMPTS = 3; | ||
| private static final long RETRY_DELAY_MS = 100; | ||
|
|
||
| private final ConcurrentHashMap<UUID, OperationalJob> liveJobs; | ||
| private final StorageProvider storageProvider; | ||
| private final TaskExecutorPool executor; | ||
|
|
||
| @Inject | ||
| public DurableOperationalJobTracker(ServiceConfiguration serviceConfiguration, | ||
| StorageProvider storageProvider, | ||
| TaskExecutorPool executor) | ||
| { | ||
| this.liveJobs = new ConcurrentHashMap<>(serviceConfiguration.operationalJobTrackerSize()); | ||
| this.storageProvider = storageProvider; | ||
|
Contributor
There was a problem hiding this comment. who is expected to initialize the storage provider ? can this class assume it's already initialized or do we want to initialize here?
Contributor
Author
There was a problem hiding this comment. The The idea is that an operator will choose between the durable or in-memory tracker via configuration. I'm deferring these edits to |
||
| this.executor = executor; | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritDoc} | ||
| */ | ||
| @Override | ||
| public OperationalJob computeIfAbsent(UUID jobId, Function<UUID, OperationalJob> mappingFunction) | ||
| { | ||
| if (!storageProvider.isAvailable()) | ||
| { | ||
| throw new IllegalStateException("Storage provider is not available"); | ||
| } | ||
|
|
||
| boolean[] created = {false}; | ||
| OperationalJob job = liveJobs.computeIfAbsent(jobId, id -> { | ||
| created[0] = true; | ||
| return mappingFunction.apply(id); | ||
| }); | ||
|
|
||
| if (created[0]) | ||
| { | ||
| executor.executeBlocking(() -> { | ||
| storageProvider.persistJob(OperationalJobRecord.fromOperationalJob(job)); | ||
| return null; | ||
| }).onFailure(e -> { | ||
| liveJobs.remove(jobId, job); | ||
| LOGGER.error("Failed to persist job {} to storage. Job will not be tracked durably.", | ||
| jobId, e); | ||
| }); | ||
|
|
||
| job.asyncResult().onComplete(ar -> { | ||
| updateTerminalStatus(job); | ||
| liveJobs.remove(job.jobId()); | ||
| }); | ||
| } | ||
|
|
||
| return job; | ||
| } | ||
|
|
||
| @Nullable | ||
| @Override | ||
| public OperationalJobInfo get(UUID jobId) | ||
| { | ||
| OperationalJob liveJob = liveJobs.get(jobId); | ||
| if (liveJob != null) | ||
| { | ||
| return liveJob; | ||
| } | ||
|
|
||
| OperationalJobRecord record = storageProvider.findJob(jobId); | ||
| if (record == null) | ||
| { | ||
| return null; | ||
| } | ||
| return enrichWithNodeStatuses(record); | ||
| } | ||
|
|
||
| @NotNull | ||
| @Override | ||
| public Map<UUID, OperationalJob> jobsView() | ||
| { | ||
| return Collections.unmodifiableMap(liveJobs); | ||
| } | ||
|
|
||
| @NotNull | ||
| @Override | ||
| public List<OperationalJob> inflightJobsByOperation(String operation) | ||
| { | ||
| return liveJobs.values() | ||
| .stream() | ||
| .filter(j -> j.name().equals(operation) && | ||
| (j.status() == OperationalJobStatus.RUNNING || | ||
| j.status() == OperationalJobStatus.CREATED)) | ||
| .collect(Collectors.toList()); | ||
| } | ||
|
|
||
| /** | ||
| * Enriches an {@link OperationalJobRecord} with per-node status data from storage. | ||
| * If the record already has non-empty node lists (e.g. populated by a storage provider | ||
| * that joins the data in a single query), the record is returned as is. | ||
| */ | ||
| private OperationalJobRecord enrichWithNodeStatuses(OperationalJobRecord record) | ||
| { | ||
| if (!record.nodesPending().isEmpty() | ||
| || !record.nodesExecuting().isEmpty() | ||
| || !record.nodesSucceeded().isEmpty() | ||
| || !record.nodesFailed().isEmpty()) | ||
| { | ||
| return record; | ||
| } | ||
|
|
||
| Map<UUID, OperationalJobStatus> nodeStatuses = | ||
| storageProvider.getNodeStatusesForOperation(record.jobId()); | ||
| if (nodeStatuses.isEmpty()) | ||
| { | ||
| return record; | ||
| } | ||
|
|
||
| List<UUID> pending = new ArrayList<>(); | ||
| List<UUID> executing = new ArrayList<>(); | ||
| List<UUID> succeeded = new ArrayList<>(); | ||
| List<UUID> failed = new ArrayList<>(); | ||
|
|
||
| for (Map.Entry<UUID, OperationalJobStatus> entry : nodeStatuses.entrySet()) | ||
| { | ||
| switch (entry.getValue()) | ||
| { | ||
| case CREATED: | ||
| pending.add(entry.getKey()); | ||
| break; | ||
| case RUNNING: | ||
| executing.add(entry.getKey()); | ||
| break; | ||
| case SUCCEEDED: | ||
| succeeded.add(entry.getKey()); | ||
| break; | ||
| case FAILED: | ||
| failed.add(entry.getKey()); | ||
| break; | ||
| default: | ||
| break; | ||
| } | ||
| } | ||
|
|
||
| return new OperationalJobRecord(record.jobId(), record.operationType(), record.status(), | ||
| record.startTime(), record.lastUpdate(), record.failureReason(), | ||
| record.nodeExecutionOrder(), record.operationMetadata(), | ||
| Collections.unmodifiableList(pending), | ||
| Collections.unmodifiableList(executing), | ||
| Collections.unmodifiableList(succeeded), | ||
| Collections.unmodifiableList(failed)); | ||
| } | ||
|
|
||
| /** | ||
| * Attempts to update the terminal status in storage with retry. | ||
| * If all attempts fail, logs a warning and continues. | ||
| */ | ||
| private void updateTerminalStatus(OperationalJob job) | ||
| { | ||
| updateTerminalStatus(job, 1); | ||
| } | ||
|
|
||
| private void updateTerminalStatus(OperationalJob job, int attempt) | ||
| { | ||
| try | ||
| { | ||
| storageProvider.updateJobStatus(job.jobId(), job.operationType(), job.status(), job.failureReason()); | ||
| } | ||
| catch (RuntimeException e) | ||
| { | ||
| LOGGER.warn("Failed to update terminal status for job {} (attempt {}/{}). error={}", | ||
| job.jobId(), attempt, MAX_STATUS_UPDATE_ATTEMPTS, e.getMessage()); | ||
| if (attempt < MAX_STATUS_UPDATE_ATTEMPTS) | ||
|
Contributor
There was a problem hiding this comment.
Contributor
Author
There was a problem hiding this comment. Increased MAX_STATUS_UPDATE_ATTEMPTS to 3 in d8a6bf9. Agreed that there should be a periodic thread to remove stale entries in a later patch. |
||
| { | ||
| executor.setTimer(RETRY_DELAY_MS * attempt, | ||
| id -> updateTerminalStatus(job, attempt + 1)); | ||
| } | ||
| else | ||
| { | ||
| LOGGER.error("Exhausted retries when updating terminal status for job {}. " + | ||
| "Manual intervention may be required to correct job metadata.", job.jobId(), e); | ||
| } | ||
| } | ||
| } | ||
| } | ||
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
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
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.
Unlike InMemoryOperationalJobTracker which has removeEldestEntry, the durable tracker has no eviction. If
asyncResult() never completes (e.g., executeBlocking fails to submit due to full pool), the entry stays in the map forever. Is this expected?
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.
Good catch. If executeBlocking fails to submit due to a full pool, the entry will stay in the map forever. As mentioned in the comment below, I will defer a cleanup job for stale entries to a follow up PR, unless you think it should be addressed here.