Discover shared queues

Author: ibmmqmet

CHANGELOG.md

@@ -1,6 +1,10 @@
 # Changelog
 Newest updates are at the top of this file.
 
+## January 09 2020 - v4.1.3
+* mqmetric - Discovery of shared queues (ibm-messaging/mq-metric-samples#26)
+* mqmetric - Add DESCR attribute from queues and channels to permit labelling in metrics (ibm-messaging/mq-metric-samples#16)
+
 ## December 05 2019 - v4.1.2
 * Update for MQ 9.1.4 - No new base API function introduced
 * Add amqsgbr sample for browse option

mqmetric/channel.go

@@ -64,6 +64,8 @@ const (
 	SQUASH_CHL_STATUS_STOPPED    = 0
 	SQUASH_CHL_STATUS_TRANSITION = 1
 	SQUASH_CHL_STATUS_RUNNING    = 2
+
+	DUMMY_STRING = "-" // To provide a non-empty value for certain fields
 )
 
 var ChannelStatus StatusSet
@@ -317,9 +319,14 @@ func parseChlData(instanceType int32, cfh *ibmmq.MQCFH, buf []byte) string {
 	}
 
 	// Prometheus was ignoring a blank string which then got translated into "0.00" in Grafana
-	// So if there is no remote qmgr, force a non-empty string value in there
+	// So if there is no remote qmgr, force a non-empty string value in there. Similarly, the jobname for
+	// inactive channels often arrives looking like "00000" but not filling the entire length
+	// allowed. So reset that one too.
 	if rqmName == "" {
-		rqmName = "-"
+		rqmName = DUMMY_STRING
+	}
+	if jobName == "" || allZero(jobName) {
+		jobName = DUMMY_STRING
 	}
 
 	// Create a unique key for this channel instance
@@ -329,7 +336,7 @@ func parseChlData(instanceType int32, cfh *ibmmq.MQCFH, buf []byte) string {
 	// the channel start timestamp. That may still be wrong if lots of channel
 	// instances start at the same time, but it's a lot better than combining the
 	// instances badly.
-	if jobName == "" && platform == ibmmq.MQPL_ZOS {
+	if jobName == DUMMY_STRING && platform == ibmmq.MQPL_ZOS {
 		jobName = startDate + ":" + startTime
 	}
 	key = chlName + "/" + connName + "/" + rqmName + "/" + jobName
@@ -583,3 +590,13 @@ func parseChannelAttrData(cfh *ibmmq.MQCFH, buf []byte, infoMap map[string]*ObjI
 
 	return
 }
+
+func allZero(s string) bool {
+	rc := true
+	for i := 0; i < len(s); i++ {
+		if s[i] != '0' {
+			return false
+		}
+	}
+	return rc
+}

mqmetric/discover.go

@@ -730,6 +730,17 @@ func inquireObjects(objectPatternsList string, objectType int32) ([]string, erro
 			pcfparm.Int64Value = []int64{int64(ibmmq.MQQT_LOCAL)}
 			cfh.ParameterCount++
 			buf = append(buf, pcfparm.Bytes()...)
+
+			// We don't see shared queues in the returned set unless explicitly asked for.
+			// MQQSGD_ALL returns all locals, and (if qmgr in a QSG) also shared queues.
+			if platform == ibmmq.MQPL_ZOS {
+				pcfparm = new(ibmmq.PCFParameter)
+				pcfparm.Type = ibmmq.MQCFT_INTEGER
+				pcfparm.Parameter = ibmmq.MQIA_QSG_DISP
+				pcfparm.Int64Value = []int64{int64(ibmmq.MQQSGD_ALL)}
+				cfh.ParameterCount++
+				buf = append(buf, pcfparm.Bytes()...)
+			}
 		}
 		// Once we know the total number of parameters, put the
 		// CFH header on the front of the buffer.
@@ -1361,9 +1372,10 @@ func GetObjectDescription(key string, objectType int32) string {
 		o, ok = chlInfoMap[key]
 	}
 
-	if ok {
-		return o.Description
+	if !ok || strings.TrimSpace(o.Description) == "" {
+		// return something so Prometheus doesn't turn it into "0.0"
+		return "-"
 	} else {
-		return ""
+		return o.Description
 	}
 }

mqmetric/queue.go

@@ -161,7 +161,6 @@ func CollectQueueStatus(patterns string) error {
 			if len(qName) == 0 || !qi.exists {
 				continue
 			}
-			//fmt.Printf("Collecting qStatus for %s\n",qName)
 			err = collectQueueStatus(qName, ibmmq.MQOT_Q)
 			if err == nil && useResetQStats {
 				err = collectResetQStats(qName)
@@ -173,6 +172,7 @@ func CollectQueueStatus(patterns string) error {
 			if len(pattern) == 0 {
 				continue
 			}
+
 			err = collectQueueStatus(pattern, ibmmq.MQOT_Q)
 			if err == nil && useResetQStats {
 				err = collectResetQStats(pattern)
@@ -367,7 +367,6 @@ func parseQData(instanceType int32, cfh *ibmmq.MQCFH, buf []byte) string {
 
 	// Create a unique key for this instance
 	key = qName
-
 	QueueStatus.Attributes[ATTR_Q_NAME].Values[key] = newStatusValueString(qName)
 
 	// And then re-parse the message so we can store the metrics now knowing the map key