This is an automated email from the ASF dual-hosted git repository.
dineshkumar pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/ranger.git
The following commit(s) were added to refs/heads/master by this push:
new 29d2848f0 RANGER-5452: Ranger Admin - Add summary to metrics API (#811)
29d2848f0 is described below
commit 29d2848f0932365f7fdcebfc552921fe9ddb95b5
Author: Rakesh Gupta <[email protected]>
AuthorDate: Wed Jan 28 13:01:04 2026 +0530
RANGER-5452: Ranger Admin - Add summary to metrics API (#811)
---
.../ranger/metrics/RangerAdminMetricsWrapper.java | 7 ++++
.../ranger/metrics/RangerMetricsFetcher.java | 40 +++++++++++++++++++-
.../source/RangerAdminMetricsSourceSummary.java | 43 ++++++++++++++++++++++
3 files changed, 89 insertions(+), 1 deletion(-)
diff --git
a/security-admin/src/main/java/org/apache/ranger/metrics/RangerAdminMetricsWrapper.java
b/security-admin/src/main/java/org/apache/ranger/metrics/RangerAdminMetricsWrapper.java
index f3265c1fd..42ad39efd 100644
---
a/security-admin/src/main/java/org/apache/ranger/metrics/RangerAdminMetricsWrapper.java
+++
b/security-admin/src/main/java/org/apache/ranger/metrics/RangerAdminMetricsWrapper.java
@@ -25,6 +25,7 @@
import
org.apache.ranger.metrics.source.RangerAdminMetricsSourcePolicyResourceAccess;
import
org.apache.ranger.metrics.source.RangerAdminMetricsSourcePolicyRowFiltering;
import org.apache.ranger.metrics.source.RangerAdminMetricsSourceService;
+import org.apache.ranger.metrics.source.RangerAdminMetricsSourceSummary;
import org.apache.ranger.metrics.source.RangerAdminMetricsSourceUserGroup;
import org.apache.ranger.metrics.wrapper.RangerMetricsSourceWrapper;
import org.slf4j.Logger;
@@ -68,6 +69,9 @@ public class RangerAdminMetricsWrapper {
@Autowired
private RangerAdminMetricsSourceDenyConditions denyConditionSource;
+ @Autowired
+ private RangerAdminMetricsSourceSummary summarySource;
+
@PostConstruct
public void init() {
LOG.info("===>> RangerAdminMetricsWrapper.init()");
@@ -93,6 +97,9 @@ public void init() {
//Source: DenyConditionService
sourceWrappers.add(new
RangerMetricsSourceWrapper("RangerAdminMetricsSourceDenyConditionService",
"Deny Condition in Ranger Admin", context, denyConditionSource));
+ //Source: Summary
+ sourceWrappers.add(new
RangerMetricsSourceWrapper("RangerAdminMetricsSourceSummary", "Summary in
Ranger Admin", context, summarySource));
+
rangerMetricsSystemWrapper.init(context, sourceWrappers,
Collections.emptyList());
} catch (Exception e) {
LOG.error("RangerAdminMetricsWrapper: Exception occured while
initializing Metric Starter:", e);
diff --git
a/security-admin/src/main/java/org/apache/ranger/metrics/RangerMetricsFetcher.java
b/security-admin/src/main/java/org/apache/ranger/metrics/RangerMetricsFetcher.java
index 975f4e07d..d8ec1426b 100644
---
a/security-admin/src/main/java/org/apache/ranger/metrics/RangerMetricsFetcher.java
+++
b/security-admin/src/main/java/org/apache/ranger/metrics/RangerMetricsFetcher.java
@@ -22,6 +22,7 @@
import org.apache.ranger.biz.ServiceDBStore;
import org.apache.ranger.biz.XUserMgr;
import org.apache.ranger.common.RangerConstants;
+import org.apache.ranger.db.RangerDaoManager;
import org.apache.ranger.service.XGroupService;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@@ -49,8 +50,16 @@ public class RangerMetricsFetcher {
@Autowired
private XGroupService groupService;
+ @Autowired
+ RangerDaoManager daoMgr;
+
+ private final HashMap<String, Long> summaryReusable = new HashMap<>();
+ private final HashMap<Integer, Long> summaryPolicy = new HashMap<>();
+
public Long getGroupCount() {
- return groupService.getAllGroupCount();
+ Long totalGroupCount = groupService.getAllGroupCount();
+ summaryReusable.put("TotalGroups", totalGroupCount);
+ return totalGroupCount;
}
public Map<String, Long> getUserMetrics() {
@@ -84,6 +93,8 @@ public Map<String, Long> getUserMetrics() {
}
ret.put("Total", total);
+ summaryReusable.put("TotalUsers", total);
+ summaryReusable.put("TotalRoles", (ret.size() - 1L));
return ret;
}
@@ -99,6 +110,7 @@ public Map<String, Long> getRangerServiceMetrics() {
}
ret.put("Total", total);
+ summaryReusable.put("TotalServices", total);
return ret;
}
@@ -113,9 +125,14 @@ public Map<String, Long> getPolicyMetrics(Integer
policyType) {
ret.put(entry.getKey(), entry.getValue());
total += entry.getValue();
+
+ if ("tag".equalsIgnoreCase(entry.getKey())) {
+ summaryReusable.put("TotalTags", entry.getValue());
+ }
}
ret.put("Total", total);
+ summaryPolicy.put(policyType, total);
return ret;
}
@@ -149,4 +166,25 @@ public Map<String, Long> getContextEnrichersMetrics() {
return ret;
}
+
+ public Map<String, Long> getSummary() {
+ Map<String, Long> ret = new HashMap<>(summaryReusable);
+
+ //policies
+ ret.put("TotalPolicies",
summaryPolicy.values().stream().mapToLong(Long::longValue).sum());
+
+ //x_trx_log_v2
+ ret.put("TotalAdminAudits", daoMgr.getXXTrxLogV2().getAllCount());
+
+ //x_auth_sess
+ ret.put("TotalLogins", daoMgr.getXXAuthSession().getAllCount());
+
+ //x_plugin_info
+ ret.put("TotalPlugins", daoMgr.getXXPluginInfo().getAllCount());
+
+ //x_policy_export_audit
+ ret.put("TotalPluginDownloads",
daoMgr.getXXPolicyExportAudit().getAllCount());
+
+ return ret;
+ }
}
diff --git
a/security-admin/src/main/java/org/apache/ranger/metrics/source/RangerAdminMetricsSourceSummary.java
b/security-admin/src/main/java/org/apache/ranger/metrics/source/RangerAdminMetricsSourceSummary.java
new file mode 100644
index 000000000..196397cee
--- /dev/null
+++
b/security-admin/src/main/java/org/apache/ranger/metrics/source/RangerAdminMetricsSourceSummary.java
@@ -0,0 +1,43 @@
+/*
+ * 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.ranger.metrics.source;
+
+import org.apache.ranger.metrics.RangerMetricsFetcher;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.stereotype.Component;
+
+import java.util.Map;
+
+@Component
+public class RangerAdminMetricsSourceSummary extends
RangerAdminMetricsSourceBase {
+ @Autowired
+ private RangerMetricsFetcher rangerMetricsFetcher;
+
+ public RangerAdminMetricsSourceSummary() {
+ super("admin", "Summary");
+ }
+
+ @Override
+ protected void refresh() {
+ Map<String, Long> userGroupMetrics = rangerMetricsFetcher.getSummary();
+
+ addMetricEntries("Summary", userGroupMetrics);
+ }
+}
