mqmetric - add DESCR attribute for channels and queues to permit labelling (ibm-messaging/mq-metric/samples/#16)

Author: ibmmqmet

mqmetric/channel.go

@@ -465,18 +465,21 @@ func inquireChannelAttributes(objectPatternsList string, infoMap map[string]*Obj
 		cfh.ParameterCount++
 		buf = append(buf, pcfparm.Bytes()...)
 
-		// Add the parameters one at a time into a buffer
-		pcfparm = new(ibmmq.PCFParameter)
-		pcfparm.Type = ibmmq.MQCFT_INTEGER
-		pcfparm.Parameter = ibmmq.MQIACH_CHANNEL_TYPE
-		pcfparm.Int64Value = []int64{int64(ibmmq.MQCHT_SVRCONN)}
-		cfh.ParameterCount++
-		buf = append(buf, pcfparm.Bytes()...)
+		// The original version of this function was only relevant for SVRCONN channels but DESCR is now being asked
+		// for which applies to all channel types. It's OK to ask for attributes for the wrong type of channel though;
+		// they are simply not returned.
+
+		//pcfparm = new(ibmmq.PCFParameter)
+		//pcfparm.Type = ibmmq.MQCFT_INTEGER
+		//pcfparm.Parameter = ibmmq.MQIACH_CHANNEL_TYPE
+		//pcfparm.Int64Value = []int64{int64(ibmmq.MQCHT_SVRCONN)}
+		//cfh.ParameterCount++
+		//buf = append(buf, pcfparm.Bytes()...)
 
 		pcfparm = new(ibmmq.PCFParameter)
 		pcfparm.Type = ibmmq.MQCFT_INTEGER_LIST
 		pcfparm.Parameter = ibmmq.MQIACF_CHANNEL_ATTRS
-		pcfparm.Int64Value = []int64{int64(ibmmq.MQIACH_MAX_INSTANCES), int64(ibmmq.MQIACH_MAX_INSTS_PER_CLIENT)}
+		pcfparm.Int64Value = []int64{int64(ibmmq.MQIACH_MAX_INSTANCES), int64(ibmmq.MQIACH_MAX_INSTS_PER_CLIENT), int64(ibmmq.MQCACH_DESC)}
 		cfh.ParameterCount++
 		buf = append(buf, pcfparm.Bytes()...)
 
@@ -564,8 +567,18 @@ func parseChannelAttrData(cfh *ibmmq.MQCFH, buf []byte, infoMap map[string]*ObjI
 				ci.exists = true
 
 			}
-		}
 
+		case ibmmq.MQCACH_DESC:
+			v := elem.String[0]
+			if v != "" {
+				if ci, ok = infoMap[chlName]; !ok {
+					ci = new(ObjInfo)
+					infoMap[chlName] = ci
+				}
+				ci.Description = v
+				ci.exists = true
+			}
+		}
 	}
 
 	return

mqmetric/discover.go

@@ -86,6 +86,7 @@ type AllMetrics struct {
 type ObjInfo struct {
 	exists          bool // Used during rediscovery
 	firstCollection bool // To indicate discard needed of first stat
+	Description     string
 	// These are used for queue information
 	AttrMaxDepth int64 // The queue attribute value. Not the max depth reported by RESET QSTATS
 	AttrUsage    int64 // Normal or XMITQ
@@ -1349,3 +1350,20 @@ func patternMatch(s string, r string) bool {
 	//	fmt.Printf("Comparing %s with %s %v\n",s,r,rc)
 	return rc
 }
+
+func GetObjectDescription(key string, objectType int32) string {
+	var o *ObjInfo
+	ok := false
+	switch objectType {
+	case ibmmq.MQOT_Q:
+		o, ok = qInfoMap[key]
+	case ibmmq.MQOT_CHANNEL:
+		o, ok = chlInfoMap[key]
+	}
+
+	if ok {
+		return o.Description
+	} else {
+		return ""
+	}
+}

mqmetric/queue.go

@@ -305,7 +305,7 @@ func inquireQueueAttributes(objectPatternsList string) error {
 		pcfparm = new(ibmmq.PCFParameter)
 		pcfparm.Type = ibmmq.MQCFT_INTEGER_LIST
 		pcfparm.Parameter = ibmmq.MQIACF_Q_ATTRS
-		pcfparm.Int64Value = []int64{int64(ibmmq.MQIA_MAX_Q_DEPTH), int64(ibmmq.MQIA_USAGE)}
+		pcfparm.Int64Value = []int64{int64(ibmmq.MQIA_MAX_Q_DEPTH), int64(ibmmq.MQIA_USAGE), int64(ibmmq.MQCA_Q_DESC)}
 		cfh.ParameterCount++
 		buf = append(buf, pcfparm.Bytes()...)
 
@@ -515,6 +515,13 @@ func parseQAttrData(cfh *ibmmq.MQCFH, buf []byte) {
 					qInfo.AttrUsage = v
 				}
 			}
+		case ibmmq.MQCA_Q_DESC:
+			v := elem.String[0]
+			if v != "" {
+				if qInfo, ok := qInfoMap[qName]; ok {
+					qInfo.Description = v
+				}
+			}
 		}
 
 	}