Mmuzaf commented on a change in pull request #8909: URL: https://github.com/apache/ignite/pull/8909#discussion_r604211327
########## File path: modules/core/src/main/java/org/apache/ignite/internal/cdc/IgniteCDC.java ########## @@ -0,0 +1,475 @@ +/* + * 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.ignite.internal.cdc; + +import java.io.File; +import java.io.IOException; +import java.io.Serializable; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.Paths; +import java.util.ArrayList; +import java.util.Comparator; +import java.util.HashSet; +import java.util.Iterator; +import java.util.List; +import java.util.Set; +import java.util.function.Predicate; +import java.util.stream.Stream; +import org.apache.ignite.IgniteCheckedException; +import org.apache.ignite.IgniteException; +import org.apache.ignite.IgniteLogger; +import org.apache.ignite.cdc.CaptureDataChangeConfiguration; +import org.apache.ignite.cdc.CaptureDataChangeConsumer; +import org.apache.ignite.cdc.ChangeEvent; +import org.apache.ignite.configuration.DataStorageConfiguration; +import org.apache.ignite.configuration.IgniteConfiguration; +import org.apache.ignite.internal.IgnitionEx; +import org.apache.ignite.internal.MarshallerContextImpl; +import org.apache.ignite.internal.pagemem.wal.WALIterator; +import org.apache.ignite.internal.processors.cache.binary.CacheObjectBinaryProcessorImpl; +import org.apache.ignite.internal.processors.cache.persistence.filename.PdsFolderResolver; +import org.apache.ignite.internal.processors.cache.persistence.filename.PdsFolderSettings; +import org.apache.ignite.internal.processors.cache.persistence.wal.WALPointer; +import org.apache.ignite.internal.processors.cache.persistence.wal.reader.IgniteWalIteratorFactory; +import org.apache.ignite.internal.util.typedef.F; +import org.apache.ignite.internal.util.typedef.internal.CU; +import org.apache.ignite.internal.util.typedef.internal.U; +import org.apache.ignite.lang.IgniteBiTuple; + +import static org.apache.ignite.internal.pagemem.wal.record.WALRecord.RecordType.DATA_RECORD_V2; +import static org.apache.ignite.internal.processors.cache.persistence.wal.FileWriteAheadLogManager.WAL_NAME_PATTERN; + +/** + * CDC(Capture Data Change) application. + * Application run independently of Ignite node process and provide ability for the {@link CaptureDataChangeConsumer} to consume events({@link ChangeEvent}) from WAL segments. + * User should responsible {@link CaptureDataChangeConsumer} implementation with custom consumption logic. + * + * Ignite node should be explicitly configured for using {@link IgniteCDC}. + * <ol> + * <li>Set {@link DataStorageConfiguration#setCdcEnabled(boolean)} to true.</li> + * <li>Optional: Set {@link DataStorageConfiguration#setCdcPath(String)} to path to the directory to store WAL segments for CDC.</li> + * <li>Optional: Set {@link DataStorageConfiguration#setWalForceArchiveTimeout(long)} to configure timeout for force WAL rollover, + * so new events will be available for consumptions with the predicted time.</li> + * </ol> + * + * When {@link DataStorageConfiguration#getCdcPath()} is true then Ignite node on each WAL segment rollover creates hard link + * to archive WAL segment in {@link DataStorageConfiguration#getCdcPath()} directory. + * {@link IgniteCDC} application takes segment file and consumes events from it. After successful consumption (see {@link CaptureDataChangeConsumer#onChange(Iterator)}) + * WAL segment will be deleted from directory. + * + * Several Ignite nodes can be started on the same host. + * If your deployment done with custom consistent id then you should specify it via {@link IgniteConfiguration#setConsistentId(Serializable)} in provided {@link IgniteConfiguration}. + * + * Application works as follows: + * <ol> + * <li>Search node work directory based on provided {@link IgniteConfiguration}.</li> + * <li>Await for creation of CDC directory if it not exists.</li> + * <li>Acquire file lock to ensure exclusive consumption.</li> + * <li>Loads state of consumption if it exists.</li> + * <li>Infinetely wait for new available segment and process it.</li> + * </ol> + * + * @see DataStorageConfiguration#setCdcEnabled(boolean) + * @see DataStorageConfiguration#setCdcPath(String) + * @see DataStorageConfiguration#setWalForceArchiveTimeout(long) + * @see CommandLineStartup + * @see CaptureDataChangeConsumer + * @see DataStorageConfiguration#DFLT_CDC_PATH + */ +public class IgniteCDC implements Runnable { + /** State dir. */ + public static final String STATE_DIR = "state"; + + /** Ignite configuration. */ + private final IgniteConfiguration cfg; + + /** CDC configuration. */ + private final CaptureDataChangeConfiguration cdcCfg; + + /** WAL iterator factory. */ + private final IgniteWalIteratorFactory factory; + + /** Events consumer. */ + private final WALRecordsConsumer<?, ?> consumer; + + /** Logger. */ + private final IgniteLogger log; + + /** CDC directory. */ + private Path cdcDir; + + /** Binary meta directory. */ + private File binaryMeta; + + /** Marshaller directory. */ + private File marshaller; + + /** CDC state. */ + private CDCConsumerState state; + + /** Save state to start from. */ + private WALPointer initState; + + /** Previous segments. */ + private final List<Path> prevSegments = new ArrayList<>(); + + /** + * @param cfg Ignite configuration. + * @param cdcCfg CDC configuration. + */ + public IgniteCDC(IgniteConfiguration cfg, CaptureDataChangeConfiguration cdcCfg) { + this.cfg = new IgniteConfiguration(cfg); + this.cdcCfg = cdcCfg; + + consumer = new WALRecordsConsumer<>(cdcCfg.getConsumer()); + + String workDir = workDir(cfg); + + if (this.cfg.getWorkDirectory() == null) + this.cfg.setWorkDirectory(workDir); + + log = logger(this.cfg); + factory = new IgniteWalIteratorFactory(log); + + if (!CU.isPersistenceEnabled(cfg)) { + log.error("Persistence disabled. IgniteCDC can't run!"); + + throw new IllegalArgumentException("Persistence disabled. IgniteCDC can't run!"); + } + } + + /** Runs CDC. */ + @Override public void run() { + try { + runX(); + } + catch (Throwable e) { + e.printStackTrace(); + + throw new RuntimeException(e); + } + } + + /** Runs CDC application with possible exception. */ + public void runX() throws Exception { + if (log.isInfoEnabled()) { + log.info("Starting Ignite CDC Application."); + log.info("Consumer -\t" + consumer.toString()); + log.info("ConsistentId -\t" + cfg.getConsistentId()); + } + + PdsFolderSettings<CDCFileLockHolder> settings = + new PdsFolderResolver<>(cfg, log, null, this::tryLock).resolve(); + + if (settings == null) + throw new RuntimeException("Can't find PDS folder!"); + + CDCFileLockHolder lock = settings.getLockedFileLockHolder(); + + if (lock == null) { + File consIdDir = new File(settings.persistentStoreRootPath(), settings.folderName()); + + lock = tryLock(consIdDir); + + if (lock == null) + throw new RuntimeException("Can't lock CDC dir " + settings.consistentId()); + } + + try { + init(); + + if (log.isInfoEnabled()) { + log.info("CDC dir -\t" + cdcDir); + log.info("Binary meta -\t" + binaryMeta); + log.info("Marshaller -\t" + marshaller); + log.info("--------------------------------"); + } + + state = new CDCConsumerState(cdcDir.resolve(STATE_DIR), "cdc-state.bin"); + + initState = state.load(); + + if (initState != null && log.isInfoEnabled()) + log.info("Loaded initial state[state=" + initState + ']'); + + consumer.start(cfg, log); + + try { + Predicate<Path> walFilesOnly = p -> WAL_NAME_PATTERN.matcher(p.getFileName().toString()).matches(); + + Comparator<Path> sortByNumber = Comparator.comparingLong(this::segmentIndex); + + long[] lastSgmnt = new long[] { -1 }; + + waitFor(cdcDir, walFilesOnly, sortByNumber, segment -> { + try { + long nextSgmnt = segmentIndex(segment); + + assert lastSgmnt[0] == -1 || nextSgmnt - lastSgmnt[0] == 1; + + lastSgmnt[0] = nextSgmnt; + + readSegment(segment); + + return true; + } + catch (IgniteCheckedException | IOException e) { + throw new IgniteException(e); + } + }, cdcCfg.getSleepBeforeCheckNewSegmentsTimeout(), log); + } + finally { + consumer.stop(); + + if (log.isInfoEnabled()) + log.info("Ignite CDC Application stoped."); + } + } + finally { + U.closeQuiet(lock); + } + } + + /** Searches required directories. */ + private void init() throws IOException { + String consIdDir = cdcDir.getName(cdcDir.getNameCount() - 1).toString(); + + Files.createDirectories(cdcDir.resolve(STATE_DIR)); + + binaryMeta = CacheObjectBinaryProcessorImpl.binaryWorkDir(cfg.getWorkDirectory(), consIdDir); + + marshaller = MarshallerContextImpl.mappingFileStoreWorkDir(cfg.getWorkDirectory()); + + if (log.isDebugEnabled()) { + log.debug("Using BinaryMeta directory[dir=" + binaryMeta + ']'); + log.debug("Using Marshaller directory[dir=" + marshaller + ']'); + } + } + + /** Reads all available records from segment. */ + private void readSegment(Path segment) throws IgniteCheckedException, IOException { + log.info("Processing WAL segment[segment=" + segment + ']'); + + IgniteWalIteratorFactory.IteratorParametersBuilder builder = new IgniteWalIteratorFactory.IteratorParametersBuilder() + .log(log) + .binaryMetadataFileStoreDir(binaryMeta) + .marshallerMappingFileStoreDir(marshaller) + .keepBinary(cdcCfg.isKeepBinary()) + .filesOrDirs(segment.toFile()) + .addFilter((type, ptr) -> type == DATA_RECORD_V2); + + if (initState != null) { + long segmentIdx = segmentIndex(segment); + + if (segmentIdx > initState.index()) { + log.error("Found segment greater then saved state. Some events are missed. Exiting!" + + "[state=" + initState + ",segment=" + segmentIdx + ']'); + + throw new IgniteException("Some data missed."); + } + else if (segmentIdx < initState.index()) { + if (log.isInfoEnabled()) { + log.info("Deleting segment. Saved state has greater index.[segment=" + + segmentIdx + ",state=" + initState.index() + ']'); + } + + // WAL segment is a hard link to a segment file in the special CDC folder. + // So, we can safely delete it after processing. + Files.delete(segment); + } + else { + builder.from(initState); + + initState = null; + } + } + + try (WALIterator it = factory.iterator(builder)) { + while (it.hasNext()) { + boolean commit = consumer.onRecords(F.iterator(it.iterator(), IgniteBiTuple::get2, true)); + + if (commit) { + assert it.lastRead().isPresent(); + + state.save(it.lastRead().get()); + + // Can delete after new file state save. + if (!prevSegments.isEmpty()) { + // WAL segment is a hard link to a segment file in a specifal CDC folder. + // So we can safely delete it after success processing. + for (Path prevSegment : prevSegments) + Files.deleteIfExists(prevSegment); + + prevSegments.clear(); + } + } + } + } + + prevSegments.add(segment); + } + + /** + * Try locks CDC directory. + * + * @param dbStoreDirWithSubdirectory Root PDS directory. + * @return Lock or null if lock failed. + */ + private CDCFileLockHolder tryLock(File dbStoreDirWithSubdirectory) { + if (!dbStoreDirWithSubdirectory.exists()) { + log.warning(dbStoreDirWithSubdirectory + " not exists."); + + return null; + } + + File cdcRoot = new File(cfg.getDataStorageConfiguration().getCdcPath()); + + if (!cdcRoot.isAbsolute()) + cdcRoot = new File(cfg.getWorkDirectory(), cfg.getDataStorageConfiguration().getCdcPath()); + + if (!cdcRoot.exists()) { + log.warning(cdcRoot + " not exists."); + + return null; + } + + cdcDir = Paths.get(cdcRoot.getAbsolutePath(), dbStoreDirWithSubdirectory.getName()); + + if (!Files.exists(cdcDir)) { + log.warning(cdcDir + " not exists."); + + return null; + } + + CDCFileLockHolder lock = new CDCFileLockHolder(cdcDir.toString(), () -> "cdc.lock", log); + + try { + lock.tryLock(cdcCfg.getLockTimeout()); + + return lock; + } + catch (IgniteCheckedException e) { + U.closeQuiet(lock); + + if (log.isInfoEnabled()) + log.info("Unable to acquire lock to file [" + cdcRoot + "], reason: " + e.getMessage()); + + return null; + } + } + + /** + * Initialize logger. + * + * @param cfg Configuration. + */ + private static IgniteLogger logger(IgniteConfiguration cfg) { + try { + return IgnitionEx.IgniteNamedInstance.initLogger(cfg.getGridLogger(), null, "cdc", cfg.getWorkDirectory()); + } + catch (IgniteCheckedException e) { + throw new IgniteException(e); + } + } + + /** + * Resolves work directory. + * + * @return Working directory + */ + private static String workDir(IgniteConfiguration cfg) { + try { + String igniteHome = cfg.getIgniteHome(); + + // Set Ignite home. + if (igniteHome == null) + igniteHome = U.getIgniteHome(); + else + // If user provided IGNITE_HOME - set it as a system property. + U.setIgniteHome(igniteHome); + + String userProvidedWorkDir = cfg.getWorkDirectory(); + + // Correctly resolve work directory and set it back to configuration. + return U.workDirectory(userProvidedWorkDir, igniteHome); + } + catch (IgniteCheckedException e) { + throw new IgniteException(e); + } + } + + /** + * @param segment WAL segment file. + * @return Segment index. + */ + public long segmentIndex(Path segment) { + String fn = segment.getFileName().toString(); + + return Long.parseLong(fn.substring(0, fn.indexOf('.'))); + } + + /** + * Waits for the files or directories to be created insied {@code watchDir} + * and if new file pass the {@code filter} then {@code callback} notified with the newly create file. + * {@code callback} will allso be notified about already existing files that passes the filter. + * + * @param watchDir Directory to watch. + * @param filter Filter of events. + * @param sorter Sorter of files. + * @param callback Callback to be notified. + */ + @SuppressWarnings("BusyWait") + public static void waitFor(Path watchDir, Predicate<Path> filter, Comparator<Path> sorter, + Predicate<Path> callback, long timeout, IgniteLogger log) throws InterruptedException { + // If watch dir not exists waiting for it creation. + if (!Files.exists(watchDir)) + waitFor(watchDir.getParent(), watchDir::equals, Path::compareTo, p -> false, timeout, log); + + try { + // Clear deleted file. + Set<Path> seen = new HashSet<>(); + + while (true) { + try (Stream<Path> children = Files.walk(watchDir, 1).filter(p -> !p.equals(watchDir))) { + final boolean[] status = {true}; + + children + .filter(filter.and(p -> !seen.contains(p))) + .sorted(sorter) + .peek(seen::add) + .peek(p -> { + if (log.isDebugEnabled()) + log.debug("New file[evt=" + p.toAbsolutePath() + ']'); + + if (status[0]) + status[0] = callback.test(p); + }).count(); + + if (!status[0]) + return; + } + + Thread.sleep(timeout); Review comment: I think `U.sleep()` is a better candidate for usage here since it is removed the `interrupted` thread state; -- 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. For queries about this service, please contact Infrastructure at: [email protected]
