Author: mduerig
Date: Tue Mar 3 16:10:44 2015
New Revision: 1663730
URL: http://svn.apache.org/r1663730
Log:
OAK-2552: Implement MBean monitoring garbage collection
Introducing GCMonitorMBean
Added:
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/segment/file/FileStoreGCMonitor.java
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/segment/file/GCMonitorMBean.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/stats/TimeSeriesStatsUtil.java
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=1663730&r1=1663729&r2=1663730&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
Tue Mar 3 16:10:44 2015
@@ -17,6 +17,7 @@
package org.apache.jackrabbit.oak.plugins.segment;
import static com.google.common.base.Preconditions.checkState;
+import static java.util.Collections.emptyMap;
import static org.apache.jackrabbit.oak.commons.PropertiesUtil.toBoolean;
import static org.apache.jackrabbit.oak.commons.PropertiesUtil.toLong;
import static
org.apache.jackrabbit.oak.plugins.segment.compaction.CompactionStrategy.CLEANUP_DEFAULT;
@@ -25,6 +26,7 @@ import static org.apache.jackrabbit.oak.
import static
org.apache.jackrabbit.oak.plugins.segment.compaction.CompactionStrategy.PAUSE_DEFAULT;
import static
org.apache.jackrabbit.oak.plugins.segment.compaction.CompactionStrategy.TIMESTAMP_DEFAULT;
import static
org.apache.jackrabbit.oak.spi.whiteboard.WhiteboardUtils.registerMBean;
+import static
org.apache.jackrabbit.oak.spi.whiteboard.WhiteboardUtils.scheduleWithFixedDelay;
import java.io.ByteArrayInputStream;
import java.io.Closeable;
@@ -61,16 +63,21 @@ import org.apache.jackrabbit.oak.plugins
import
org.apache.jackrabbit.oak.plugins.segment.compaction.DefaultCompactionStrategyMBean;
import org.apache.jackrabbit.oak.plugins.segment.file.FileStore;
import org.apache.jackrabbit.oak.plugins.segment.file.FileStore.Builder;
+import org.apache.jackrabbit.oak.plugins.segment.file.FileStoreGCMonitor;
+import org.apache.jackrabbit.oak.plugins.segment.file.GCMonitorMBean;
import org.apache.jackrabbit.oak.spi.blob.BlobStore;
import org.apache.jackrabbit.oak.spi.blob.GarbageCollectableBlobStore;
import org.apache.jackrabbit.oak.spi.commit.Observable;
import org.apache.jackrabbit.oak.spi.commit.Observer;
+import org.apache.jackrabbit.oak.spi.gc.GCMonitor;
import org.apache.jackrabbit.oak.spi.state.NodeStore;
import org.apache.jackrabbit.oak.spi.state.ProxyNodeStore;
import org.apache.jackrabbit.oak.spi.state.RevisionGC;
import org.apache.jackrabbit.oak.spi.state.RevisionGCMBean;
+import org.apache.jackrabbit.oak.spi.whiteboard.CompositeRegistration;
import org.apache.jackrabbit.oak.spi.whiteboard.Registration;
import org.apache.jackrabbit.oak.spi.whiteboard.WhiteboardExecutor;
+import org.apache.jackrabbit.oak.stats.Clock;
import org.osgi.framework.Constants;
import org.osgi.framework.ServiceRegistration;
import org.osgi.service.component.ComponentContext;
@@ -150,6 +157,7 @@ public class SegmentNodeStoreService ext
private Registration revisionGCRegistration;
private Registration blobGCRegistration;
private Registration compactionStrategyRegistration;
+ private Registration fsgcMonitorMBean;
private WhiteboardExecutor executor;
private boolean customBlobStore;
@@ -262,6 +270,13 @@ public class SegmentNodeStoreService ext
.setCompactionStrategy(compactionStrategy);
}
+ FileStoreGCMonitor fsgcMonitor = new FileStoreGCMonitor(Clock.SIMPLE);
+ fsgcMonitorMBean = new CompositeRegistration(
+ whiteboard.register(GCMonitor.class, fsgcMonitor, emptyMap()),
+ registerMBean(whiteboard, GCMonitorMBean.class, fsgcMonitor,
GCMonitorMBean.TYPE,
+ "File Store garbage collection monitor"),
+ scheduleWithFixedDelay(whiteboard, fsgcMonitor, 1));
+
delegate = new SegmentNodeStore(store);
observerTracker = new ObserverTracker(delegate);
observerTracker.start(context.getBundleContext());
@@ -376,6 +391,10 @@ public class SegmentNodeStoreService ext
compactionStrategyRegistration.unregister();
compactionStrategyRegistration = null;
}
+ if (fsgcMonitorMBean != null) {
+ fsgcMonitorMBean.unregister();
+ fsgcMonitorMBean = null;
+ }
if (executor != null) {
executor.stop();
executor = null;
Added:
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/segment/file/FileStoreGCMonitor.java
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/segment/file/FileStoreGCMonitor.java?rev=1663730&view=auto
==============================================================================
---
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/segment/file/FileStoreGCMonitor.java
(added)
+++
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/segment/file/FileStoreGCMonitor.java
Tue Mar 3 16:10:44 2015
@@ -0,0 +1,152 @@
+/*
+ * 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.file;
+
+import static com.google.common.base.Preconditions.checkNotNull;
+import static java.text.DateFormat.getDateTimeInstance;
+import static
org.apache.jackrabbit.oak.stats.TimeSeriesStatsUtil.asCompositeData;
+import static org.slf4j.helpers.MessageFormatter.arrayFormat;
+
+import java.io.PrintWriter;
+import java.io.StringWriter;
+import java.util.Date;
+
+import javax.annotation.Nonnull;
+import javax.management.openmbean.CompositeData;
+
+import org.apache.jackrabbit.oak.spi.gc.GCMonitor;
+import org.apache.jackrabbit.oak.stats.Clock;
+import org.apache.jackrabbit.stats.TimeSeriesRecorder;
+
+/**
+ * {@link GCMonitor} implementation providing the file store gc status
+ * as {@link GCMonitorMBean}.
+ * <p>
+ * Users of this class need to schedule a call to {@link #run()} once per
+ * second to ensure the various time series maintained by this implementation
+ * are correctly aggregated.
+ */
+public class FileStoreGCMonitor implements GCMonitor, GCMonitorMBean, Runnable
{
+ private final TimeSeriesRecorder gcCount = new TimeSeriesRecorder(true);
+ private final TimeSeriesRecorder repositorySize = new
TimeSeriesRecorder(false);
+ private final TimeSeriesRecorder reclaimedSize = new
TimeSeriesRecorder(true);
+
+ private final Clock clock;
+
+ private long lastCompaction;
+ private long lastCleanup;
+ private String lastError;
+ private String status = "NA";
+
+ public FileStoreGCMonitor(@Nonnull Clock clock) {
+ this.clock = checkNotNull(clock);
+ }
+
+ //------------------------------------------------------------< Runnable
>---
+
+ @Override
+ public void run() {
+ gcCount.recordOneSecond();
+ repositorySize.recordOneSecond();
+ reclaimedSize.recordOneSecond();
+ }
+
+ //------------------------------------------------------------< GCMonitor
>---
+
+ @Override
+ public void info(String message, Object... arguments) {
+ status = arrayFormat(message, arguments).getMessage();
+ }
+
+ @Override
+ public void warn(String message, Object... arguments) {
+ status = arrayFormat(message, arguments).getMessage();
+ }
+
+ @Override
+ public void error(String message, Exception exception) {
+ StringWriter sw = new StringWriter();
+ sw.write(message + ": ");
+ exception.printStackTrace(new PrintWriter(sw));
+ lastError = sw.toString();
+ }
+
+ @Override
+ public void skipped(String reason, Object... arguments) {
+ status = arrayFormat(reason, arguments).getMessage();
+ }
+
+ @Override
+ public void compacted() {
+ lastCompaction = clock.getTime();
+ }
+
+ @Override
+ public void cleaned(long reclaimed, long current) {
+ lastCleanup = clock.getTime();
+ gcCount.getCounter().addAndGet(1);
+ repositorySize.getCounter().addAndGet(current);
+ reclaimedSize.getCounter().addAndGet(reclaimed);
+ }
+
+ //------------------------------------------------------------<
GCMonitorMBean >---
+
+ @Override
+ public String getLastCompaction() {
+ return toString(lastCompaction);
+ }
+
+ @Override
+ public String getLastCleanup() {
+ return toString(lastCleanup);
+ }
+
+ private static String toString(long timestamp) {
+ if (timestamp != 0) {
+ return getDateTimeInstance().format(new Date(timestamp));
+ } else {
+ return null;
+ }
+ }
+
+ @Override
+ public String getLastError() {
+ return lastError;
+ }
+
+ @Nonnull
+ @Override
+ public String getStatus() {
+ return status;
+ }
+
+ @Nonnull
+ @Override
+ public CompositeData getRepositorySize() {
+ return asCompositeData(repositorySize, "RepositorySize");
+ }
+
+ @Nonnull
+ @Override
+ public CompositeData getReclaimedSize() {
+ return asCompositeData(reclaimedSize, "ReclaimedSize");
+ }
+
+}
Added:
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/segment/file/GCMonitorMBean.java
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/segment/file/GCMonitorMBean.java?rev=1663730&view=auto
==============================================================================
---
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/segment/file/GCMonitorMBean.java
(added)
+++
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/segment/file/GCMonitorMBean.java
Tue Mar 3 16:10:44 2015
@@ -0,0 +1,68 @@
+/*
+ * 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.file;
+
+import javax.annotation.CheckForNull;
+import javax.annotation.Nonnull;
+import javax.management.openmbean.CompositeData;
+
+/**
+ * MBean for monitoring the revision garbage collection process of the
+ * {@link FileStore}.
+ */
+public interface GCMonitorMBean {
+ String TYPE = "GC Monitor";
+
+ /**
+ * @return timestamp of the last compaction or {@code null} if none.
+ */
+ @CheckForNull
+ String getLastCompaction();
+
+ /**
+ * @return timestamp of the last cleanup or {@code null} if none.
+ */
+ @CheckForNull
+ String getLastCleanup();
+
+ /**
+ * @return last error or {@code null} if none.
+ */
+ @CheckForNull
+ String getLastError();
+
+ /**
+ * @return current status.
+ */
+ @Nonnull
+ String getStatus();
+
+ /**
+ * @return time series of the repository size
+ */
+ @Nonnull
+ CompositeData getRepositorySize();
+
+ /**
+ * @return time series of the reclaimed space
+ */
+ @Nonnull
+ CompositeData getReclaimedSize();
+}
Modified:
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/stats/TimeSeriesStatsUtil.java
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/stats/TimeSeriesStatsUtil.java?rev=1663730&r1=1663729&r2=1663730&view=diff
==============================================================================
---
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/stats/TimeSeriesStatsUtil.java
(original)
+++
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/stats/TimeSeriesStatsUtil.java
Tue Mar 3 16:10:44 2015
@@ -18,10 +18,7 @@
*/
package org.apache.jackrabbit.oak.stats;
-import org.apache.jackrabbit.api.stats.TimeSeries;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
+import javax.annotation.Nonnull;
import javax.management.openmbean.ArrayType;
import javax.management.openmbean.CompositeData;
import javax.management.openmbean.CompositeDataSupport;
@@ -30,27 +27,36 @@ import javax.management.openmbean.OpenDa
import javax.management.openmbean.OpenType;
import javax.management.openmbean.SimpleType;
+import org.apache.jackrabbit.api.stats.TimeSeries;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
/**
* Utility class for retrieving {@link
javax.management.openmbean.CompositeData} for
* {@link org.apache.jackrabbit.api.stats.TimeSeries}.
*/
-public class TimeSeriesStatsUtil {
+public final class TimeSeriesStatsUtil {
public static final String[] ITEM_NAMES = new String[] {"per second", "per
minute", "per hour", "per week"};
private static final Logger LOG =
LoggerFactory.getLogger(TimeSeriesStatsUtil.class);
+ private TimeSeriesStatsUtil() {
+ }
+
+ @Nonnull
public static CompositeData asCompositeData(TimeSeries timeSeries, String
name) {
try {
long[][] values = new long[][] {timeSeries.getValuePerSecond(),
timeSeries.getValuePerMinute(),
timeSeries.getValuePerHour(), timeSeries.getValuePerWeek()};
return new CompositeDataSupport(getCompositeType(name),
ITEM_NAMES, values);
} catch (Exception e) {
- LOG.error("Error creating CompositeData instance from TimeSeries",
e);
- return null;
+ String msg = "Error creating CompositeData instance from
TimeSeries";
+ LOG.error(msg, e);
+ throw new IllegalArgumentException(msg, e);
}
}
- static CompositeType getCompositeType(String name) throws
OpenDataException {
+ private static CompositeType getCompositeType(String name) throws
OpenDataException {
ArrayType<int[]> longArrayType = new ArrayType<int[]>(SimpleType.LONG,
true);
OpenType<?>[] itemTypes = new OpenType[] {longArrayType,
longArrayType, longArrayType, longArrayType};
return new CompositeType(name, name + " time series", ITEM_NAMES,
ITEM_NAMES, itemTypes);
