Initial impl for business analytics for prometheus metrics

gateway/enforcer/org.wso2.apk.enforcer.analytics.publishers/src/main/java/org/wso2/apk/enforcer/analytics/publisher/jmx/JMXUtils.java

@@ -0,0 +1,34 @@
+/*
+ *  Copyright (c) 2024, WSO2 LLC. (http://www.wso2.org) All Rights Reserved.
+ *
+ *  Licensed 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.wso2.apk.enforcer.analytics.publisher.jmx;
+
+/**
+ * JMX Utilities
+ */
+public class JMXUtils {
+
+    private static final String APK_JMX_METRICS_ENABLE = "apk.jmx.metrics.enabled";
+
+    /**
+     * Returns true if jmx metrics enabled as a system property, otherwise false.
+     * 
+     * @return boolean
+     */
+    public static boolean isJMXMetricsEnabled() {
+        return Boolean.getBoolean(APK_JMX_METRICS_ENABLE);
+    }
+}

gateway/enforcer/org.wso2.apk.enforcer.analytics.publishers/src/main/java/org/wso2/apk/enforcer/analytics/publisher/jmx/MBeanManagementFactory.java

@@ -0,0 +1,42 @@
+/*
+ *  Copyright (c) 2024, WSO2 LLC. (http://www.wso2.org) All Rights Reserved.
+ *
+ *  Licensed 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.wso2.apk.enforcer.analytics.publisher.jmx;
+
+import javax.management.MBeanServer;
+import javax.management.MBeanServerFactory;
+
+/**
+ * The ManagementFactory class is a factory class for getting managed beans for
+ * the Enforcer.
+ */
+public class MBeanManagementFactory {
+
+    /*
+     * If one already exists, it will return that else it will create a new one and
+     * return.
+     * 
+     * @return A MBeanServer instance.
+     */
+    public static MBeanServer getMBeanServer() {
+        MBeanServer mBeanServer;
+        if (MBeanServerFactory.findMBeanServer(null).size() > 0) {
+            mBeanServer = MBeanServerFactory.findMBeanServer(null).get(0);
+        } else {
+            mBeanServer = MBeanServerFactory.createMBeanServer();
+        }
+        return mBeanServer;
+    }
+}

gateway/enforcer/org.wso2.apk.enforcer.analytics.publishers/src/main/java/org/wso2/apk/enforcer/analytics/publisher/jmx/MBeanRegistrator.java

@@ -0,0 +1,137 @@
+/*
+ *  Copyright (c) 2022, WSO2 LLC. (http://www.wso2.org) All Rights Reserved.
+ *
+ *  Licensed 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.wso2.apk.enforcer.analytics.publisher.jmx;
+
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
+import org.wso2.apk.enforcer.analytics.publisher.jmx.impl.ExtAuthMetrics;
+import org.wso2.apk.enforcer.analytics.publisher.reporter.prometheus.APIInvocationEvent;
+
+import javax.management.*;
+import java.io.UnsupportedEncodingException;
+import java.net.URLEncoder;
+import java.nio.charset.StandardCharsets;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Set;
+
+/**
+ * The class which is responsible for registering MBeans.
+ */
+public class MBeanRegistrator {
+    private static final Log logger = LogFactory.getLog(MBeanRegistrator.class);
+    private static List<ObjectName> mBeans = new ArrayList<>();
+
+    private static final String SERVER_PACKAGE = "org.wso2.apk.enforcer.analytics";
+
+    private MBeanRegistrator() {
+    }
+
+    /**
+     * Registers an object as an MBean with the MBean server.
+     *
+     * @param mBeanInstance - The MBean to be registered as an MBean.
+     */
+    public static void registerMBean(Object mBeanInstance, APIInvocationEvent event) throws RuntimeException, UnsupportedEncodingException {
+
+        if (JMXUtils.isJMXMetricsEnabled()) {
+            String className = mBeanInstance.getClass().getName();
+            if (className.indexOf('.') != -1) {
+                className = className.substring(className.lastIndexOf('.') + 1);
+            }
+
+            ExtAuthMetrics extAuthMetrics = (ExtAuthMetrics) mBeanInstance;
+            logger.info("extAuthMetrics Object data: " + extAuthMetrics.toString());
+            //logger.info("extAuthMetrics Object api name: " + extAuthMetrics.getApiName());
+
+            String objectName = String.format(
+                    "%s:type=%s,apiName=%s,apiContext=%s,proxyResponseCode=%d," +
+                            "destination=%s,apiCreatorTenantDomain=%s,platform=%s," +
+                            "organizationId=%s,apiMethod=%s,apiVersion=%s,environmentId=%s," +
+                            "gatewayType=%s,apiCreator=%s,responseCacheHit=%b,backendLatency=%d," +
+                            "correlationId=%s,requestMediationLatency=%d,keyType=%s,apiId=%s," +
+                            "applicationName=%s,targetResponseCode=%d,applicationOwner=%s," +
+                            "userAgent=%s,userName=%s,apiResourceTemplate=%s,regionId=%s,responseLatency=%d," +
+                            "responseMediationLatency=%d,userIp=%s,applicationId=%s,apiType=%s,xOriginalGwUrl=%s",
+                    SERVER_PACKAGE,
+                    className,
+                    event.getApiName(),
+                    event.getApiContext(),
+                    event.getProxyResponseCode(),
+                    URLEncoder.encode(event.getDestination(), StandardCharsets.UTF_8.toString()),
+                    event.getApiCreatorTenantDomain(),
+                    event.getPlatform(),
+                    event.getOrganizationId(),
+                    event.getApiMethod(),
+                    event.getApiVersion(),
+                    event.getEnvironmentId(),
+                    event.getGatewayType(),
+                    event.getApiCreator(),
+                    event.isResponseCacheHit(),
+                    event.getBackendLatency(),
+                    event.getCorrelationId(),
+                    event.getRequestMediationLatency(),
+                    event.getKeyType(),
+                    event.getApiId(),
+                    "Resident Key Manager",
+                    event.getTargetResponseCode(),
+                    event.getApplicationOwner(),
+                    event.getUserAgent(),
+                    event.getUserName(),
+                    event.getApiResourceTemplate(),
+                    event.getRegionId(),
+                    event.getResponseLatency(),
+                    event.getResponseMediationLatency(),
+                    event.getUserIp(),
+                    event.getApplicationId(),
+                    event.getApiType(),
+                    URLEncoder.encode(event.getProperties().get("x-original-gw-url"), StandardCharsets.UTF_8.toString())
+            );
+            logger.info("Registering MBean with object name: " + objectName);
+            try {
+                MBeanServer mBeanServer = MBeanManagementFactory.getMBeanServer();
+                Set set = mBeanServer.queryNames(new ObjectName(objectName), null);
+                if (set.isEmpty()) {
+                    try {
+                        ObjectName name = new ObjectName(objectName);
+                        mBeanServer.registerMBean(mBeanInstance, name);
+                        mBeans.add(name);
+                        logger.info("MBean registered successfully with object name: " + name);
+                        logger.info("Mbeans: " + mBeans);
+                    } catch (InstanceAlreadyExistsException e) {
+                        String msg = "MBean " + objectName + " already exists";
+                        logger.error(msg, e);
+                        throw new RuntimeException(msg, e);
+                    } catch (MBeanRegistrationException | NotCompliantMBeanException e) {
+                        String msg = "Execption when registering MBean";
+                        logger.error(msg, e);
+                        throw new RuntimeException(msg, e);
+                    }
+                } else {
+                    String msg = "MBean " + objectName + " already exists";
+                    logger.error(msg);
+                    throw new RuntimeException(msg);
+                }
+            } catch (MalformedObjectNameException e) {
+                String msg = "Could not register " + mBeanInstance.getClass() + " MBean";
+                logger.error(msg, e);
+                throw new RuntimeException(msg, e);
+            }
+        } else {
+            logger.debug("JMX Metrics should be enabled to register MBean instance: {}");
+        }
+    }
+}

gateway/enforcer/org.wso2.apk.enforcer.analytics.publishers/src/main/java/org/wso2/apk/enforcer/analytics/publisher/jmx/api/ExtAuthMetricsMXBean.java

@@ -0,0 +1,26 @@
+/*
+ *  Copyright (c) 2024, WSO2 LLC. (http://www.wso2.org) All Rights Reserved.
+ *
+ *  Licensed 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.wso2.apk.enforcer.analytics.publisher.jmx.api;
+
+/**
+ * MBean API for ExtAuth Service metrics.
+ */
+public interface ExtAuthMetricsMXBean {
+
+    public int getApiMessages();
+
+}

gateway/enforcer/org.wso2.apk.enforcer.analytics.publishers/src/main/java/org/wso2/apk/enforcer/analytics/publisher/jmx/impl/ExtAuthMetrics.java

@@ -0,0 +1,77 @@
+/*
+ *  Copyright (c) 2024, WSO2 LLC. (http://www.wso2.org) All Rights Reserved.
+ *
+ *  Licensed 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.wso2.apk.enforcer.analytics.publisher.jmx.impl;
+
+import org.wso2.apk.enforcer.analytics.publisher.jmx.MBeanRegistrator;
+import org.wso2.apk.enforcer.analytics.publisher.jmx.api.ExtAuthMetricsMXBean;
+import org.wso2.apk.enforcer.analytics.publisher.reporter.prometheus.APIInvocationEvent;
+
+import java.io.UnsupportedEncodingException;
+import java.util.Timer;
+import java.util.TimerTask;
+
+/**
+ * Singleton MBean for ExtAuth Service metrics.
+ */
+public class ExtAuthMetrics extends TimerTask implements ExtAuthMetricsMXBean {
+
+    private static final long REQUEST_COUNT_INTERVAL_MILLIS = 5 * 60 * 1000;
+    private static ExtAuthMetrics extAuthMetricsMBean = null;
+    private long requestCountInLastFiveMinuteWindow = 0;
+    private long requestCountWindowStartTimeMillis = System.currentTimeMillis();
+
+    private int apiMessages = 0;
+
+    private ExtAuthMetrics(APIInvocationEvent event) {
+        try {
+            MBeanRegistrator.registerMBean(this, event);
+        } catch (UnsupportedEncodingException e) {
+            throw new RuntimeException(e);
+        }
+    }
+
+/**
+ * Getter for the Singleton ExtAuthMetrics instance.
+ *
+ * @return ExtAuthMetrics
+ */
+public static ExtAuthMetrics getInstance(APIInvocationEvent event) {
+    Timer timer = new Timer();
+    extAuthMetricsMBean = new ExtAuthMetrics(event);
+    extAuthMetricsMBean.requestCountWindowStartTimeMillis = System.currentTimeMillis();
+    timer.schedule(extAuthMetricsMBean, REQUEST_COUNT_INTERVAL_MILLIS, REQUEST_COUNT_INTERVAL_MILLIS);
+    return extAuthMetricsMBean;
+}
+
+
+    @Override
+    public synchronized void run() {
+        requestCountWindowStartTimeMillis = System.currentTimeMillis();
+        requestCountInLastFiveMinuteWindow = 0;
+    }
+
+
+    public void recordApiMessages() {
+        apiMessages++;;
+    }
+
+    @Override
+    public int getApiMessages() {
+        return apiMessages;
+    }
+
+}