use existing cache metrics for cache size

Author: keith-turner

core/src/main/java/org/apache/accumulo/core/clientImpl/ClientContext.java

@@ -1198,18 +1198,19 @@ public MeterRegistry getMeterRegistry() {
     return micrometer;
   }
 
-  public void setMeterRegistry(MeterRegistry micrometer) {
+  public synchronized void setMeterRegistry(MeterRegistry micrometer) {
     ensureOpen();
     this.micrometer = micrometer;
-    getCaches();
+    if (caches != null) {
+      caches.registerMetrics(micrometer);
+    }
   }
 
   public synchronized Caches getCaches() {
     ensureOpen();
     if (caches == null) {
       caches = Caches.getInstance();
-      if (micrometer != null
-          && getConfiguration().getBoolean(Property.GENERAL_MICROMETER_CACHE_METRICS_ENABLED)) {
+      if (micrometer != null) {
         caches.registerMetrics(micrometer);
       }
     }

core/src/main/java/org/apache/accumulo/core/conf/Property.java

@@ -352,9 +352,6 @@ temporary files (for example, when creating a pre-split table). \
       PropertyType.TIMEDURATION,
       "The maximum amount of time that a Scanner should wait before retrying a failed RPC.",
       "1.7.3"),
-  GENERAL_MICROMETER_CACHE_METRICS_ENABLED("general.micrometer.cache.metrics.enabled", "false",
-      PropertyType.BOOLEAN, "Enables Caffeine Cache metrics functionality using Micrometer.",
-      "4.0.0"),
   GENERAL_MICROMETER_ENABLED("general.micrometer.enabled", "false", PropertyType.BOOLEAN,
       "Enables metrics collection and reporting functionality using Micrometer.", "2.1.0"),
   GENERAL_MICROMETER_JVM_METRICS_ENABLED("general.micrometer.jvm.metrics.enabled", "false",
@@ -1688,8 +1685,7 @@ public static boolean isValidTablePropertyKey(String key) {
       GENERAL_IDLE_PROCESS_INTERVAL, GENERAL_MICROMETER_ENABLED,
       GENERAL_MICROMETER_JVM_METRICS_ENABLED, GENERAL_MICROMETER_LOG_METRICS,
       GENERAL_MICROMETER_FACTORY, GENERAL_SERVER_LOCK_VERIFICATION_INTERVAL,
-      GENERAL_CACHE_MANAGER_IMPL, GENERAL_MICROMETER_CACHE_METRICS_ENABLED,
-      GENERAL_LOW_MEM_DETECTOR_INTERVAL,
+      GENERAL_CACHE_MANAGER_IMPL, GENERAL_LOW_MEM_DETECTOR_INTERVAL,
 
       // MANAGER options
       MANAGER_THREADCHECK, MANAGER_FATE_METRICS_MIN_UPDATE_INTERVAL, MANAGER_METADATA_SUSPENDABLE,

core/src/main/java/org/apache/accumulo/core/metrics/Metric.java

@@ -258,9 +258,6 @@ public enum Metric {
   SCAN_BUSY_TIMEOUT_COUNT("accumulo.scan.busy.timeout.count", MetricType.FUNCTION_COUNTER,
       "Count of the scans where a busy timeout happened.", MetricDocSection.SCAN, "Scan Busy Count",
       null, NUMBER),
-  SCAN_TABLETS_CACHED("accumulo.scan.tablet.cached", MetricType.GAUGE,
-      "The number of tablets for which a scan server has cached metadata.", MetricDocSection.SCAN,
-      "Tablets Cached", null, NUMBER),
 
   // Scan Metrics
   SCAN_TIMES("accumulo.scan.times", MetricType.TIMER, "Scan session lifetime (creation to close).",
@@ -405,7 +402,11 @@ public enum Metric {
       MetricDocSection.GENERAL_SERVER, "Completed task", null, NUMBER),
   EXECUTOR_QUEUED("executor.queued", MetricType.GAUGE,
       "Task queued for a thread pool. Each thread pool emits this metric w/ a different tag.",
-      MetricDocSection.GENERAL_SERVER, "Queued task", null, NUMBER);
+      MetricDocSection.GENERAL_SERVER, "Queued task", null, NUMBER),
+
+  // Cache metrics
+  CACHE_SIZE("cache.size", MetricType.GAUGE, "The current number of entries a cache has.",
+      MetricDocSection.GENERAL_SERVER, "Cache size", null, NUMBER);
 
   public enum MonitorCssClass {
     BYTES("big-size"),

server/base/src/main/java/org/apache/accumulo/server/AbstractServer.java

@@ -410,7 +410,8 @@ public MetricResponse getMetrics(TInfo tinfo, TCredentials credentials) throws T
       registry.getMeters().forEach(m -> {
         if (m.getId().getName().startsWith("accumulo.")
             || m.getId().getName().equals(Metric.EXECUTOR_COMPLETED.getName())
-            || m.getId().getName().equals(Metric.EXECUTOR_QUEUED.getName())) {
+            || m.getId().getName().equals(Metric.EXECUTOR_QUEUED.getName())
+            || m.getId().getName().equals(Metric.CACHE_SIZE.getName())) {
           if (!this.monitorMetricExclusions.contains(m.getId().getName())) {
             m.match(response::writeMeter, response::writeMeter, response::writeTimer,
                 response::writeDistributionSummary, response::writeLongTaskTimer,

server/monitor/src/main/java/org/apache/accumulo/monitor/next/views/CacheSizeColumnFactory.java

@@ -0,0 +1,63 @@
+/*
+ * 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
+ *
+ *   https://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.accumulo.monitor.next.views;
+
+import java.util.List;
+import java.util.Map;
+
+import com.google.common.base.Preconditions;
+import org.apache.accumulo.core.client.admin.servers.ServerId;
+import org.apache.accumulo.core.metrics.Metric;
+import org.apache.accumulo.core.metrics.flatbuffers.FMetric;
+import org.apache.accumulo.core.metrics.flatbuffers.FTag;
+import org.apache.accumulo.core.process.thrift.MetricResponse;
+import org.apache.accumulo.monitor.next.SystemInformation;
+
+public class CacheSizeColumnFactory implements ColumnFactory {
+
+  private final String cacheName;
+  private final TableData.Column column;
+
+  CacheSizeColumnFactory(String cacheName, String colHeader, String description) {
+    this.cacheName = cacheName;
+    Preconditions.checkState(Metric.CACHE_SIZE.getColumnClasses().length == 1);
+    this.column = new TableData.Column(Metric.CACHE_SIZE.getName() + "_" + cacheName, colHeader,
+        description, Metric.CACHE_SIZE.getColumnClasses()[0].getCssClass());
+  }
+
+  @Override
+  public TableData.Column getColumn() {
+    return column;
+  }
+
+  @Override
+  public Object getRowData(ServerId sid, MetricResponse mr,
+      Map<String,List<FMetric>> serverMetrics) {
+    var tag = new FTag();
+    for (var metric : serverMetrics.getOrDefault(Metric.CACHE_SIZE.getName(), List.of())) {
+      for (int i = 0; i < metric.tagsLength(); i++) {
+        metric.tags(tag, i);
+        if ("cache".equals(tag.key()) && cacheName.equals(tag.value())) {
+          return SystemInformation.getMetricValue(metric);
+        }
+      }
+    }
+    return null;
+  }
+}

server/monitor/src/main/java/org/apache/accumulo/monitor/next/views/TableDataFactory.java

@@ -266,7 +266,8 @@ private static void scanColumns(List<ColumnFactory> cols) {
   private static void scanServerColumns(List<ColumnFactory> cols) {
     commonColumns(cols);
     scanColumns(cols);
-    cols.add(new MetricColumnFactory(Metric.SCAN_TABLETS_CACHED));
+    cols.add(new CacheSizeColumnFactory(Metric.SCAN_TABLET_METADATA_CACHE.getName(),
+        "Tablets Cached", "The number of tablets for which a scan server has cached metadata."));
     cols.add(new MetricColumnFactory(Metric.SCAN_RESERVATION_FILES));
     cols.add(new MetricColumnFactory(Metric.SCAN_BUSY_TIMEOUT_COUNT));
     cols.add(new TimerColumnFactory(Metric.SCAN_RESERVATION_TOTAL_TIMER));

server/tserver/src/main/java/org/apache/accumulo/tserver/ScanServerMetrics.java

@@ -23,7 +23,6 @@
 import static org.apache.accumulo.core.metrics.Metric.SCAN_RESERVATION_FILES;
 import static org.apache.accumulo.core.metrics.Metric.SCAN_RESERVATION_TOTAL_TIMER;
 import static org.apache.accumulo.core.metrics.Metric.SCAN_RESERVATION_WRITEOUT_TIMER;
-import static org.apache.accumulo.core.metrics.Metric.SCAN_TABLETS_CACHED;
 import static org.apache.accumulo.core.metrics.Metric.SCAN_TABLET_METADATA_CACHE;
 
 import java.time.Duration;
@@ -76,10 +75,6 @@ public void registerMetrics(MeterRegistry registry) {
         .description(SCAN_RESERVATION_FILES.getDescription()).register(registry);
 
     if (tabletMetadataCache != null) {
-      Gauge
-          .builder(SCAN_TABLETS_CACHED.getName(),
-              () -> (double) tabletMetadataCache.estimatedSize())
-          .description(SCAN_TABLETS_CACHED.getDescription()).register(registry);
       Preconditions.checkState(tabletMetadataCache.policy().isRecordingStats(),
           "Attempted to instrument cache that is not recording stats.");
       CaffeineCacheMetrics.monitor(registry, tabletMetadataCache,

test/src/main/java/org/apache/accumulo/test/compaction/BadCompactionServiceConfigIT.java

@@ -99,7 +99,6 @@ public void configureMiniCluster(MiniAccumuloConfigImpl cfg, Configuration hadoo
     // that will be configured to push all metrics to the sink we started.
     cfg.setProperty(Property.GENERAL_MICROMETER_ENABLED, "true");
     cfg.setProperty(Property.GENERAL_MICROMETER_USER_TAGS, "tag1=value1,tag2=value2");
-    cfg.setProperty(Property.GENERAL_MICROMETER_CACHE_METRICS_ENABLED, "true");
     cfg.setProperty(Property.GENERAL_MICROMETER_JVM_METRICS_ENABLED, "true");
     cfg.setProperty("general.custom.metrics.opts.logging.step", "10s");
     String clazzList = LoggingMeterRegistryFactory.class.getName() + ","

test/src/main/java/org/apache/accumulo/test/metrics/MetricsIT.java

@@ -126,7 +126,6 @@ protected void configure(MiniAccumuloConfigImpl cfg, Configuration hadoopCoreSit
     // that will be configured to push all metrics to the sink we started.
     cfg.setProperty(Property.GENERAL_MICROMETER_ENABLED, "true");
     cfg.setProperty(Property.GENERAL_MICROMETER_USER_TAGS, "tag1=value1,tag2=value2");
-    cfg.setProperty(Property.GENERAL_MICROMETER_CACHE_METRICS_ENABLED, "true");
     cfg.setProperty(Property.GENERAL_MICROMETER_JVM_METRICS_ENABLED, "true");
     cfg.setProperty("general.custom.metrics.opts.logging.step", "10s");
     String clazzList = LoggingMeterRegistryFactory.class.getName() + ","

test/src/main/java/org/apache/accumulo/test/metrics/MetricsThriftRpcIT.java

@@ -71,7 +71,6 @@ protected void configure(MiniAccumuloConfigImpl cfg, Configuration hadoopCoreSit
     cfg.setProperty(Property.MANAGER_FATE_METRICS_MIN_UPDATE_INTERVAL, "1s");
     cfg.setProperty(Property.GENERAL_MICROMETER_ENABLED, "true");
     cfg.setProperty(Property.GENERAL_MICROMETER_USER_TAGS, "tag1=value1,tag2=value2");
-    cfg.setProperty(Property.GENERAL_MICROMETER_CACHE_METRICS_ENABLED, "true");
     cfg.setProperty(Property.GENERAL_MICROMETER_JVM_METRICS_ENABLED, "true");
     cfg.getClusterServerConfiguration().setNumDefaultCompactors(1);
     cfg.getClusterServerConfiguration().setNumDefaultScanServers(1);