Add NLS description discovery for mqmetric (issue #46)

Author: ibmmqmet

ibmmq/mqi.go

@@ -837,9 +837,9 @@ func (object MQObject) Set(goSelectors map[int32]interface{}) error {
 			v := goSelectors[s]
 			// Force the returned value from the map to be int32 because we
 			// can't check it at compile time.
-			if _,ok := v.(int32);ok {
+			if _, ok := v.(int32); ok {
 				vv = v.(int32)
-			} else if _,ok := v.(int);ok {
+			} else if _, ok := v.(int); ok {
 				vv = int32(v.(int))
 			}
 			intAttrs[intAttr] = vv

mqmetric/discover.go

@@ -44,11 +44,12 @@ import (
 
 // MonElement describes the real metric element generated by MQ
 type MonElement struct {
-	Parent      *MonType
-	Description string // An English phrase describing the element
-	MetricName  string // Reformatted description suitable as label
-	Datatype    int32
-	Values      map[string]int64
+	Parent         *MonType
+	Description    string // An English phrase describing the element
+	DescriptionNLS string // A translated phrase for the current locale
+	MetricName     string // Reformatted description suitable as label
+	Datatype       int32
+	Values         map[string]int64
 }
 
 // MonType describes the "types" of data generated by MQ. Each class generates
@@ -89,11 +90,20 @@ const maxBufSize = 100 * 1024 * 1024 // 100 MB
 var Metrics AllMetrics
 
 var qList []string
+var locale string
 
 func GetDiscoveredQueues() []string {
 	return qList
 }
 
+/*
+ * A collector can set the locale (eg "Fr_FR") before doing the discovery
+ * process to get access to the MQ-translated strings
+ */
+func SetLocale(l string) {
+	locale = l
+}
+
 /*
 DiscoverAndSubscribe does all the work of finding the
 different resources available from a queue manager and
@@ -284,6 +294,70 @@ func discoverElements(ty *MonType) error {
 	return err
 }
 
+// Rerun the subscription for elements, but this time adding a locale into the topic
+// so that we can get the translated description. It's up to the collector program to
+// then make use of that description.
+func discoverElementsNLS(ty *MonType, locale string) error {
+	var err error
+	var data []byte
+	var sub ibmmq.MQObject
+
+	if locale == "" {
+		return nil
+	}
+
+	sub, err = subscribe(ty.elementTopic + "/" + locale)
+	if err == nil {
+		// Don't wait - if there's nothing on that topic, then get out fast
+		data, err = getMessage(false)
+		sub.Close(0)
+
+		if err != nil {
+			mqreturn := err.(*ibmmq.MQReturn)
+			if mqreturn.MQRC == ibmmq.MQRC_NO_MSG_AVAILABLE {
+				err = nil
+			}
+		}
+
+		elemList, _ := parsePCFResponse(data)
+
+		for i := 0; i < len(elemList); i++ {
+
+			if elemList[i].Type == ibmmq.MQCFT_STRING && elemList[i].Parameter == ibmmq.MQCA_TOPIC_STRING {
+				continue
+			}
+
+			if elemList[i].Type != ibmmq.MQCFT_GROUP {
+				continue
+			}
+
+			group := elemList[i]
+			description := ""
+			elementIndex := 0
+
+			for j := 0; j < len(group.GroupList); j++ {
+				e := group.GroupList[j]
+				switch e.Parameter {
+
+				case ibmmq.MQIAMO_MONITOR_ELEMENT:
+					elementIndex = int(e.Int64Value[0])
+
+				case ibmmq.MQCAMO_MONITOR_DESC:
+					description = e.String[0]
+
+				}
+			}
+
+			if description != "" {
+				ty.Elements[elementIndex].DescriptionNLS = description
+				fmt.Printf("Updated element %v\n", ty.Elements[elementIndex])
+			}
+		}
+	}
+
+	return err
+}
+
 /*
 Discover the complete set of available statistics in the queue manager
 by working through the classes, types and individual elements.
@@ -312,6 +386,9 @@ func discoverStats(metaPrefix string) error {
 			if err == nil {
 				for _, ty := range cl.Types {
 					err = discoverElements(ty)
+					if err == nil && locale != "" {
+						err = discoverElementsNLS(ty, locale)
+					}
 				}
 			}
 		}

samples/amqsset.go

@@ -44,17 +44,17 @@ var object ibmmq.MQObject
  * This is an example of how to call MQSET
  */
 func setAttributes(obj ibmmq.MQObject) {
-  // Create a map containing the selectors and their values. The values must be
+	// Create a map containing the selectors and their values. The values must be
 	// a string (for MQCA attributes) or an int/int32 for the MQIA values.
 
 	// The value being set in the TRIGDATA attribute has a timestamp so you can
 	// see if it is successfully changed
 	selectors := map[int32]interface{}{
-		ibmmq.MQIA_INHIBIT_PUT: ibmmq.MQQA_PUT_INHIBITED,
-		ibmmq.MQIA_TRIGGER_CONTROL:     ibmmq.MQTC_ON,
+		ibmmq.MQIA_INHIBIT_PUT:     ibmmq.MQQA_PUT_INHIBITED,
+		ibmmq.MQIA_TRIGGER_CONTROL: ibmmq.MQTC_ON,
 		ibmmq.MQCA_TRIGGER_DATA:    "Data set at " + time.Now().Format(time.RFC3339)}
 
-  // And call the MQI
+	// And call the MQI
 	err := obj.Set(selectors)
 	if err != nil {
 		fmt.Println(err)