You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jira@kafka.apache.org by "showuon (via GitHub)" <gi...@apache.org> on 2023/02/19 05:08:42 UTC
[GitHub] [kafka] showuon commented on a diff in pull request #13275: KAFKA-14522 Rewrite/Move of RemoteIndexCache to storage module.
showuon commented on code in PR #13275:
URL: https://github.com/apache/kafka/pull/13275#discussion_r1111157501
##########
storage/src/main/java/org/apache/kafka/storage/internals/log/RemoteIndexCache.java:
##########
@@ -0,0 +1,398 @@
+/*
+ * 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.kafka.storage.internals.log;
+
+
+import org.apache.kafka.common.KafkaException;
+import org.apache.kafka.common.Uuid;
+import org.apache.kafka.common.errors.CorruptRecordException;
+import org.apache.kafka.common.utils.Utils;
+import org.apache.kafka.server.log.remote.storage.RemoteLogSegmentMetadata;
+import org.apache.kafka.server.log.remote.storage.RemoteStorageException;
+import org.apache.kafka.server.log.remote.storage.RemoteStorageManager;
+import org.apache.kafka.server.log.remote.storage.RemoteStorageManager.IndexType;
+import org.apache.kafka.server.util.ShutdownableThread;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.io.Closeable;
+import java.io.File;
+import java.io.IOException;
+import java.io.InputStream;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.LinkedHashMap;
+import java.util.Map;
+import java.util.concurrent.LinkedBlockingQueue;
+import java.util.concurrent.locks.ReentrantReadWriteLock;
+import java.util.function.Function;
+import java.util.stream.Stream;
+
+import static org.apache.kafka.storage.internals.log.LogFileUtils.INDEX_FILE_SUFFIX;
+import static org.apache.kafka.storage.internals.log.LogFileUtils.TIME_INDEX_FILE_SUFFIX;
+import static org.apache.kafka.storage.internals.log.LogFileUtils.TXN_INDEX_FILE_SUFFIX;
+
+/**
+ * This is a LRU cache of remote index files stored in `$logdir/remote-log-index-cache`. This is helpful to avoid
+ * re-fetching the index files like offset, time indexes from the remote storage for every fetch call.
+ */
+public class RemoteIndexCache implements Closeable {
+
+ private final Logger log = LoggerFactory.getLogger(RemoteIndexCache.class);
+
+ public static final String DIR_NAME = "remote-log-index-cache";
+
+ // All the below suffixes will be replaced with UnifiedLog once it is moved to storage module.
+ private static final String TMP_FILE_SUFFIX = ".tmp";
+
+ private final File cacheDir;
+ private final LinkedBlockingQueue<Entry> expiredIndexes = new LinkedBlockingQueue<>();
+ private final Object lock = new Object();
+ private final RemoteStorageManager remoteStorageManager;
+ private final Map<Uuid, Entry> entries;
+ private final ShutdownableThread cleanerThread;
+
+ private volatile boolean closed = false;
+
+ public RemoteIndexCache(RemoteStorageManager remoteStorageManager, String logDir) throws IOException {
+ this(1024, remoteStorageManager, logDir);
+ }
+
+ /**
+ * Created RemoteIndexCache with the given configs.
+ *
+ * @param maxSize maximum number of segment index entries to be cached.
+ * @param remoteStorageManager RemoteStorageManager instance, to be used in fetching indexes.
+ * @param logDir log directory
+ */
+ public RemoteIndexCache(int maxSize, RemoteStorageManager remoteStorageManager, String logDir) throws IOException {
+ this.remoteStorageManager = remoteStorageManager;
+ cacheDir = new File(logDir, DIR_NAME);
+
+ entries = new LinkedHashMap<Uuid, RemoteIndexCache.Entry>(maxSize, 0.75f, true) {
+ @Override
+ protected boolean removeEldestEntry(Map.Entry<Uuid, RemoteIndexCache.Entry> eldest) {
+ if (this.size() > maxSize) {
+ RemoteIndexCache.Entry entry = eldest.getValue();
+ // Mark the entries for cleanup, background thread will clean them later.
+ try {
+ entry.markForCleanup();
+ } catch (IOException e) {
+ throw new KafkaException(e);
+ }
+ expiredIndexes.add(entry);
+ return true;
+ } else {
+ return false;
+ }
+ }
+ };
+
+ init();
+
+ // Start cleaner thread that will clean the expired entries.
+ cleanerThread = createCLeanerThread();
+ cleanerThread.start();
+ }
+
+ private ShutdownableThread createCLeanerThread() {
+ ShutdownableThread thread = new ShutdownableThread("remote-log-index-cleaner") {
+ public void doWork() {
+ while (!closed) {
+ try {
+ Entry entry = expiredIndexes.take();
+ log.info("Cleaning up index entry $entry");
+ entry.cleanup();
+ } catch (InterruptedException ex) {
+ log.info("Cleaner thread was interrupted", ex);
+ } catch (Exception ex) {
+ log.error("Error occurred while fetching/cleaning up expired entry", ex);
+ }
+ }
+ }
+ };
+ thread.setDaemon(true);
+
+ return thread;
+ }
+
+ private void init() throws IOException {
+ if (cacheDir.mkdir())
+ log.info("Created Cache dir [{}] successfully", cacheDir);
+
+ // Delete any .deleted files remained from the earlier run of the broker.
+ try (Stream<Path> paths = Files.list(cacheDir.toPath())) {
+ paths.forEach(path -> {
+ if (path.endsWith(LogFileUtils.DELETED_FILE_SUFFIX)) {
+ try {
+ Files.deleteIfExists(path);
+ } catch (IOException e) {
+ throw new KafkaException(e);
+ }
+ }
+ });
+ }
+
+ try (Stream<Path> paths = Files.list(cacheDir.toPath())) {
+ paths.forEach(path -> {
+
+ String pathStr = path.getFileName().toString();
+ String name = pathStr.substring(0, pathStr.lastIndexOf("_") + 1);
+
+ // Create entries for each path if all the index files exist.
+ int firstIndex = name.indexOf('_');
+ int offset = Integer.parseInt(name.substring(0, firstIndex));
+ Uuid uuid = Uuid.fromString(name.substring(firstIndex + 1, name.lastIndexOf('_')));
+
+ if (!entries.containsKey(uuid)) {
+ File offsetIndexFile = new File(cacheDir, name + INDEX_FILE_SUFFIX);
+ File timestampIndexFile = new File(cacheDir, name + TIME_INDEX_FILE_SUFFIX);
+ File txnIndexFile = new File(cacheDir, name + TXN_INDEX_FILE_SUFFIX);
+
+ try {
+ if (offsetIndexFile.exists() && timestampIndexFile.exists() && txnIndexFile.exists()) {
+
+ OffsetIndex offsetIndex = new OffsetIndex(offsetIndexFile, offset, Integer.MAX_VALUE, false);
+ offsetIndex.sanityCheck();
+
+ TimeIndex timeIndex = new TimeIndex(timestampIndexFile, offset, Integer.MAX_VALUE, false);
+ timeIndex.sanityCheck();
+
+ TransactionIndex txnIndex = new TransactionIndex(offset, txnIndexFile);
+ txnIndex.sanityCheck();
+
+ Entry entry = new Entry(offsetIndex, timeIndex, txnIndex);
+ entries.put(uuid, entry);
+ } else {
+ // Delete all of them if any one of those indexes is not available for a specific segment id
+ Files.deleteIfExists(offsetIndexFile.toPath());
+ Files.deleteIfExists(timestampIndexFile.toPath());
+ Files.deleteIfExists(txnIndexFile.toPath());
Review Comment:
Should we use `LogFileUtils.tryAll(Arrays.asList(() -> {}` to make sure each index is deleted?
##########
storage/src/main/java/org/apache/kafka/storage/internals/log/RemoteIndexCache.java:
##########
@@ -0,0 +1,398 @@
+/*
+ * 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.kafka.storage.internals.log;
+
+
+import org.apache.kafka.common.KafkaException;
+import org.apache.kafka.common.Uuid;
+import org.apache.kafka.common.errors.CorruptRecordException;
+import org.apache.kafka.common.utils.Utils;
+import org.apache.kafka.server.log.remote.storage.RemoteLogSegmentMetadata;
+import org.apache.kafka.server.log.remote.storage.RemoteStorageException;
+import org.apache.kafka.server.log.remote.storage.RemoteStorageManager;
+import org.apache.kafka.server.log.remote.storage.RemoteStorageManager.IndexType;
+import org.apache.kafka.server.util.ShutdownableThread;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.io.Closeable;
+import java.io.File;
+import java.io.IOException;
+import java.io.InputStream;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.LinkedHashMap;
+import java.util.Map;
+import java.util.concurrent.LinkedBlockingQueue;
+import java.util.concurrent.locks.ReentrantReadWriteLock;
+import java.util.function.Function;
+import java.util.stream.Stream;
+
+import static org.apache.kafka.storage.internals.log.LogFileUtils.INDEX_FILE_SUFFIX;
+import static org.apache.kafka.storage.internals.log.LogFileUtils.TIME_INDEX_FILE_SUFFIX;
+import static org.apache.kafka.storage.internals.log.LogFileUtils.TXN_INDEX_FILE_SUFFIX;
+
+/**
+ * This is a LRU cache of remote index files stored in `$logdir/remote-log-index-cache`. This is helpful to avoid
+ * re-fetching the index files like offset, time indexes from the remote storage for every fetch call.
+ */
+public class RemoteIndexCache implements Closeable {
+
+ private final Logger log = LoggerFactory.getLogger(RemoteIndexCache.class);
+
+ public static final String DIR_NAME = "remote-log-index-cache";
+
+ // All the below suffixes will be replaced with UnifiedLog once it is moved to storage module.
+ private static final String TMP_FILE_SUFFIX = ".tmp";
Review Comment:
Do you think this comment should be created as another JIRA ticket, instead of putting in the comment?
--
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.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org