Author: thomasm
Date: Fri Jul 5 13:38:53 2019
New Revision: 1862616
URL: http://svn.apache.org/viewvc?rev=1862616&view=rev
Log:
OAK-8344 Expose local index directory size as a metric
Added:
jackrabbit/oak/trunk/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/directory/LuceneIndexFileSystemStatistics.java
Modified:
jackrabbit/oak/trunk/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/CopyOnReadStatsMBean.java
jackrabbit/oak/trunk/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/IndexCopier.java
jackrabbit/oak/trunk/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/LuceneIndexProviderService.java
Modified:
jackrabbit/oak/trunk/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/CopyOnReadStatsMBean.java
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/CopyOnReadStatsMBean.java?rev=1862616&r1=1862615&r2=1862616&view=diff
==============================================================================
---
jackrabbit/oak/trunk/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/CopyOnReadStatsMBean.java
(original)
+++
jackrabbit/oak/trunk/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/CopyOnReadStatsMBean.java
Fri Jul 5 13:38:53 2019
@@ -69,6 +69,8 @@ public interface CopyOnReadStatsMBean {
String getLocalIndexSize();
+ long getLocalIndexDirSize();
+
String[] getGarbageDetails();
String getGarbageSize();
Modified:
jackrabbit/oak/trunk/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/IndexCopier.java
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/IndexCopier.java?rev=1862616&r1=1862615&r2=1862616&view=diff
==============================================================================
---
jackrabbit/oak/trunk/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/IndexCopier.java
(original)
+++
jackrabbit/oak/trunk/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/IndexCopier.java
Fri Jul 5 13:38:53 2019
@@ -547,6 +547,11 @@ public class IndexCopier implements Copy
}
@Override
+ public long getLocalIndexDirSize() {
+ return indexRootDirectory.getSize();
+ }
+
+ @Override
public String[] getGarbageDetails() {
return toArray(transform(failedToDeleteFiles.values(),
new Function<LocalIndexFile, String>() {
Modified:
jackrabbit/oak/trunk/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/LuceneIndexProviderService.java
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/LuceneIndexProviderService.java?rev=1862616&r1=1862615&r2=1862616&view=diff
==============================================================================
---
jackrabbit/oak/trunk/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/LuceneIndexProviderService.java
(original)
+++
jackrabbit/oak/trunk/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/LuceneIndexProviderService.java
Fri Jul 5 13:38:53 2019
@@ -60,6 +60,7 @@ import org.apache.jackrabbit.oak.plugins
import org.apache.jackrabbit.oak.plugins.index.importer.IndexImporterProvider;
import
org.apache.jackrabbit.oak.plugins.index.lucene.directory.ActiveDeletedBlobCollectorFactory;
import
org.apache.jackrabbit.oak.plugins.index.lucene.directory.BufferedOakDirectory;
+import
org.apache.jackrabbit.oak.plugins.index.lucene.directory.LuceneIndexFileSystemStatistics;
import
org.apache.jackrabbit.oak.plugins.index.lucene.directory.LuceneIndexImporter;
import org.apache.jackrabbit.oak.plugins.index.lucene.hybrid.DocumentQueue;
import
org.apache.jackrabbit.oak.plugins.index.lucene.hybrid.ExternalObserverBuilder;
@@ -279,6 +280,14 @@ public class LuceneIndexProviderService
)
private static final String PROP_NAME_ENABLE_SINGLE_BLOB_PER_INDEX_FILE =
"enableSingleBlobIndexFiles";
+ private static final long PROP_INDEX_FILESYSTEM_STATS_INTERVAL_DEFAULT =
300;
+ @Property(
+ longValue = PROP_INDEX_FILESYSTEM_STATS_INTERVAL_DEFAULT,
+ label = "Lucene Index File System Stats Interval (seconds)",
+ description = "Interval (in seconds) for calculation of File
System metrics for Lucene Index such as Local Index Directory Size"
+ )
+ private static final String PROP_INDEX_FILESYSTEM_STATS_INTERVAL =
"propIndexFSStatsIntervalInSecs";
+
private final Clock clock = Clock.SIMPLE;
private Whiteboard whiteboard;
@@ -398,6 +407,10 @@ public class LuceneIndexProviderService
registerGCMonitor(whiteboard, tracker);
registerIndexEditor(bundleContext, tracker, mBean, config);
+
+ LuceneIndexFileSystemStatistics luceneIndexFSStats = new
LuceneIndexFileSystemStatistics(statisticsProvider, indexCopier);
+ registerLuceneFileSystemStats(luceneIndexFSStats,
PropertiesUtil.toLong(config.get(PROP_INDEX_FILESYSTEM_STATS_INTERVAL),PROP_INDEX_FILESYSTEM_STATS_INTERVAL_DEFAULT));
+
}
private File getIndexCheckDir() {
@@ -804,6 +817,14 @@ public class LuceneIndexProviderService
log.info("Property index cleaner configured to run every [{}]
seconds", cleanerInterval);
}
+ private void registerLuceneFileSystemStats(LuceneIndexFileSystemStatistics
luceneIndexFSStats, long delayInSeconds) {
+ Map<String, Object> config = ImmutableMap.<String, Object>of(
+ "scheduler.name",
LuceneIndexFileSystemStatistics.class.getName()
+ );
+ oakRegs.add(scheduleWithFixedDelay(whiteboard, luceneIndexFSStats,
config, delayInSeconds, false, true));
+ log.info("Lucene FileSystem Statistics calculator configured to run
every [{}] seconds", delayInSeconds);
+ }
+
protected void bindNodeAggregator(QueryIndex.NodeAggregator aggregator) {
this.nodeAggregator = aggregator;
@@ -824,4 +845,5 @@ public class LuceneIndexProviderService
this.extractedTextProvider = null;
registerExtractedTextProvider(null);
}
+
}
Added:
jackrabbit/oak/trunk/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/directory/LuceneIndexFileSystemStatistics.java
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/directory/LuceneIndexFileSystemStatistics.java?rev=1862616&view=auto
==============================================================================
---
jackrabbit/oak/trunk/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/directory/LuceneIndexFileSystemStatistics.java
(added)
+++
jackrabbit/oak/trunk/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/directory/LuceneIndexFileSystemStatistics.java
Fri Jul 5 13:38:53 2019
@@ -0,0 +1,56 @@
+/*
+ * 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.index.lucene.directory;
+
+
+import org.apache.jackrabbit.oak.plugins.index.lucene.IndexCopier;
+import org.apache.jackrabbit.oak.stats.CounterStats;
+import org.apache.jackrabbit.oak.stats.StatisticsProvider;
+import org.apache.jackrabbit.oak.stats.StatsOptions;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class LuceneIndexFileSystemStatistics implements Runnable {
+
+ private final StatisticsProvider statisticsProvider;
+ private final IndexCopier indexCopier;
+ private static final String LOCAL_INDEX_DIR_SIZE = "LOCAL_INDEX_DIR_SIZE";
+ private final Logger log = LoggerFactory.getLogger(getClass());
+
+ public LuceneIndexFileSystemStatistics(StatisticsProvider statsProvider,
IndexCopier indexCopier) {
+ this.statisticsProvider = statsProvider;
+ this.indexCopier = indexCopier;
+ }
+
+ @Override
+ public void run() {
+ calculateLocalIndexDirSize();
+ }
+
+ private void calculateLocalIndexDirSize() {
+ long localIndexDirSize = indexCopier.getLocalIndexDirSize();
+ CounterStats indexDirectorySizeStats =
statisticsProvider.getCounterStats(LOCAL_INDEX_DIR_SIZE, StatsOptions.DEFAULT);
+ long deltaInSize = localIndexDirSize -
indexDirectorySizeStats.getCount();
+ if (deltaInSize != 0) {
+ indexDirectorySizeStats.inc(deltaInSize);
+ log.debug("index directory size stats updated; size {} delta {}",
localIndexDirSize, deltaInSize);
+ }
+ }
+}
