Enhancement Request 37293266 - [35017063->24.09.1] ENH: Improve resetStatistics capability for all or for selection of services in the cluster (merge ce/main -> 24.09.1 @ 112448)

[git-p4: depot-paths = "//dev/coherence-ce/release/coherence-ce-v24.09/": change = 112452]

Author: vasac

prj/coherence-core-components/src/main/java/com/tangosol/coherence/component/manageable/modelAdapter/ManagementMBean.java

@@ -1,6 +1,6 @@
 
 /*
- * Copyright (c) 2000, 2023, Oracle and/or its affiliates.
+ * Copyright (c) 2000, 2024, Oracle and/or its affiliates.
  *
  * Licensed under the Universal Permissive License v 1.0 as shown at
  * https://oss.oracle.com/licenses/upl.
@@ -260,6 +260,19 @@ protected java.util.Map get_MethodInfo()
                 });
             }
 
+        // behavior resetStatistics()
+            {
+            mapInfo.put("resetStatistics(Ljava.lang.String;)", new Object[]
+                {
+                "Call resetStatistics on each mbeans returned by the query.",
+                "resetStatistics",
+                "[Ljava.lang.String;",
+                new String[] {"sName", },
+                new String[] {"Ljava.lang.String;", },
+                null,
+                });
+            }
+
         return mapInfo;
         }
 

prj/coherence-core-components/src/main/java/com/tangosol/coherence/component/net/management/model/localModel/ManagementModel.java

@@ -1,6 +1,6 @@
 
 /*
- * Copyright (c) 2000, 2023, Oracle and/or its affiliates.
+ * Copyright (c) 2000, 2024, Oracle and/or its affiliates.
  *
  * Licensed under the Universal Permissive License v 1.0 as shown at
  * https://oss.oracle.com/licenses/upl.
@@ -12,6 +12,20 @@
 
 import com.tangosol.coherence.component.net.management.Connector;
 
+import com.tangosol.net.management.MBeanHelper;
+
+import com.oracle.coherence.common.base.Logger;
+
+import javax.management.InstanceNotFoundException;
+import javax.management.MBeanException;
+import javax.management.MBeanServer;
+import javax.management.ObjectInstance;
+import javax.management.ObjectName;
+import javax.management.ReflectionException;
+
+import java.util.ArrayList;
+import java.util.Set;
+
 /**
  * Model components implement the JMX-managed functionality of the
  * corresponding MBeans without being dependent on any JMX classes and could be
@@ -261,6 +275,43 @@ public void resetStatistics()
         {
         get_Connector().resetStatistics();
         }
+
+    public String[] resetStatistics(String sName)
+        {
+        ArrayList<String> result = new ArrayList<>();
+        try
+            {
+            MBeanServer server = MBeanHelper.findMBeanServer();
+            ObjectName objectName = new ObjectName(sName);
+            Set<ObjectInstance> instances = server.queryMBeans(objectName, null);
+            for (ObjectInstance instance : instances)
+                {
+                try
+                    {
+                    server.invoke(instance.getObjectName(), "resetStatistics", new Object[0], new String[0]);
+                    result.add(instance.getObjectName() + " OK");
+                    }
+                catch (InstanceNotFoundException | MBeanException | ReflectionException e)
+                    {
+                    Throwable t = rootCause(e);
+                    result.add(instance.getObjectName() + " ERROR: " + t.getMessage());
+                    }
+                catch (Throwable e)
+                    {
+                    Throwable t = rootCause(e);
+                    result.add(instance.getObjectName() + " ERROR: " + t.getMessage());
+                    }
+                }
+            }
+        catch (Throwable e)
+            {
+            Throwable t = rootCause(e);
+            Logger.warn("Failed to execute query \"" + sName + "\"; " + t);
+            result.add("Error: " + t.getMessage());
+            }
+
+        return result.toArray(new String[0]);
+        }
 
     // Accessor for the property "_Connector"
     /**
@@ -312,4 +363,16 @@ public void writeExternal(java.io.DataOutput out)
         {
         throw new IllegalStateException("ManagementModel is not global");
         }
+
+    private static Throwable rootCause(Throwable t)
+        {
+        Throwable rootCause = t;
+        Throwable cause     = t.getCause();
+        while (cause != null)
+            {
+            rootCause = cause;
+            cause     = cause.getCause();
+            }
+        return rootCause;
+        }
     }

prj/coherence-core/src/main/java/com/tangosol/internal/management/resources/ClusterResource.java

@@ -279,6 +279,20 @@ public Response executeOperation(HttpRequest request)
         if ("shutdown".equals(sOperationName) || "resetStatistics".equals(sOperationName)
              || "logNodeState".equals(sOperationName))
             {
+            if ("resetStatistics".equals(sOperationName))
+                {
+                Map<String, Object> mapQuery = getJsonBody(request);
+                String              query    = (String) mapQuery.get("query");
+                if (query != null && !query.isBlank())
+                    {
+                    return response(getResponseFromMBeanOperation(request,
+                                                 getManagementQuery(request),
+                                                 "result",
+                                                 sOperationName,
+                                                 new Object[] {query},
+                                                 new String[] {String.class.getName()}));
+                    }
+                }
             return executeMBeanOperation(request, getMembersQuery(request), sOperationName,
                     null, null);
             }

prj/coherence-core/src/main/resources/management-swagger.json

@@ -388,14 +388,41 @@
           "Cluster"
         ],
         "summary": "Reset Member Statistics for all the members",
-        "description": "Use this endpoint to clear the current statistics for all the members.",
+        "description": "Use this endpoint to clear the current statistics for all the members.\nThis end point also takes an ObjectName pattern (query) to allow you to control\n the MBeans to reset. For example, if you want to reset all the MBeans in\n the cluster, use pattern \"Coherence:type=*\" (for MBeans that don't support\n statistics reset an error will be returned). If you want to reset all the\n cache MBeans, pattern \"Coherence:type=Cache,*\". Pattern should be passed as\n a json object in the request body\n Example: {\"query\": \"Coherence:type=Service,name=DistributedCachePersistence,nodeId=1\"} - reset statistics on a specific service and member\n\n",
         "operationId": "/management/coherence/cluster/resetStatistics POST",
+        "consumes": [
+          "application/json"
+        ],
+        "parameters": [{
+          "in": "body",
+          "name": "query",
+          "description": "ObjectName pattern to search for.",
+          "schema": {
+            "type": "object",
+            "properties": {
+              "query": {
+                "type": "string"
+              }
+            }
+          }
+        }],
         "produces": [
           "application/json"
         ],
         "responses": {
           "200": {
-            "description": "Command invocation is successful"
+            "description": "It returns a collection of the status for all the MBeans that were reset.",
+            "schema": {
+              "type": "object",
+              "properties": {
+                "result": {
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  }
+                }
+              }
+            }
           }
         }
       }

prj/test/functional/management/src/main/java/management/BaseManagementInfoResourceTests.java

@@ -941,6 +941,34 @@ public void testMemberResetStats()
         assertThat(response.getStatus(), is(Response.Status.OK.getStatusCode()));
         }
 
+    @Test
+    public void testResetStatsQuery()
+        {
+        WebTarget target   = getBaseTarget();
+        Response  response = target.request().get();
+
+        assertThat(response.getStatus(), is(Response.Status.OK.getStatusCode()));
+        assertThat(response.getHeaderString("X-Content-Type-Options"), is("nosniff"));
+        Map mapResponse = readEntity(target, response);
+
+        List<Number> listMemberIds = (List<Number>) mapResponse.get("memberIds");
+
+        assertThat(listMemberIds, notNullValue());
+        assertThat(listMemberIds.size(), greaterThan(0));
+
+        Map<String, String> entity = new LinkedHashMap<>();
+        entity.put("query", "Coherence:type=Cache,*");
+        response = getBaseTarget()
+                .path("resetStatistics").request(MediaType.APPLICATION_JSON_TYPE)
+                .post(Entity.entity(entity, MediaType.APPLICATION_JSON_TYPE));
+
+        assertThat(response.getStatus(), is(Response.Status.OK.getStatusCode()));
+        Map r = readEntity(target, response);
+        List<String> result = (List) r.get("result");
+        assertThat(result.size(), greaterThan(0));
+        assertTrue(result.stream().anyMatch(s -> s.contains("Coherence:type=Cache") && s.endsWith("OK")));
+        }
+
     @Test
     public void testProxyConnectionManagerResetStats()
         {