You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@ignite.apache.org by GitBox <gi...@apache.org> on 2021/05/20 14:57:39 UTC
[GitHub] [ignite] anton-vinogradov commented on a change in pull request #8909: IGNITE-13581 Capture Data Change implementation
anton-vinogradov commented on a change in pull request #8909:
URL: https://github.com/apache/ignite/pull/8909#discussion_r636079325
##########
File path: bin/ignite-cdc.sh
##########
@@ -0,0 +1,27 @@
+#!/usr/bin/env bash
+
+#
+# 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.
+#
+
+export MAIN_CLASS="org.apache.ignite.internal.cdc.CommandLineStartup"
+
+if [ "${IGNITE_HOME:-}" = "" ];
+ then IGNITE_HOME_TMP="$(dirname "$(cd "$(dirname "$0")"; "pwd")")";
+ else IGNITE_HOME_TMP=${IGNITE_HOME};
+fi
Review comment:
any reason for this calculation since it located in the same folder?
##########
File path: bin/ignite-cdc.sh
##########
@@ -0,0 +1,27 @@
+#!/usr/bin/env bash
+
+#
+# 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.
+#
+
+export MAIN_CLASS="org.apache.ignite.internal.cdc.CommandLineStartup"
Review comment:
Let's relocate to `org.apache.ignite.startup.cmdline` package, to keep this similar.
##########
File path: modules/core/src/main/java/org/apache/ignite/cdc/CaptureDataChangeConfiguration.java
##########
@@ -0,0 +1,93 @@
+/*
+ * 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.cdc;
+
+import org.apache.ignite.configuration.DataStorageConfiguration;
+import org.apache.ignite.internal.cdc.IgniteCDC;
+import org.apache.ignite.lang.IgniteExperimental;
+
+/**
+ * This class defines {@link IgniteCDC} runtime configuration.
+ * This configuration is passed to {@link IgniteCDC} constructor.
+ * It defines all configuration
+ */
+@IgniteExperimental
+public class CaptureDataChangeConfiguration {
+ /** Capture Data Change consumer. */
+ private CaptureDataChangeConsumer consumer;
+
+ /** Keep binary flag.<br>Default value {@code true}. */
+ private boolean keepBinary = true;
+
+ /**
+ * {@link IgniteCDC} acquire file lock on startup to ensure exclusive consumption.
+ * This property specifies amount of time to wait for lock acquisition.<br>
+ * Default is {@code 1000 ms}.
+ */
+ private long lockTimeout = 1000;
+
+ /**
+ * CDC application periodically scans {@link DataStorageConfiguration#getCdcPath()} folder to find new WAL segments.
+ * This timeout specify amount of time application sleeps between subsequent checks when no new files available.<br>
+ * Default is {@code 1000 ms}.
+ */
+ private long sleepBeforeCheckNewSegmentsTimeout = 1000;
+
+ /** @return CDC consumer. */
+ public CaptureDataChangeConsumer getConsumer() {
+ return consumer;
+ }
+
+ /** @param consumer CDC consumer. */
+ public void setConsumer(CaptureDataChangeConsumer consumer) {
Review comment:
according to https://cwiki.apache.org/confluence/display/IGNITE/Coding+Guidelines#CodingGuidelines-Gettersandsetters
`Getters and setters should be implemented without is/get/set prefixes in *internal* APIs.
This API is public but are there any reason for this?
Seems, the class should be relocated and getters/setters refactored.
##########
File path: modules/core/src/main/java/org/apache/ignite/cdc/CaptureDataChangeConfiguration.java
##########
@@ -0,0 +1,93 @@
+/*
+ * 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.cdc;
+
+import org.apache.ignite.configuration.DataStorageConfiguration;
+import org.apache.ignite.internal.cdc.IgniteCDC;
+import org.apache.ignite.lang.IgniteExperimental;
+
+/**
+ * This class defines {@link IgniteCDC} runtime configuration.
+ * This configuration is passed to {@link IgniteCDC} constructor.
+ * It defines all configuration
+ */
+@IgniteExperimental
+public class CaptureDataChangeConfiguration {
+ /** Capture Data Change consumer. */
+ private CaptureDataChangeConsumer consumer;
+
+ /** Keep binary flag.<br>Default value {@code true}. */
+ private boolean keepBinary = true;
+
+ /**
+ * {@link IgniteCDC} acquire file lock on startup to ensure exclusive consumption.
+ * This property specifies amount of time to wait for lock acquisition.<br>
+ * Default is {@code 1000 ms}.
+ */
+ private long lockTimeout = 1000;
+
+ /**
+ * CDC application periodically scans {@link DataStorageConfiguration#getCdcPath()} folder to find new WAL segments.
+ * This timeout specify amount of time application sleeps between subsequent checks when no new files available.<br>
+ * Default is {@code 1000 ms}.
+ */
+ private long sleepBeforeCheckNewSegmentsTimeout = 1000;
Review comment:
the default must be set via const.
##########
File path: modules/core/src/main/java/org/apache/ignite/cdc/CaptureDataChangeConfiguration.java
##########
@@ -0,0 +1,93 @@
+/*
+ * 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.cdc;
+
+import org.apache.ignite.configuration.DataStorageConfiguration;
+import org.apache.ignite.internal.cdc.IgniteCDC;
+import org.apache.ignite.lang.IgniteExperimental;
+
+/**
+ * This class defines {@link IgniteCDC} runtime configuration.
+ * This configuration is passed to {@link IgniteCDC} constructor.
+ * It defines all configuration
+ */
+@IgniteExperimental
+public class CaptureDataChangeConfiguration {
Review comment:
change data capture
##########
File path: modules/core/src/main/java/org/apache/ignite/cdc/CaptureDataChangeConfiguration.java
##########
@@ -0,0 +1,93 @@
+/*
+ * 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.cdc;
+
+import org.apache.ignite.configuration.DataStorageConfiguration;
+import org.apache.ignite.internal.cdc.IgniteCDC;
+import org.apache.ignite.lang.IgniteExperimental;
+
+/**
+ * This class defines {@link IgniteCDC} runtime configuration.
+ * This configuration is passed to {@link IgniteCDC} constructor.
+ * It defines all configuration
+ */
+@IgniteExperimental
+public class CaptureDataChangeConfiguration {
+ /** Capture Data Change consumer. */
+ private CaptureDataChangeConsumer consumer;
+
+ /** Keep binary flag.<br>Default value {@code true}. */
+ private boolean keepBinary = true;
+
+ /**
+ * {@link IgniteCDC} acquire file lock on startup to ensure exclusive consumption.
+ * This property specifies amount of time to wait for lock acquisition.<br>
+ * Default is {@code 1000 ms}.
+ */
+ private long lockTimeout = 1000;
+
+ /**
+ * CDC application periodically scans {@link DataStorageConfiguration#getCdcPath()} folder to find new WAL segments.
+ * This timeout specify amount of time application sleeps between subsequent checks when no new files available.<br>
+ * Default is {@code 1000 ms}.
+ */
+ private long sleepBeforeCheckNewSegmentsTimeout = 1000;
+
+ /** @return CDC consumer. */
+ public CaptureDataChangeConsumer getConsumer() {
+ return consumer;
+ }
+
+ /** @param consumer CDC consumer. */
+ public void setConsumer(CaptureDataChangeConsumer consumer) {
+ this.consumer = consumer;
+ }
+
+ /** @return keep binary value. */
+ public boolean isKeepBinary() {
+ return keepBinary;
+ }
+
+ /** @param keepBinary keep binary value. */
+ public void setKeepBinary(boolean keepBinary) {
+ this.keepBinary = keepBinary;
+ }
+
+ /** @return Amount of time to wait for lock acquisition. */
+ public long getLockTimeout() {
+ return lockTimeout;
+ }
+
+ /** @param lockTimeout Amount of time to wait for lock acquisition. */
+ public void setLockTimeout(long lockTimeout) {
+ this.lockTimeout = lockTimeout;
+ }
+
+ /** @return Amount of time application sleeps between subsequent checks when no new files available. */
+ public long getSleepBeforeCheckNewSegmentsTimeout() {
+ return sleepBeforeCheckNewSegmentsTimeout;
Review comment:
Seems we also need/use some throttling feature at Ignite which will decrease throughput in case unread CDC files count bigger than XXX.
##########
File path: modules/core/src/main/java/org/apache/ignite/cdc/CaptureDataChangeConfiguration.java
##########
@@ -0,0 +1,93 @@
+/*
+ * 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.cdc;
+
+import org.apache.ignite.configuration.DataStorageConfiguration;
+import org.apache.ignite.internal.cdc.IgniteCDC;
+import org.apache.ignite.lang.IgniteExperimental;
+
+/**
+ * This class defines {@link IgniteCDC} runtime configuration.
+ * This configuration is passed to {@link IgniteCDC} constructor.
+ * It defines all configuration
+ */
+@IgniteExperimental
+public class CaptureDataChangeConfiguration {
+ /** Capture Data Change consumer. */
+ private CaptureDataChangeConsumer consumer;
+
+ /** Keep binary flag.<br>Default value {@code true}. */
+ private boolean keepBinary = true;
+
+ /**
+ * {@link IgniteCDC} acquire file lock on startup to ensure exclusive consumption.
+ * This property specifies amount of time to wait for lock acquisition.<br>
+ * Default is {@code 1000 ms}.
+ */
+ private long lockTimeout = 1000;
+
+ /**
+ * CDC application periodically scans {@link DataStorageConfiguration#getCdcPath()} folder to find new WAL segments.
+ * This timeout specify amount of time application sleeps between subsequent checks when no new files available.<br>
+ * Default is {@code 1000 ms}.
+ */
+ private long sleepBeforeCheckNewSegmentsTimeout = 1000;
+
+ /** @return CDC consumer. */
+ public CaptureDataChangeConsumer getConsumer() {
+ return consumer;
+ }
+
+ /** @param consumer CDC consumer. */
+ public void setConsumer(CaptureDataChangeConsumer consumer) {
+ this.consumer = consumer;
+ }
+
+ /** @return keep binary value. */
+ public boolean isKeepBinary() {
+ return keepBinary;
+ }
+
+ /** @param keepBinary keep binary value. */
+ public void setKeepBinary(boolean keepBinary) {
+ this.keepBinary = keepBinary;
+ }
+
+ /** @return Amount of time to wait for lock acquisition. */
+ public long getLockTimeout() {
+ return lockTimeout;
+ }
+
+ /** @param lockTimeout Amount of time to wait for lock acquisition. */
+ public void setLockTimeout(long lockTimeout) {
+ this.lockTimeout = lockTimeout;
+ }
+
+ /** @return Amount of time application sleeps between subsequent checks when no new files available. */
+ public long getSleepBeforeCheckNewSegmentsTimeout() {
Review comment:
checkFrequency?
##########
File path: modules/core/src/main/java/org/apache/ignite/internal/cdc/IgniteCDC.java
##########
@@ -0,0 +1,476 @@
+/*
+ * 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.UUID;
+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.IgniteInterruptedCheckedException;
+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";
+
+ /** Wal segments filter. */
+ private static final Predicate<Path> WAL_SEGMENTS_FILTER =
+ p -> WAL_NAME_PATTERN.matcher(p.getFileName().toString()).matches();
+
+ /** 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;
+
+ /** Stoped flag. */
+ private volatile boolean stoped;
+
+ /** 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());
+
+ initWorkDir(this.cfg);
+
+ 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() {
+ synchronized (this) {
+ if (stoped)
+ return;
+ }
+
+ 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));
+
+ initState = state.load();
+
+ if (initState != null && log.isInfoEnabled())
+ log.info("Loaded initial state[state=" + initState + ']');
+
+ consumer.start(log);
+
+ try {
+ consumeWalSegmentsUntilStoped();
+ }
+ 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 + ']');
+ }
+ }
+
+ /** Waits and consumes new WAL segments until stoped. */
+ public void consumeWalSegmentsUntilStoped() {
+ try {
+ Set<Path> seen = new HashSet<>();
+
+ long[] lastSgmnt = new long[] {-1};
+
+ while (!stoped) {
+ try (Stream<Path> cdcFiles = Files.walk(cdcDir, 1)) {
+ Set<Path> exists = new HashSet<>();
+
+ cdcFiles
+ .peek(exists::add) // Store files that exists in cdc dir.
+ .filter(WAL_SEGMENTS_FILTER.and(p -> !seen.contains(p))) // Need unseend WAL segments only.
+ .peek(seen::add) // Adds to seen.
+ .sorted(Comparator.comparingLong(this::segmentIndex)) // Sort by segment index.
+ .peek(p -> {
+ long nextSgmnt = segmentIndex(p);
+
+ assert lastSgmnt[0] == -1 || nextSgmnt - lastSgmnt[0] == 1;
+
+ lastSgmnt[0] = nextSgmnt;
+ })
+ .forEach(this::consumeSegment); // Consuming segments.
+
+ seen.removeIf(p -> !exists.contains(p)); // Clean up seen set.
+ }
+
+ if (!stoped)
+ U.sleep(cdcCfg.getSleepBeforeCheckNewSegmentsTimeout());
+ }
+ }
+ catch (IOException | IgniteInterruptedCheckedException e) {
+ throw new IgniteException(e);
+ }
+ }
+
+ /** Reads all available records from segment. */
+ private void consumeSegment(Path segment) {
+ if (log.isInfoEnabled())
+ 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.");
+ }
+
+ 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.
+ try {
+ Files.delete(segment);
+
+ return;
+ }
+ catch (IOException e) {
+ throw new IgniteException(e);
+ }
+ }
+
+ System.out.println("initState = " + initState);
+
+ 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();
+ }
+ }
+ }
+ } catch (IgniteCheckedException | IOException e) {
+ throw new IgniteException(e);
+ }
+
+ 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;
+ }
+
+ Path cdcDir = Paths.get(cdcRoot.getAbsolutePath(), dbStoreDirWithSubdirectory.getName());
+
+ if (!Files.exists(cdcDir)) {
+ log.warning(cdcDir + " not exists.");
+
+ return null;
+ }
+
+ this.cdcDir = cdcDir;
+
+ CDCFileLockHolder lock = new CDCFileLockHolder(cdcDir.toString(), () -> "cdc.lock", log);
+
+ try {
+ lock.tryLock(cdcCfg.getLockTimeout());
Review comment:
Any reason for this try and related param?
When instant locking is not an option?
##########
File path: modules/core/src/main/java/org/apache/ignite/cdc/ChangeEvent.java
##########
@@ -0,0 +1,65 @@
+/*
+ * 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.cdc;
+
+import java.io.Serializable;
+import org.apache.ignite.internal.cdc.IgniteCDC;
+import org.apache.ignite.lang.IgniteExperimental;
+import org.jetbrains.annotations.Nullable;
+
+/**
+ * Event of single entry change.
+ * Instance presents new value of modified entry.
+ *
+ * @see IgniteCDC
+ * @see CaptureDataChangeConsumer
+ */
+@IgniteExperimental
+public interface ChangeEvent extends Serializable {
+ /**
+ * @return Key for the changed entry.
+ */
+ public Object key();
+
+ /**
+ * @return Value for the changed entry or {@code null} in case of entry removal.
+ */
+ @Nullable public Object value();
+
+ /**
+ * @return {@code True} if event fired on primary node for partition containing this entry.
+ * @see <a href="https://ignite.apache.org/docs/latest/configuring-caches/configuring-backups#configuring-partition-backups">Configuring partition backups.</a>
+ */
+ public boolean primary();
+
+ /**
+ * @return Partition number.
+ */
+ public int partition();
+
+ /**
+ * @return Order of the update operation.
+ */
+ public ChangeEventOrder order();
+
+ /**
+ * @return Cache ID.
+ * @see org.apache.ignite.internal.util.typedef.internal.CU#cacheId(String)
+ */
+ public int cacheId();
Review comment:
should we provide ref to the cache configuration instead?
##########
File path: modules/core/src/main/java/org/apache/ignite/cdc/ChangeEvent.java
##########
@@ -0,0 +1,65 @@
+/*
+ * 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.cdc;
+
+import java.io.Serializable;
+import org.apache.ignite.internal.cdc.IgniteCDC;
+import org.apache.ignite.lang.IgniteExperimental;
+import org.jetbrains.annotations.Nullable;
+
+/**
+ * Event of single entry change.
+ * Instance presents new value of modified entry.
+ *
+ * @see IgniteCDC
+ * @see CaptureDataChangeConsumer
+ */
+@IgniteExperimental
+public interface ChangeEvent extends Serializable {
Review comment:
ChangeDataCaptureEvent or CacheEntryChange(d)Event?
##########
File path: modules/core/src/main/java/org/apache/ignite/cdc/CaptureDataChangeConsumer.java
##########
@@ -0,0 +1,66 @@
+/*
+ * 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.cdc;
+
+import java.util.Iterator;
+import org.apache.ignite.IgniteLogger;
+import org.apache.ignite.internal.cdc.IgniteCDC;
+import org.apache.ignite.lang.IgniteExperimental;
+
+/**
+ * Consumer of WAL data change events.
+ * This consumer will receive event of data changes during {@link IgniteCDC} application invocation.
+ * Lifecycle of consumer is the following:
+ * <ul>
+ * <li>Start of the consumer {@link #start(IgniteLogger)}.</li>
+ * <li>Notification of the consumer by the {@link #onChange(Iterator)} call.</li>
+ * <li>Stop of the consumer {@link #stop()}.</li>
+ * </ul>
+ *
+ * Note, consumption of the {@link ChangeEvent} will started from the last saved offset.
+ * Offset of consumptions is saved on the disk every time {@link #onChange(Iterator)} returns {@code true}.
+ *
+ * @see IgniteCDC
+ * @see ChangeEvent
+ * @see ChangeEventOrder
+ */
+@IgniteExperimental
+public interface CaptureDataChangeConsumer {
+ /**
+ * Starts the consumer.
+ *
+ * @param log Logger.
+ */
+ void start(IgniteLogger log);
+
+ /**
+ * Handles entry changes events.
+ * If this method return {@code true} then current offset will be stored and ongoing notifications after CDC application fail/restart
+ * will be started from it.
+ *
+ * @param events Entry change events.
+ * @return {@code True} if current offset should be saved on the disk to continue from it in case any failures or restart.
+ */
+ boolean onChange(Iterator<ChangeEvent> events);
+
+ /**
+ * Stops the consumer.
+ * This methods can be invoked only after {@link #start(IgniteLogger)}.
+ */
+ void stop();
Review comment:
The keyword "public" is optional for interface methods, but according to Apache Ignite code Guidelines "public" must be present.
##########
File path: modules/core/src/main/java/org/apache/ignite/cdc/CaptureDataChangeConfiguration.java
##########
@@ -0,0 +1,93 @@
+/*
+ * 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.cdc;
+
+import org.apache.ignite.configuration.DataStorageConfiguration;
+import org.apache.ignite.internal.cdc.IgniteCDC;
+import org.apache.ignite.lang.IgniteExperimental;
+
+/**
+ * This class defines {@link IgniteCDC} runtime configuration.
+ * This configuration is passed to {@link IgniteCDC} constructor.
+ * It defines all configuration
+ */
+@IgniteExperimental
+public class CaptureDataChangeConfiguration {
+ /** Capture Data Change consumer. */
+ private CaptureDataChangeConsumer consumer;
+
+ /** Keep binary flag.<br>Default value {@code true}. */
+ private boolean keepBinary = true;
+
+ /**
+ * {@link IgniteCDC} acquire file lock on startup to ensure exclusive consumption.
+ * This property specifies amount of time to wait for lock acquisition.<br>
+ * Default is {@code 1000 ms}.
+ */
+ private long lockTimeout = 1000;
Review comment:
the default must be set via const.
##########
File path: modules/core/src/main/java/org/apache/ignite/cdc/ChangeEvent.java
##########
@@ -0,0 +1,65 @@
+/*
+ * 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.cdc;
+
+import java.io.Serializable;
+import org.apache.ignite.internal.cdc.IgniteCDC;
+import org.apache.ignite.lang.IgniteExperimental;
+import org.jetbrains.annotations.Nullable;
+
+/**
+ * Event of single entry change.
+ * Instance presents new value of modified entry.
+ *
+ * @see IgniteCDC
+ * @see CaptureDataChangeConsumer
+ */
+@IgniteExperimental
+public interface ChangeEvent extends Serializable {
+ /**
+ * @return Key for the changed entry.
+ */
+ public Object key();
+
+ /**
+ * @return Value for the changed entry or {@code null} in case of entry removal.
+ */
+ @Nullable public Object value();
+
+ /**
+ * @return {@code True} if event fired on primary node for partition containing this entry.
+ * @see <a href="https://ignite.apache.org/docs/latest/configuring-caches/configuring-backups#configuring-partition-backups">Configuring partition backups.</a>
+ */
+ public boolean primary();
+
+ /**
+ * @return Partition number.
+ */
+ public int partition();
+
+ /**
+ * @return Order of the update operation.
+ */
+ public ChangeEventOrder order();
Review comment:
has no usages and not sufficiently clear :(
##########
File path: modules/core/src/main/java/org/apache/ignite/cdc/CaptureDataChangeConsumer.java
##########
@@ -0,0 +1,66 @@
+/*
+ * 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.cdc;
+
+import java.util.Iterator;
+import org.apache.ignite.IgniteLogger;
+import org.apache.ignite.internal.cdc.IgniteCDC;
+import org.apache.ignite.lang.IgniteExperimental;
+
+/**
+ * Consumer of WAL data change events.
+ * This consumer will receive event of data changes during {@link IgniteCDC} application invocation.
+ * Lifecycle of consumer is the following:
+ * <ul>
+ * <li>Start of the consumer {@link #start(IgniteLogger)}.</li>
+ * <li>Notification of the consumer by the {@link #onChange(Iterator)} call.</li>
+ * <li>Stop of the consumer {@link #stop()}.</li>
+ * </ul>
+ *
+ * Note, consumption of the {@link ChangeEvent} will started from the last saved offset.
+ * Offset of consumptions is saved on the disk every time {@link #onChange(Iterator)} returns {@code true}.
+ *
+ * @see IgniteCDC
+ * @see ChangeEvent
+ * @see ChangeEventOrder
+ */
+@IgniteExperimental
+public interface CaptureDataChangeConsumer {
+ /**
+ * Starts the consumer.
+ *
+ * @param log Logger.
+ */
+ void start(IgniteLogger log);
Review comment:
LoggerResource annotation should be used instead
--
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:
users@infra.apache.org