Added descriptions to endpoints, fixed compaction topN endpoint

Author: dlmarion

.gitattributes

@@ -18,3 +18,4 @@
 #
 
 core/src/main/thrift-gen-java/** linguist-generated=true
+core/src/main/flatbuffers-gen-java/** linguist-generated=true

server/manager/src/main/java/org/apache/accumulo/manager/compaction/coordinator/CompactionCoordinator.java

@@ -1130,11 +1130,12 @@ public TExternalCompactionMap getRunningCompactions(TInfo tinfo, TCredentials cr
   }
 
   /**
-   * Return topN longest running compactions for each resource group
+   * Return top 50 longest running compactions for each resource group
    *
    * @param tinfo trace info
    * @param credentials tcredentials object
-   * @return map of group name to list of compactions in sorted order, oldest compaction first.
+   * @return map of group name to list of up to 50 compactions in sorted order, oldest compaction
+   *         first.
    * @throws ThriftSecurityException permission error
    */
   @Override

server/monitor/src/main/java/org/apache/accumulo/monitor/next/Endpoints.java

@@ -18,12 +18,16 @@
  */
 package org.apache.accumulo.monitor.next;
 
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
 import java.lang.reflect.Method;
 import java.util.Collection;
-import java.util.HashSet;
 import java.util.List;
 import java.util.Map;
 import java.util.Set;
+import java.util.TreeMap;
 import java.util.stream.Collectors;
 
 import jakarta.inject.Inject;
@@ -53,6 +57,12 @@
 @Path("/")
 public class Endpoints {
 
+  @Target(ElementType.METHOD)
+  @Retention(RetentionPolicy.RUNTIME)
+  public @interface Description {
+    String value();
+  }
+
   @Inject
   private Monitor monitor;
 
@@ -66,45 +76,61 @@ private void validateResourceGroup(String resourceGroup) {
   @GET
   @Path("endpoints")
   @Produces(MediaType.APPLICATION_JSON)
-  public Set<String> getEndpoints(@Context HttpServletRequest request) {
-
+  @Description("Returns a list of the available endpoints and a description for each")
+  public Map<String,String> getEndpoints(@Context HttpServletRequest request) {
+
+    /**
+     * Attemtped to use OpenAPI annotation for use with Swagger-UI, but ran into potential
+     * dependency convergence issues as we were using newer version of some of the same
+     * dependencies.
+     */
     final String basePath = request.getRequestURL().toString();
-    final Set<String> endpoints = new HashSet<>();
+    final Map<String,String> documentation = new TreeMap<>();
 
     for (Method m : Endpoints.class.getMethods()) {
       if (m.isAnnotationPresent(Path.class)) {
         Path pathAnnotation = m.getAnnotation(Path.class);
-        endpoints.add(basePath + "/" + pathAnnotation.value());
+        String path = basePath + "/" + pathAnnotation.value();
+        String description = "";
+        if (m.isAnnotationPresent(Description.class)) {
+          Description desc = m.getAnnotation(Description.class);
+          description = desc.value();
+        }
+        documentation.put(path, description);
       }
     }
 
-    return endpoints;
+    return documentation;
   }
 
   @GET
   @Path("groups")
   @Produces(MediaType.APPLICATION_JSON)
+  @Description("Returns a list of the resource groups that are in use")
   public Set<String> getResourceGroups() {
     return monitor.getInformationFetcher().getSummary().getResourceGroups();
   }
 
   @GET
   @Path("problems")
   @Produces(MediaType.APPLICATION_JSON)
+  @Description("Returns a list of the servers that are potentially down")
   public Collection<ServerId> getProblemHosts() {
     return monitor.getInformationFetcher().getSummary().getProblemHosts();
   }
 
   @GET
   @Path("metrics")
   @Produces(MediaType.APPLICATION_JSON)
+  @Description("Returns the metric responses for all servers")
   public Collection<MetricResponse> getAll() {
     return monitor.getInformationFetcher().getAllMetrics().asMap().values();
   }
 
   @GET
   @Path("manager")
   @Produces(MediaType.APPLICATION_JSON)
+  @Description("Returns the metric response for the Manager")
   public MetricResponse getManager() {
     final ServerId s = monitor.getInformationFetcher().getSummary().getManager();
     if (s == null) {
@@ -116,6 +142,7 @@ public MetricResponse getManager() {
   @GET
   @Path("gc")
   @Produces(MediaType.APPLICATION_JSON)
+  @Description("Returns the metric response for the Garbage Collector")
   public MetricResponse getGarbageCollector() {
     final ServerId s = monitor.getInformationFetcher().getSummary().getGarbageCollector();
     if (s == null) {
@@ -127,6 +154,7 @@ public MetricResponse getGarbageCollector() {
   @GET
   @Path("instance")
   @Produces(MediaType.APPLICATION_JSON)
+  @Description("Returns the instance name, instance id, version, zookeepers, and volumes")
   public InstanceSummary getInstanceSummary() {
     return new InstanceSummary(monitor.getContext().getInstanceName(),
         monitor.getContext().instanceOperations().getInstanceId().canonical(),
@@ -139,6 +167,7 @@ public InstanceSummary getInstanceSummary() {
   @GET
   @Path("compactors/detail/{group}")
   @Produces(MediaType.APPLICATION_JSON)
+  @Description("Returns the metric responses for the Compactors in the supplied resource group")
   public Collection<MetricResponse> getCompactors(@PathParam("group") String resourceGroup) {
     validateResourceGroup(resourceGroup);
     final Set<ServerId> servers = monitor.getInformationFetcher().getSummary()
@@ -152,6 +181,7 @@ public Collection<MetricResponse> getCompactors(@PathParam("group") String resou
   @GET
   @Path("compactors/summary/{group}")
   @Produces(MediaType.APPLICATION_JSON)
+  @Description("Returns an aggregate view of the metric responses for the Compactors in the supplied resource group")
   public Map<Id,CumulativeDistributionSummary>
       getCompactorResourceGroupMetricSummary(@PathParam("group") String resourceGroup) {
     validateResourceGroup(resourceGroup);
@@ -166,13 +196,15 @@ public Collection<MetricResponse> getCompactors(@PathParam("group") String resou
   @GET
   @Path("compactors/summary")
   @Produces(MediaType.APPLICATION_JSON)
+  @Description("Returns an aggregate view of the metric responses for all Compactors")
   public Map<Id,CumulativeDistributionSummary> getCompactorAllMetricSummary() {
     return monitor.getInformationFetcher().getSummary().getCompactorAllMetricSummary();
   }
 
   @GET
   @Path("sservers/detail/{group}")
   @Produces(MediaType.APPLICATION_JSON)
+  @Description("Returns the metric responses for the ScanServers in the supplied resource group")
   public Collection<MetricResponse> getScanServers(@PathParam("group") String resourceGroup) {
     validateResourceGroup(resourceGroup);
     final Set<ServerId> servers =
@@ -186,6 +218,7 @@ public Collection<MetricResponse> getScanServers(@PathParam("group") String reso
   @GET
   @Path("sservers/summary/{group}")
   @Produces(MediaType.APPLICATION_JSON)
+  @Description("Returns an aggregate view of the metric responses for the ScanServers in the supplied resource group")
   public Map<Id,CumulativeDistributionSummary>
       getScanServerResourceGroupMetricSummary(@PathParam("group") String resourceGroup) {
     validateResourceGroup(resourceGroup);
@@ -200,13 +233,15 @@ public Collection<MetricResponse> getScanServers(@PathParam("group") String reso
   @GET
   @Path("sservers/summary")
   @Produces(MediaType.APPLICATION_JSON)
+  @Description("Returns an aggregate view of the metric responses for all ScanServers")
   public Map<Id,CumulativeDistributionSummary> getScanServerAllMetricSummary() {
     return monitor.getInformationFetcher().getSummary().getSServerAllMetricSummary();
   }
 
   @GET
   @Path("tservers/detail/{group}")
   @Produces(MediaType.APPLICATION_JSON)
+  @Description("Returns the metric responses for the TabletServers in the supplied resource group")
   public Collection<MetricResponse> getTabletServers(@PathParam("group") String resourceGroup) {
     validateResourceGroup(resourceGroup);
     final Set<ServerId> servers =
@@ -220,6 +255,7 @@ public Collection<MetricResponse> getTabletServers(@PathParam("group") String re
   @GET
   @Path("tservers/summary/{group}")
   @Produces(MediaType.APPLICATION_JSON)
+  @Description("Returns an aggregate view of the metric responses for the TabletServers in the supplied resource group")
   public Map<Id,CumulativeDistributionSummary>
       getTabletServerResourceGroupMetricSummary(@PathParam("group") String resourceGroup) {
     validateResourceGroup(resourceGroup);
@@ -234,41 +270,58 @@ public Collection<MetricResponse> getTabletServers(@PathParam("group") String re
   @GET
   @Path("tservers/summary")
   @Produces(MediaType.APPLICATION_JSON)
+  @Description("Returns an aggregate view of the metric responses for all TabletServers")
   public Map<Id,CumulativeDistributionSummary> getTabletServerAllMetricSummary() {
     return monitor.getInformationFetcher().getSummary().getTServerAllMetricSummary();
   }
 
   @GET
   @Path("compactions/summary")
   @Produces(MediaType.APPLICATION_JSON)
+  @Description("Returns the metrics for all compaction queues")
   public Map<String,List<FMetric>> getCompactionMetricSummary() {
     return monitor.getInformationFetcher().getSummary().getCompactionMetricSummary();
   }
 
   @GET
   @Path("compactions/detail")
   @Produces(MediaType.APPLICATION_JSON)
+  @Description("Returns a map of Compactor resource group to the 50 oldest running compactions")
   public Map<String,List<TExternalCompaction>> getCompactions() {
-    return monitor.getInformationFetcher().getSummary().getCompactions(25);
+    Map<String,List<TExternalCompaction>> all =
+        monitor.getInformationFetcher().getSummary().getCompactions();
+    if (all == null) {
+      return Map.of();
+    }
+    return all;
   }
 
   @GET
-  @Path("compactions/detail/{num}")
+  @Path("compactions/detail/{group}")
   @Produces(MediaType.APPLICATION_JSON)
-  public Map<String,List<TExternalCompaction>> getCompactions(@PathParam("num") int topN) {
-    return monitor.getInformationFetcher().getSummary().getCompactions(topN);
+  @Description("Returns a list of the 50 oldest running compactions in the supplied resource group")
+  public List<TExternalCompaction> getCompactions(@PathParam("group") String resourceGroup) {
+    validateResourceGroup(resourceGroup);
+    List<TExternalCompaction> compactions =
+        monitor.getInformationFetcher().getSummary().getCompactions(resourceGroup);
+    if (compactions == null) {
+      return List.of();
+    }
+    return compactions;
   }
 
   @GET
   @Path("tables")
   @Produces(MediaType.APPLICATION_JSON)
+  @Description("Returns a map of table name to table details")
   public Map<String,TableSummary> getTables() {
     return monitor.getInformationFetcher().getSummary().getTables();
   }
 
   @GET
   @Path("tables/{name}")
   @Produces(MediaType.APPLICATION_JSON)
+  @Description("Returns table details for the supplied table name")
   public TableSummary getTable(@PathParam("name") String tableName) {
     TableSummary ts = monitor.getInformationFetcher().getSummary().getTables().get(tableName);
     if (ts == null) {
@@ -280,6 +333,7 @@ public TableSummary getTable(@PathParam("name") String tableName) {
   @GET
   @Path("tables/{name}/tablets")
   @Produces(MediaType.APPLICATION_JSON)
+  @Description("Returns tablet details for the supplied table name")
   public List<TabletInformation> getTablets(@PathParam("name") String tableName) {
     List<TabletInformation> ti = monitor.getInformationFetcher().getSummary().getTablets(tableName);
     if (ti == null) {
@@ -291,27 +345,32 @@ public List<TabletInformation> getTablets(@PathParam("name") String tableName) {
   @GET
   @Path("deployment")
   @Produces(MediaType.APPLICATION_JSON)
+  @Description("Returns a map of resource group to server type to process summary."
+      + " The process summary contains the number of configured, responding, and not responding servers")
   public Map<String,Map<String,ProcessSummary>> getDeploymentOverview() {
     return monitor.getInformationFetcher().getSummary().getDeploymentOverview();
   }
 
   @GET
   @Path("suggestions")
   @Produces(MediaType.APPLICATION_JSON)
+  @Description("Returns a list of suggestions")
   public Set<String> getSuggestions() {
     return monitor.getInformationFetcher().getSummary().getSuggestions();
   }
 
   @GET
   @Path("lastUpdate")
   @Produces(MediaType.APPLICATION_JSON)
+  @Description("Returns the timestamp of when the monitor information was last refreshed")
   public long getTimestamp() {
     return monitor.getInformationFetcher().getSummary().getTimestamp();
   }
 
   @GET
   @Path("stats")
   @Produces(MediaType.TEXT_PLAIN)
+  @Description("Returns connection statistics for the Jetty server")
   public String getConnectionStatistics() {
     return monitor.getConnectionStatisticsBean().dump();
   }

server/monitor/src/main/java/org/apache/accumulo/monitor/next/SystemInformation.java

@@ -551,14 +551,14 @@ public Map<String,List<FMetric>> getCompactionMetricSummary() {
     return this.queueMetrics;
   }
 
-  public Map<String,List<TExternalCompaction>> getCompactions(int topN) {
-    Map<String,List<TExternalCompaction>> results = new HashMap<>();
+  public Map<String,List<TExternalCompaction>> getCompactions() {
 
     Map<String,TExternalCompactionList> oldest = oldestCompactions.get();
     if (oldest == null) {
-      return results;
+      return null;
     }
 
+    Map<String,List<TExternalCompaction>> results = new HashMap<>();
     for (Entry<String,TExternalCompactionList> e : oldest.entrySet()) {
       List<TExternalCompaction> compactions = e.getValue().getCompactions();
       if (compactions != null && compactions.size() > 0) {
@@ -568,6 +568,14 @@ public Map<String,List<TExternalCompaction>> getCompactions(int topN) {
     return results;
   }
 
+  public List<TExternalCompaction> getCompactions(String group) {
+    TExternalCompactionList list = oldestCompactions.get().get(group);
+    if (list == null) {
+      return null;
+    }
+    return list.getCompactions();
+  }
+
   public Map<String,TableSummary> getTables() {
     return this.tables;
   }