Author: mduerig
Date: Mon Mar 2 22:16:13 2015
New Revision: 1663448
URL: http://svn.apache.org/r1663448
Log:
OAK-2552: Implement MBean monitoring garbage collection
Remove dependency from FileStore to Whiteboard and rather pass the GCMonitor
instance to the FileStore directly
Added:
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/segment/GCMonitorTracker.java
Modified:
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/segment/SegmentNodeStoreService.java
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/segment/file/FileStore.java
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/gc/GCMonitor.java
jackrabbit/oak/trunk/oak-jcr/src/main/java/org/apache/jackrabbit/oak/jcr/repository/RepositoryImpl.java
jackrabbit/oak/trunk/oak-jcr/src/test/java/org/apache/jackrabbit/oak/jcr/RefreshOnGCTest.java
Added:
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/segment/GCMonitorTracker.java
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/segment/GCMonitorTracker.java?rev=1663448&view=auto
==============================================================================
---
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/segment/GCMonitorTracker.java
(added)
+++
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/segment/GCMonitorTracker.java
Mon Mar 2 22:16:13 2015
@@ -0,0 +1,76 @@
+/*
+ * 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.jackrabbit.oak.plugins.segment;
+
+import org.apache.jackrabbit.oak.spi.gc.GCMonitor;
+import org.apache.jackrabbit.oak.spi.whiteboard.AbstractServiceTracker;
+import org.apache.jackrabbit.oak.spi.whiteboard.Whiteboard;
+
+/**
+ * This {@link GCMonitor} implementation tracks {@code GCMonitor} instances
registered
+ * to the {@link Whiteboard} delegating all calls to to those.
+ */
+public class GCMonitorTracker extends AbstractServiceTracker<GCMonitor>
implements GCMonitor {
+ public GCMonitorTracker() {
+ super(GCMonitor.class);
+ }
+
+ @Override
+ public void info(String message, Object... arguments) {
+ for (GCMonitor gcMonitor : getServices()) {
+ gcMonitor.info(message, arguments);
+ }
+ }
+
+ @Override
+ public void warn(String message, Object... arguments) {
+ for (GCMonitor gcMonitor : getServices()) {
+ gcMonitor.warn(message, arguments);
+ }
+ }
+
+ @Override
+ public void error(String message, Exception e) {
+ for (GCMonitor gcMonitor : getServices()) {
+ gcMonitor.error(message, e);
+ }
+ }
+
+ @Override
+ public void skipped(String message, Object... arguments) {
+ for (GCMonitor gcMonitor : getServices()) {
+ gcMonitor.skipped(message, arguments);
+ }
+ }
+
+ @Override
+ public void compacted() {
+ for (GCMonitor gcMonitor : getServices()) {
+ gcMonitor.compacted();
+ }
+ }
+
+ @Override
+ public void cleaned(long reclaimedSize, long currentSize) {
+ for (GCMonitor gcMonitor : getServices()) {
+ gcMonitor.cleaned(reclaimedSize, currentSize);
+ }
+ }
+}
Modified:
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/segment/SegmentNodeStoreService.java
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/segment/SegmentNodeStoreService.java?rev=1663448&r1=1663447&r2=1663448&view=diff
==============================================================================
---
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/segment/SegmentNodeStoreService.java
(original)
+++
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/segment/SegmentNodeStoreService.java
Mon Mar 2 22:16:13 2015
@@ -135,6 +135,8 @@ public class SegmentNodeStoreService ext
private ObserverTracker observerTracker;
+ private GCMonitorTracker gcMonitor;
+
private ComponentContext context;
@Reference(cardinality = ReferenceCardinality.OPTIONAL_UNARY,
@@ -243,11 +245,13 @@ public class SegmentNodeStoreService ext
};
OsgiWhiteboard whiteboard = new
OsgiWhiteboard(context.getBundleContext());
+ gcMonitor = new GCMonitorTracker();
+ gcMonitor.start(whiteboard);
Builder storeBuilder = FileStore.newFileStore(new File(directory))
.withCacheSize(Integer.parseInt(cache))
.withMaxFileSize(Integer.parseInt(size))
.withMemoryMapping("64".equals(mode))
- .withWhiteBoard(whiteboard);
+ .withGCMonitor(gcMonitor);
if (customBlobStore) {
log.info("Initializing SegmentNodeStore with BlobStore [{}]",
blobStore);
store = storeBuilder.withBlobStore(blobStore).create()
@@ -329,6 +333,7 @@ public class SegmentNodeStoreService ext
unregisterNodeStore();
observerTracker.stop();
+ gcMonitor.stop();
delegate = null;
store.close();
Modified:
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/segment/file/FileStore.java
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/segment/file/FileStore.java?rev=1663448&r1=1663447&r2=1663448&view=diff
==============================================================================
---
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/segment/file/FileStore.java
(original)
+++
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/segment/file/FileStore.java
Mon Mar 2 22:16:13 2015
@@ -73,8 +73,6 @@ import org.apache.jackrabbit.oak.spi.blo
import org.apache.jackrabbit.oak.spi.gc.GCMonitor;
import org.apache.jackrabbit.oak.spi.state.NodeBuilder;
import org.apache.jackrabbit.oak.spi.state.NodeState;
-import org.apache.jackrabbit.oak.spi.whiteboard.AbstractServiceTracker;
-import org.apache.jackrabbit.oak.spi.whiteboard.Whiteboard;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@@ -161,7 +159,11 @@ public class FileStore implements Segmen
* Version of the segment storage format.
*/
private final SegmentVersion version = SegmentVersion.V_11;
- private final GCMonitorTracker gcMonitor = new GCMonitorTracker();
+
+ /**
+ * {@code GCMonitor} monitoring this instance's gc progress
+ */
+ private final GCMonitor gcMonitor;
/**
* Create a new instance of a {@link Builder} for a file store.
@@ -183,7 +185,7 @@ public class FileStore implements Segmen
private int maxFileSize = 256;
private int cacheSize; // 0 -> DEFAULT_MEMORY_CACHE_SIZE
private boolean memoryMapping;
- private Whiteboard whiteboard;
+ private final LoggingGCMonitor gcMonitor = new LoggingGCMonitor();
private Builder(File directory) {
this.directory = directory;
@@ -255,13 +257,13 @@ public class FileStore implements Segmen
}
/**
- * {@link Whiteboard} used to track {@link GCMonitor} instances.
- * @param whiteboard
+ * {@link GCMonitor} for monitoring this files store's gc process.
+ * @param gcMonitor
* @return this instance
*/
@Nonnull
- public Builder withWhiteBoard(@Nonnull Whiteboard whiteboard) {
- this.whiteboard = checkNotNull(whiteboard);
+ public Builder withGCMonitor(@Nonnull GCMonitor gcMonitor) {
+ this.gcMonitor.delegatee = checkNotNull(gcMonitor);
return this;
}
@@ -284,14 +286,14 @@ public class FileStore implements Segmen
@Nonnull
public FileStore create() throws IOException {
return new FileStore(
- blobStore, directory, root, maxFileSize, cacheSize,
memoryMapping, whiteboard);
+ blobStore, directory, root, maxFileSize, cacheSize,
memoryMapping, gcMonitor);
}
}
@Deprecated
public FileStore(BlobStore blobStore, File directory, int maxFileSizeMB,
boolean memoryMapping)
throws IOException {
- this(blobStore, directory, EMPTY_NODE, maxFileSizeMB, 0,
memoryMapping, null);
+ this(blobStore, directory, EMPTY_NODE, maxFileSizeMB, 0,
memoryMapping, GCMonitor.EMPTY);
}
@Deprecated
@@ -309,24 +311,24 @@ public class FileStore implements Segmen
@Deprecated
public FileStore(File directory, int maxFileSizeMB, int cacheSizeMB,
boolean memoryMapping) throws IOException {
- this(null, directory, EMPTY_NODE, maxFileSizeMB, cacheSizeMB,
memoryMapping, null);
+ this(null, directory, EMPTY_NODE, maxFileSizeMB, cacheSizeMB,
memoryMapping, GCMonitor.EMPTY);
}
@Deprecated
FileStore(File directory, NodeState initial, int maxFileSize) throws
IOException {
- this(null, directory, initial, maxFileSize, -1,
MEMORY_MAPPING_DEFAULT, null);
+ this(null, directory, initial, maxFileSize, -1,
MEMORY_MAPPING_DEFAULT, GCMonitor.EMPTY);
}
@Deprecated
public FileStore(
BlobStore blobStore, final File directory, NodeState initial, int
maxFileSizeMB,
int cacheSizeMB, boolean memoryMapping) throws IOException {
- this(blobStore, directory, initial, maxFileSizeMB, cacheSizeMB,
memoryMapping, null);
+ this(blobStore, directory, initial, maxFileSizeMB, cacheSizeMB,
memoryMapping, GCMonitor.EMPTY);
}
private FileStore(
BlobStore blobStore, final File directory, NodeState initial, int
maxFileSizeMB,
- int cacheSizeMB, boolean memoryMapping, Whiteboard whiteboard)
+ int cacheSizeMB, boolean memoryMapping, GCMonitor gcMonitor)
throws IOException {
checkNotNull(directory).mkdirs();
if (cacheSizeMB < 0) {
@@ -340,6 +342,7 @@ public class FileStore implements Segmen
this.directory = directory;
this.maxFileSize = maxFileSizeMB * MB;
this.memoryMapping = memoryMapping;
+ this.gcMonitor = gcMonitor;
journalFile = new RandomAccessFile(new File(directory,
JOURNAL_FILE_NAME), "rw");
@@ -416,9 +419,6 @@ public class FileStore implements Segmen
}
});
- if (whiteboard != null) {
- gcMonitor.start(whiteboard);
- }
log.info("TarMK opened: {} (mmap={})", directory, memoryMapping);
}
@@ -753,7 +753,6 @@ public class FileStore implements Segmen
// threads before acquiring the synchronization lock
compactionThread.close();
flushThread.close();
- gcMonitor.stop();
synchronized (this) {
try {
@@ -1039,48 +1038,40 @@ public class FileStore implements Segmen
return version;
}
- private static class GCMonitorTracker extends
AbstractServiceTracker<GCMonitor> {
- public GCMonitorTracker() {
- super(GCMonitor.class);
- }
+ private static class LoggingGCMonitor implements GCMonitor {
+ public GCMonitor delegatee = GCMonitor.EMPTY;
- void info(String message, Object... arguments) {
+ @Override
+ public void info(String message, Object... arguments) {
log.info(message, arguments);
- for (GCMonitor gcMonitor : getServices()) {
- gcMonitor.info(message, arguments);
- }
+ delegatee.info(message, arguments);
}
- void warn(String message, Object... arguments) {
+ @Override
+ public void warn(String message, Object... arguments) {
log.warn(message, arguments);
- for (GCMonitor gcMonitor : getServices()) {
- gcMonitor.warn(message, arguments);
- }
+ delegatee.warn(message, arguments);
}
- void error(String message, Exception e) {
- for (GCMonitor gcMonitor : getServices()) {
- gcMonitor.error(message, e);
- }
+ @Override
+ public void error(String message, Exception exception) {
+ delegatee.error(message, exception);
}
- void skipped(String message, Object... arguments) {
- log.info(message, arguments);
- for (GCMonitor gcMonitor : getServices()) {
- gcMonitor.skipped(message, arguments);
- }
+ @Override
+ public void skipped(String reason, Object... arguments) {
+ log.info(reason, arguments);
+ delegatee.skipped(reason, arguments);
}
- void compacted() {
- for (GCMonitor gcMonitor : getServices()) {
- gcMonitor.compacted();
- }
+ @Override
+ public void compacted() {
+ delegatee.compacted();
}
- void cleaned(long reclaimedSize, long currentSize) {
- for (GCMonitor gcMonitor : getServices()) {
- gcMonitor.cleaned(reclaimedSize, currentSize);
- }
+ @Override
+ public void cleaned(long reclaimedSize, long currentSize) {
+ delegatee.cleaned(reclaimedSize, currentSize);
}
}
}
Modified:
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/gc/GCMonitor.java
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/gc/GCMonitor.java?rev=1663448&r1=1663447&r2=1663448&view=diff
==============================================================================
---
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/gc/GCMonitor.java
(original)
+++
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/gc/GCMonitor.java
Mon Mar 2 22:16:13 2015
@@ -28,6 +28,8 @@ import org.apache.jackrabbit.oak.spi.whi
*/
public interface GCMonitor {
+ GCMonitor EMPTY = new Empty();
+
/**
* Log a message at the INFO level according to the specified format
* and arguments.
@@ -48,7 +50,7 @@ public interface GCMonitor {
* @param message The message with {} place holders for the {@code
arguments}
* @param arguments
*/
- void info(String message, Object[] arguments);
+ void info(String message, Object... arguments);
/**
* Warning about a condition that might have advert effects on the overall
@@ -56,7 +58,7 @@ public interface GCMonitor {
* @param message The message with {} place holders for the {@code
arguments}
* @param arguments
*/
- void warn(String message, Object[] arguments);
+ void warn(String message, Object... arguments);
/**
* An error caused the garbage collection process to terminate prematurely.
@@ -70,7 +72,7 @@ public interface GCMonitor {
* @param reason The reason with {} place holders for the {@code
arguments}
* @param arguments
*/
- void skipped(String reason, Object[] arguments);
+ void skipped(String reason, Object... arguments);
/**
* The compaction phase of the garbage collection process terminated
successfully.
@@ -91,5 +93,5 @@ public interface GCMonitor {
@Override public void skipped(String reason, Object[] arguments) { }
@Override public void compacted() { }
@Override public void cleaned(long reclaimedSize, long currentSize) { }
- }
+ };
}
Modified:
jackrabbit/oak/trunk/oak-jcr/src/main/java/org/apache/jackrabbit/oak/jcr/repository/RepositoryImpl.java
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-jcr/src/main/java/org/apache/jackrabbit/oak/jcr/repository/RepositoryImpl.java?rev=1663448&r1=1663447&r2=1663448&view=diff
==============================================================================
---
jackrabbit/oak/trunk/oak-jcr/src/main/java/org/apache/jackrabbit/oak/jcr/repository/RepositoryImpl.java
(original)
+++
jackrabbit/oak/trunk/oak-jcr/src/main/java/org/apache/jackrabbit/oak/jcr/repository/RepositoryImpl.java
Mon Mar 2 22:16:13 2015
@@ -455,13 +455,13 @@ public class RepositoryImpl implements J
private final GCMonitor gcMonitor = new GCMonitor.Empty() {
@Override
public void compacted() {
- compactionCount++;
+ compacted = true;
}
};
private final Registration reg = whiteboard.register(GCMonitor.class,
gcMonitor, emptyMap());
- private volatile int compactionCount;
+ private volatile boolean compacted;
private int refreshCount;
public void close() {
@@ -470,8 +470,8 @@ public class RepositoryImpl implements J
@Override
public boolean needsRefresh(long secondsSinceLastAccess) {
- if (compactionCount > refreshCount) {
- refreshCount = compactionCount;
+ if (compacted) {
+ compacted = false;
return true;
} else {
return false;
Modified:
jackrabbit/oak/trunk/oak-jcr/src/test/java/org/apache/jackrabbit/oak/jcr/RefreshOnGCTest.java
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-jcr/src/test/java/org/apache/jackrabbit/oak/jcr/RefreshOnGCTest.java?rev=1663448&r1=1663447&r2=1663448&view=diff
==============================================================================
---
jackrabbit/oak/trunk/oak-jcr/src/test/java/org/apache/jackrabbit/oak/jcr/RefreshOnGCTest.java
(original)
+++
jackrabbit/oak/trunk/oak-jcr/src/test/java/org/apache/jackrabbit/oak/jcr/RefreshOnGCTest.java
Mon Mar 2 22:16:13 2015
@@ -39,6 +39,7 @@ import javax.jcr.SimpleCredentials;
import org.apache.jackrabbit.api.JackrabbitRepository;
import org.apache.jackrabbit.oak.Oak;
+import org.apache.jackrabbit.oak.plugins.segment.GCMonitorTracker;
import org.apache.jackrabbit.oak.plugins.segment.SegmentNodeStore;
import org.apache.jackrabbit.oak.plugins.segment.compaction.CompactionStrategy;
import org.apache.jackrabbit.oak.plugins.segment.file.FileStore;
@@ -52,6 +53,7 @@ import org.junit.Test;
public class RefreshOnGCTest {
private FileStore fileStore;
private Repository repository;
+ private GCMonitorTracker gcMonitor;
@Before
public void setup() throws IOException {
@@ -60,8 +62,10 @@ public class RefreshOnGCTest {
directory.mkdir();
Whiteboard whiteboard = new DefaultWhiteboard();
+ gcMonitor = new GCMonitorTracker();
+ gcMonitor.start(whiteboard);
fileStore = newFileStore(directory)
- .withWhiteBoard(whiteboard)
+ .withGCMonitor(gcMonitor)
.create()
.setCompactionStrategy(new CompactionStrategy(
false, false, CLEAN_NONE, 0,
CompactionStrategy.MEMORY_THRESHOLD_DEFAULT) {
@@ -83,6 +87,7 @@ public class RefreshOnGCTest {
if (repository instanceof JackrabbitRepository) {
((JackrabbitRepository) repository).shutdown();
}
+ gcMonitor.stop();
}
@Test
