Merge pull request #33 from Cinimex-Informatica/feature/issue9_additional_metrics

Feature/issue9 additional metrics Resolves: #9

Author: echerniak

src/main/java/ru/cinimex/exporter/Config.java

@@ -20,10 +20,15 @@ public class Config {
     private String qmgrChannel;
     private String user;
     private String password;
-    private Boolean mqscp;
+    private boolean mqscp;
     private int endpPort;
     private String endpURL;
     private ArrayList<String> queues;
+    private ArrayList<String> channels;
+    private ArrayList<String> listeners;
+    private boolean sendPCFCommands;
+    private boolean usePCFWildcards;
+    private int scrapeInterval;
 
     public Config(String path) {
         Yaml file = new Yaml();
@@ -38,26 +43,48 @@ public Config(String path) {
         LinkedHashMap<String, Object> config = file.load(br);
         HashMap<String, Object> qmgrConnectionParams = (HashMap<String, Object>) config.get("qmgrConnectionParams");
         HashMap<String, Object> prometheusEndpointParams = (HashMap<String, Object>) config.get("prometheusEndpointParams");
+        HashMap<String, Object> pcfParameters = (HashMap<String, Object>) config.get("PCFParameters");
         this.qmgrName = (String) qmgrConnectionParams.get("qmgrName");
         this.qmgrHost = (String) qmgrConnectionParams.get("qmgrHost");
-        this.qmgrPort = (Integer) (qmgrConnectionParams.get("qmgrPort"));
+        this.qmgrPort = (Integer) qmgrConnectionParams.get("qmgrPort");
         this.qmgrChannel = (String) qmgrConnectionParams.get("qmgrChannel");
         this.user = (String) qmgrConnectionParams.get("user");
         this.password = (String) qmgrConnectionParams.get("password");
-        this.mqscp = (Boolean) qmgrConnectionParams.get("mqscp");
+        this.mqscp = (boolean) qmgrConnectionParams.get("mqscp");
         queues = (ArrayList<String>) config.get("queues");
-        this.endpPort = (Integer) (prometheusEndpointParams.get("port"));
+        listeners = (ArrayList<String>) config.get("listeners");
+        channels = (ArrayList<String>) config.get("channels");
+        this.endpPort = (Integer) prometheusEndpointParams.get("port");
         this.endpURL = (String) (prometheusEndpointParams.get("url"));
+        this.sendPCFCommands = (boolean) pcfParameters.get("sendPCFCommands");
+        this.usePCFWildcards = (boolean) pcfParameters.get("usePCFWildcards");
+        this.scrapeInterval = (Integer) pcfParameters.get("scrapeInterval");
     }
 
-    public Boolean getMqscp() {
+    public boolean useMqscp() {
         return mqscp;
     }
 
     public String getQmgrName() {
         return qmgrName;
     }
 
+    public boolean sendPCFCommands() {
+        return sendPCFCommands;
+    }
+
+    public boolean usePCFWildcards() {
+        return usePCFWildcards;
+    }
+
+    public ArrayList<String> getChannels() {
+        return channels;
+    }
+
+    public ArrayList<String> getListeners() {
+        return listeners;
+    }
+
     public String getQmgrHost() {
         return qmgrHost;
     }
@@ -66,6 +93,10 @@ public int getQmgrPort() {
         return qmgrPort;
     }
 
+    public int getScrapeInterval() {
+        return scrapeInterval;
+    }
+
     public String getQmgrChannel() {
         return qmgrChannel;
     }

src/main/java/ru/cinimex/exporter/ExporterLauncher.java

@@ -7,14 +7,15 @@
 import com.ibm.mq.constants.MQConstants;
 import com.ibm.mq.pcf.PCFMessage;
 import ru.cinimex.exporter.mq.MQConnection;
+import ru.cinimex.exporter.mq.MQObject;
 import ru.cinimex.exporter.mq.MQSubscriberManager;
 import ru.cinimex.exporter.mq.pcf.PCFClass;
 import ru.cinimex.exporter.mq.pcf.PCFDataParser;
 import ru.cinimex.exporter.mq.pcf.PCFElement;
 import ru.cinimex.exporter.mq.pcf.PCFType;
 import ru.cinimex.exporter.prometheus.HTTPServer;
 import ru.cinimex.exporter.prometheus.Registry;
-import ru.cinimex.exporter.prometheus.metrics.GaugeManager;
+import ru.cinimex.exporter.prometheus.metrics.MetricsManager;
 
 import java.io.IOException;
 import java.net.InetSocketAddress;
@@ -27,25 +28,49 @@ public class ExporterLauncher {
     private static final String topicString = "$SYS/MQ/INFO/QMGR/%s/Monitor/METADATA/CLASSES";
     private static final int getMsgOpt = MQConstants.MQGMO_WAIT | MQConstants.MQGMO_COMPLETE_MSG | MQConstants.MQGMO_SYNCPOINT;
 
-    public static void main(String[] args) {
+    public static void main(String[] args) throws MQException, IOException {
         if (args.length == 0) {
             System.err.println("It seems that you forgot to specify the path to the config file.");
             System.exit(1);
         }
         Config config = new Config(args[0]);
         try {
             ArrayList<PCFElement> elements = getAllPublishedMetrics(config);
-            GaugeManager.initGauges(elements);
-            MQSubscriberManager manager = new MQSubscriberManager(config.getQmgrHost(), config.getQmgrPort(), config.getQmgrChannel(), config.getQmgrName(), config.getUser(), config.getPassword(), config.getMqscp());
-            manager.runSubscribers(elements, config.getQueues());
+            ArrayList<MQObject.MQType> monitoringTypes = new ArrayList<>();
+            ArrayList<MQObject> objects = new ArrayList<>();
+
+            if (config.sendPCFCommands()) {
+                if (config.getQueues().size() > 0) {
+                    monitoringTypes.add(MQObject.MQType.QUEUE);
+                    for (String queueName : config.getQueues()) {
+                        objects.add(new MQObject(queueName, MQObject.MQType.QUEUE));
+                    }
+                }
+                if (config.getChannels().size() > 0) {
+                    monitoringTypes.add(MQObject.MQType.CHANNEL);
+                    for (String channelName : config.getChannels()) {
+                        objects.add(new MQObject(channelName, MQObject.MQType.CHANNEL));
+                    }
+                }
+                if (config.getListeners().size() > 0) {
+                    monitoringTypes.add(MQObject.MQType.LISTENER);
+                    for (String listenerName : config.getListeners()) {
+                        objects.add(new MQObject(listenerName, MQObject.MQType.LISTENER));
+                    }
+                }
+            }
+            MetricsManager.initMetrics(elements, monitoringTypes);
+            MQSubscriberManager manager = new MQSubscriberManager(config.getQmgrHost(), config.getQmgrPort(), config.getQmgrChannel(), config.getQmgrName(), config.getUser(), config.getPassword(), config.useMqscp());
+            manager.runSubscribers(elements, objects, config.sendPCFCommands(), config.usePCFWildcards(), config.getScrapeInterval());
             new HTTPServer(new InetSocketAddress("0.0.0.0", config.getEndpPort()), config.getEndpURL(), Registry.getRegistry(), false);
-        } catch (IOException e) {
-            System.err.println(e.getStackTrace());
+        } catch (Exception e) {
+            System.err.println(e.getMessage());
         }
     }
 
     /**
      * Method goes through system topics structure and returns metrics headers, which are represented by PCFElement
+     *
      * @param config - parsed config file.
      * @return - array, filled with metrics headers.
      */
@@ -56,7 +81,7 @@ private static ArrayList<PCFElement> getAllPublishedMetrics(Config config) {
         MQGetMessageOptions gmo = new MQGetMessageOptions();
         gmo.options = getMsgOpt;
         gmo.waitInterval = 30000;
-        connection.establish(config.getQmgrHost(), config.getQmgrPort(), config.getQmgrChannel(), config.getQmgrName(), config.getUser(), config.getPassword(), config.getMqscp());
+        connection.establish(config.getQmgrHost(), config.getQmgrPort(), config.getQmgrChannel(), config.getQmgrName(), config.getUser(), config.getPassword(), config.useMqscp());
 
         try {
             topic = connection.createTopic(String.format(topicString, config.getQmgrName()));
@@ -79,7 +104,7 @@ private static ArrayList<PCFElement> getAllPublishedMetrics(Config config) {
                 }
             }
         } catch (Exception e) {
-            System.err.println(e.getStackTrace());
+            System.err.println(e.getMessage());
         } finally {
             try {
                 if (topic != null && topic.isOpen()) {

src/main/java/ru/cinimex/exporter/mq/MQConnection.java

@@ -9,14 +9,14 @@
 import java.util.Hashtable;
 
 /**
- * Class represents MQ connection
+ * Class represents MQ connection.
  */
 public class MQConnection {
     private Hashtable<String, Object> connectionProperties;
     private MQQueueManager queueManager;
 
     /**
-     * Default constructor
+     * Default constructor.
      */
     public MQConnection() {
 
@@ -26,10 +26,10 @@ public MQConnection() {
      * Method creates connection properties Hashtable from connection parameters.
      *
      * @param host     - host, where queue manager is located.
-     * @param port     - queue manager's port
-     * @param channel  - queue manager's channel
-     * @param user     - user, which has enough privilege on the queue manager (optional)
-     * @param password - password, which is required to establish connection with queue manager (optional)
+     * @param port     - queue manager's port.
+     * @param channel  - queue manager's channel.
+     * @param user     - user, which has enough privilege on the queue manager (optional).
+     * @param password - password, which is required to establish connection with queue manager (optional).
      * @param useMQCSP - flag, which indicates, if MQCSP auth should be used.
      * @return - returns prepared structure with all parameters transformed into queue manager's format.
      */
@@ -63,7 +63,7 @@ public void establish(String host, int port, String channel, String qmName, Stri
         try {
             queueManager = new MQQueueManager(qmName, connectionProperties);
         } catch (MQException e) {
-            System.err.println(e.getStackTrace());
+            System.err.println(e.getMessage());
         }
     }
 
@@ -78,7 +78,7 @@ public void establish(String qmNqme, Hashtable<String, Object> connectionPropert
         try {
             queueManager = new MQQueueManager(qmNqme, connectionProperties);
         } catch (MQException e) {
-            System.err.println(e.getStackTrace());
+            System.err.println(e.getMessage());
         }
     }
 
@@ -90,7 +90,7 @@ public void close() {
             try {
                 queueManager.disconnect();
             } catch (MQException e) {
-                System.err.println(e.getStackTrace());
+                System.err.println(e.getMessage());
             }
         }
     }
@@ -105,4 +105,12 @@ public void close() {
     public MQTopic createTopic(String topic) throws MQException {
         return queueManager.accessTopic(topic, "", CMQC.MQTOPIC_OPEN_AS_SUBSCRIPTION, CMQC.MQSO_CREATE | CMQC.MQSO_NON_DURABLE | CMQC.MQSO_MANAGED);
     }
+
+    /**
+     * Returns MQQueueManager object.
+     * @return - MQQueueManager object.
+     */
+    public MQQueueManager getQueueManager() {
+        return this.queueManager;
+    }
 }

src/main/java/ru/cinimex/exporter/mq/MQObject.java

@@ -0,0 +1,118 @@
+package ru.cinimex.exporter.mq;
+
+import com.ibm.mq.constants.MQConstants;
+import com.ibm.mq.pcf.PCFMessage;
+
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.Map;
+
+/**
+ * Class represents MQObject (Queue, channel or listener). It stores object type and all PCFParameters, required for correct request.
+ */
+public class MQObject {
+    private String name;
+    private MQType type;
+    private PCFMessage PCFCmd;
+    private int PCFHeader;
+
+    /**
+     * MQObject constructor.
+     *
+     * @param name - object name.
+     * @param type - object type.
+     */
+    public MQObject(String name, MQType type) {
+        this.name = name;
+        this.type = type;
+/**
+ * PCF commands are used to retrieve some specific statistics from queue manager.
+ */
+        switch (type) {
+            case QUEUE:
+                PCFCmd = new PCFMessage(MQConstants.MQCMD_INQUIRE_Q); //if object type is queue, exporter would inquire it.
+                PCFCmd.addParameter(MQConstants.MQCA_Q_NAME, name); //PCF command would try to retrieve statistics about queue with specific name
+                PCFCmd.addParameter(MQConstants.MQIA_Q_TYPE, MQConstants.MQQT_LOCAL); // and specific type
+                PCFHeader = MQConstants.MQIA_MAX_Q_DEPTH; //the only statistics we want to know about queue is it's max depth.
+                break;
+            case LISTENER:
+                PCFCmd = new PCFMessage(MQConstants.MQCMD_INQUIRE_LISTENER_STATUS); //if object type is listener, exporter would inquire it.
+                PCFCmd.addParameter(MQConstants.MQCACH_LISTENER_NAME, name);//PCF command would try to retrieve statistics about listener with specific name
+                PCFHeader = MQConstants.MQIACH_LISTENER_STATUS;//the only statistics we want to know about listener is it's status.
+                break;
+            case CHANNEL:
+                PCFCmd = new PCFMessage(MQConstants.MQCMD_INQUIRE_CHANNEL_STATUS); //if object type is channel, exporter would inquire it.
+                PCFCmd.addParameter(MQConstants.MQCACH_CHANNEL_NAME, name); //PCF command would try to retrieve statistics about channel with specific name
+                PCFHeader = MQConstants.MQIACH_CHANNEL_STATUS;//the only statistics we want to know about channel is it's status.
+                break;
+            default:
+                //TODO:Exception
+        }
+    }
+
+    /**
+     * This method returns MQConstant int code, which represents name for input object.
+     *
+     * @param type - object type.
+     * @return - integer code.
+     */
+    public static int objectNameCode(MQObject.MQType type) {
+        int code = -1;
+        switch (type) {
+            case QUEUE:
+                code = MQConstants.MQCA_Q_NAME;
+                break;
+            case CHANNEL:
+                code = MQConstants.MQCACH_CHANNEL_NAME;
+                break;
+            case LISTENER:
+                code = MQConstants.MQCACH_LISTENER_NAME;
+                break;
+        }
+        return code;
+    }
+
+
+    /**
+     * Getter for object name.
+     *
+     * @return object name.
+     */
+    public String getName() {
+        return name;
+    }
+
+    /**
+     * Getter for PCFHeader.
+     *
+     * @return - MQConstant integer code.
+     */
+    public int getPCFHeader() {
+        return PCFHeader;
+    }
+
+    /**
+     * Getter for object type.
+     *
+     * @return object type.
+     */
+    public MQType getType() {
+        return type;
+    }
+
+    /**
+     * Getter for PCF command.
+     *
+     * @return - prepared PCF command object.
+     */
+    public PCFMessage getPCFCmd() {
+        return PCFCmd;
+    }
+
+    /**
+     * This enum represents all supported MQObject types.
+     */
+    public enum MQType {
+        QUEUE, CHANNEL, LISTENER
+    }
+}