Modified definition of error types for MQRC/MQCC

Added metaprefix option for prometheus monitor

Author: ibmmqmet

README.md

@@ -4,6 +4,10 @@ This repository demonstrates how you can call IBM MQ from applications written i
 The repository also includes programs to export MQ statistics to some monitoring
 packages including Prometheus, InfluxDB and OpenTSDB.
 
+A minimum level of MQ V9 is required to build this package.
+The monitoring data published by the queue manager is not available before
+that version.
+
 ## MQI Description
 
 The ibmmq directory contains a Go package, exposing an MQI-like interface.
@@ -26,6 +30,9 @@ have a copy of MQ installed to build against. It uses cgo to access the MQI C st
 installed in the default location on a Linux platform (/opt/mqm) but you can easily change the
 cgo directives in the source files if necessary.
 
+A minimum level of MQ V9 is required. The monitoring data published
+by the queue manager is not available before that version.
+
 Some Windows capability is also included. One constraint in the cgo package is its support
 for path names containing spaces and special characters, which makes it tricky to
 compile against a copy of MQ installed in the regular location. To build these packages I copied
@@ -175,6 +182,16 @@ connectivity, without requiring a CCDT. See the clientconn sample program
 for an example of using the MQCD.
 * Moved sample programs into subdirectory
 
+15 Feb 2017
+* API BREAKING CHANGE: The MQI verbs have been changed to return a single
+error indicator instead of two separate values. See mqitest.go for
+examples of how MQRC/MQCC codes can now be tested and extracted. This change
+makes the MQI implementation a bit more natural for Go environments.
+
+25 Mar 2017
+* Added the metaPrefix option to the Prometheus monitor. This allows selection of non-default resources such as the MQ Bridge for Salesforce included in MQ 9.0.2.
+
+
 ## Health Warning
 
 This package is provided as-is with no guarantees of support or updates. There are also no guarantees of compatibility

cmd/mq_prometheus/config.go

@@ -29,6 +29,8 @@ type mqExporterConfig struct {
 	monitoredQueues     string
 	monitoredQueuesFile string
 
+	metaPrefix string
+
 	cc mqmetric.ClientConfig
 
 	httpListenPort string
@@ -56,6 +58,7 @@ func initConfig() {
 	flag.StringVar(&config.replyQ, "ibmmq.replyQueue", "SYSTEM.DEFAULT.MODEL.QUEUE", "Reply Queue to collect data")
 	flag.StringVar(&config.monitoredQueues, "ibmmq.monitoredQueues", "", "Patterns of queues to monitor")
 	flag.StringVar(&config.monitoredQueuesFile, "ibmmq.monitoredQueuesFile", "", "File with patterns of queues to monitor")
+	flag.StringVar(&config.metaPrefix, "metaPrefix", "", "Override path to monitoring resource topic")
 
 	flag.BoolVar(&config.cc.ClientMode, "ibmmq.client", false, "Connect as MQ client")
 

cmd/mq_prometheus/main.go

@@ -56,7 +56,13 @@ func main() {
 	// What metrics can the queue manager provide? Find out, and
 	// subscribe.
 	if err == nil {
-		err = mqmetric.DiscoverAndSubscribe(config.monitoredQueues, true, "")
+		// Do we need to expand wildcarded queue names
+		// or use the wildcard as-is in the subscriptions
+		wildcardResource := true
+		if config.metaPrefix != "" {
+			wildcardResource = false
+		}
+		err = mqmetric.DiscoverAndSubscribe(config.monitoredQueues, wildcardResource, config.metaPrefix)
 	}
 
 	// Once everything has been discovered, and the subscriptions

cmd/samples/clientconn/clientconn.go

@@ -37,78 +37,81 @@ package main
 */
 
 import (
-        "bufio"
-        "fmt"
-        "ibmmq"
-        "os"
-        "time"
+	"bufio"
+	"fmt"
+	"ibmmq"
+	"os"
+	"time"
 )
 
 func main() {
-        var qMgrName string
-        var err error
-        var qMgr ibmmq.MQQueueManager
-
-        if len(os.Args) != 4 {
-                fmt.Println("clientconn <qmgrname> <channelname> <conname>")
-                fmt.Println("")
-                fmt.Println("For example")
-                fmt.Println("  clientconn QMGR1 \"SYSTEM.DEF.SVRCONN\" \"myhost.example.com(1414)\"")
-                fmt.Println("All parameters are required.")
-                os.Exit(1)
-        }
-
-        // Which queue manager do we want to connect to
-        qMgrName = os.Args[1]
-
-        // Allocate the MQCNO and MQCD structures needed for the
-        // MQCONNX call.
-        cno := ibmmq.NewMQCNO()
-        cd := ibmmq.NewMQCD()
-
-        // Fill in the required fields in the
-        // MQCD channel definition structure
-        cd.ChannelName = os.Args[2]
-        cd.ConnectionName = os.Args[3]
-
-        // Reference the CD structure from the CNO
-        // and indicate that we want to use the client
-        // connection method.
-        cno.ClientConn = cd
-        cno.Options = ibmmq.MQCNO_CLIENT_BINDING
-
-        // Also fill in the userid and password if the MQSAMP_USER_ID
-        // environment variable is set. This is the same as the C
-        // sample programs such as amqsput.
-        userId := os.Getenv("MQSAMP_USER_ID")
-        if userId != "" {
-                scanner := bufio.NewScanner(os.Stdin)
-                csp := ibmmq.NewMQCSP()
-                csp.AuthenticationType = ibmmq.MQCSP_AUTH_USER_ID_AND_PWD
-                csp.UserId = userId
-
-                fmt.Println("Enter password : ")
-                scanner.Scan()
-                csp.Password = scanner.Text()
-
-                // And make the CNO refer to the CSP structure
-                cno.SecurityParms = csp
-        }
-
-        // And connect. Wait a short time before
-        // disconnecting.
-        qMgr, mqreturn, err := ibmmq.Connx(qMgrName, cno)
-        if err == nil {
-                fmt.Printf("Connection to %s succeeded.\n", qMgrName)
-                d, _ := time.ParseDuration("5s")
-                time.Sleep(d)
-                qMgr.Disc()
-        } else {
-                fmt.Printf("Connection to %s failed.\n", qMgrName)
-                fmt.Println(err)
-        }
-
-        fmt.Println("Done.")
-        os.Exit((int)(mqreturn.MQCC))
+	var qMgrName string
+	var err error
+	var qMgr ibmmq.MQQueueManager
+	var rc int
+
+	if len(os.Args) != 4 {
+		fmt.Println("clientconn <qmgrname> <channelname> <conname>")
+		fmt.Println("")
+		fmt.Println("For example")
+		fmt.Println("  clientconn QMGR1 \"SYSTEM.DEF.SVRCONN\" \"myhost.example.com(1414)\"")
+		fmt.Println("All parameters are required.")
+		os.Exit(1)
+	}
+
+	// Which queue manager do we want to connect to
+	qMgrName = os.Args[1]
+
+	// Allocate the MQCNO and MQCD structures needed for the
+	// MQCONNX call.
+	cno := ibmmq.NewMQCNO()
+	cd := ibmmq.NewMQCD()
+
+	// Fill in the required fields in the
+	// MQCD channel definition structure
+	cd.ChannelName = os.Args[2]
+	cd.ConnectionName = os.Args[3]
+
+	// Reference the CD structure from the CNO
+	// and indicate that we want to use the client
+	// connection method.
+	cno.ClientConn = cd
+	cno.Options = ibmmq.MQCNO_CLIENT_BINDING
+
+	// Also fill in the userid and password if the MQSAMP_USER_ID
+	// environment variable is set. This is the same as the C
+	// sample programs such as amqsput.
+	userId := os.Getenv("MQSAMP_USER_ID")
+	if userId != "" {
+		scanner := bufio.NewScanner(os.Stdin)
+		csp := ibmmq.NewMQCSP()
+		csp.AuthenticationType = ibmmq.MQCSP_AUTH_USER_ID_AND_PWD
+		csp.UserId = userId
+
+		fmt.Println("Enter password : ")
+		scanner.Scan()
+		csp.Password = scanner.Text()
+
+		// And make the CNO refer to the CSP structure
+		cno.SecurityParms = csp
+	}
+
+	// And connect. Wait a short time before
+	// disconnecting.
+	qMgr, err = ibmmq.Connx(qMgrName, cno)
+	if err == nil {
+		fmt.Printf("Connection to %s succeeded.\n", qMgrName)
+		d, _ := time.ParseDuration("5s")
+		time.Sleep(d)
+		qMgr.Disc()
+		rc = 0
+	} else {
+		fmt.Printf("Connection to %s failed.\n", qMgrName)
+		fmt.Println(err)
+		rc = int(err.(*ibmmq.MQReturn).MQCC)
+	}
+
+	fmt.Println("Done.")
+	os.Exit(rc)
 
 }

cmd/samples/mqitest/mqitest.go

@@ -62,7 +62,7 @@ func main() {
 
 	qMgrName = os.Args[2]
 	connected := false
-	qMgr, mqreturn, err := ibmmq.Conn(qMgrName)
+	qMgr, err := ibmmq.Conn(qMgrName)
 	if err != nil {
 		fmt.Println(err)
 	} else {
@@ -80,7 +80,7 @@ func main() {
 		mqod.ObjectType = ibmmq.MQOT_Q
 		mqod.ObjectName = os.Args[1]
 
-		qObject, mqreturn, err = qMgr.Open(mqod, openOptions)
+		qObject, err = qMgr.Open(mqod, openOptions)
 		if err != nil {
 			fmt.Println(err)
 		} else {
@@ -103,7 +103,7 @@ func main() {
 		msgData := "Hello from Go"
 		buffer := []byte(msgData)
 
-		mqreturn, err = qObject.Put(putmqmd, pmo, buffer)
+		err = qObject.Put(putmqmd, pmo, buffer)
 
 		if err != nil {
 			fmt.Println(err)
@@ -115,7 +115,7 @@ func main() {
 	// The message was put in syncpoint so it needs
 	// to be committed.
 	if err == nil {
-		mqreturn, err = qMgr.Cmit()
+		err = qMgr.Cmit()
 		if err != nil {
 			fmt.Println(err)
 		}
@@ -136,12 +136,13 @@ func main() {
 			gmo.WaitInterval = 3000
 			buffer := make([]byte, 32768)
 
-			datalen, mqreturn, err = qObject.Get(getmqmd, gmo, buffer)
+			datalen, err = qObject.Get(getmqmd, gmo, buffer)
 
 			if err != nil {
 				msgAvail = false
 				fmt.Println(err)
-				if mqreturn.MQRC == ibmmq.MQRC_NO_MSG_AVAILABLE {
+				mqret := err.(*ibmmq.MQReturn)
+				if mqret.MQRC == ibmmq.MQRC_NO_MSG_AVAILABLE {
 					// not a real error so reset err
 					err = nil
 				}
@@ -154,7 +155,7 @@ func main() {
 
 	// MQCLOSE the queue
 	if err == nil {
-		mqreturn, err = qObject.Close(0)
+		err = qObject.Close(0)
 		if err != nil {
 			fmt.Println(err)
 		} else {
@@ -174,7 +175,7 @@ func main() {
 		mqsd.Options |= ibmmq.MQSO_MANAGED
 		mqsd.ObjectString = "$SYS/MQ/INFO/QMGR/" + qMgrName + "/ActivityTrace/ApplName/mqitest"
 
-		subObject, mqreturn, err = qMgr.Sub(mqsd, &managedQObject)
+		subObject, err = qMgr.Sub(mqsd, &managedQObject)
 
 		if err != nil {
 			fmt.Println(err)
@@ -201,12 +202,13 @@ func main() {
 			gmo.WaitInterval = 3000
 			buffer := make([]byte, 32768)
 
-			datalen, mqreturn, err = managedQObject.Get(getmqmd, gmo, buffer)
+			datalen, err = managedQObject.Get(getmqmd, gmo, buffer)
 
 			if err != nil {
 				msgAvail = false
 				fmt.Println(err)
-				if mqreturn.MQRC == ibmmq.MQRC_NO_MSG_AVAILABLE {
+				mqret := err.(*ibmmq.MQReturn)
+				if mqret.MQRC == ibmmq.MQRC_NO_MSG_AVAILABLE {
 					// not a real error so reset err, but
 					// end retrieval loop
 					err = nil
@@ -229,7 +231,7 @@ func main() {
 		mqod.ObjectType = ibmmq.MQOT_Q_MGR
 		mqod.ObjectName = ""
 
-		qMgrObject, mqreturn, err = qMgr.Open(mqod, openOptions)
+		qMgrObject, err = qMgr.Open(mqod, openOptions)
 
 		if err != nil {
 			fmt.Println(err)
@@ -243,7 +245,7 @@ func main() {
 			ibmmq.MQCA_DEAD_LETTER_Q_NAME,
 			ibmmq.MQIA_MSG_MARK_BROWSE_INTERVAL}
 
-		intAttrs, charAttrs, _, err := qMgrObject.Inq(selectors, 2, 160)
+		intAttrs, charAttrs, err := qMgrObject.Inq(selectors, 2, 160)
 
 		if err != nil {
 			fmt.Println(err)
@@ -258,10 +260,15 @@ func main() {
 
 	// MQDISC regardless of other errors
 	if connected {
-		mqreturn, err = qMgr.Disc()
+		err = qMgr.Disc()
 		fmt.Println("Disconnected from queue manager ", qMgrName)
 	}
 
-	os.Exit((int)(mqreturn.MQCC))
+	if err == nil {
+		os.Exit(0)
+	} else {
+		mqret := err.(*ibmmq.MQReturn)
+		os.Exit((int)(mqret.MQCC))
+	}
 
 }