IP binding address (#51) now configurable

ibmmqmet · ibmmqmet · commit b14f47ad0e1a · 2020-10-15T11:39:06.000+01:00
Sensible defaults if stanzas missing from YAML (#50)
diff --git a/cmd/mq_aws/README.md b/cmd/mq_aws/README.md
@@ -64,7 +64,7 @@ about specific queues or the queue manager.
 
 More information on the metrics collected through the publish/subscribe
 interface can be found in the [MQ KnowledgeCenter]
-(https://www.ibm.com/support/knowledgecenter/SSFKSJ_9.1.0/com.ibm.mq.mon.doc/mo00013_.htm)
+(https://www.ibm.com/support/knowledgecenter/SSFKSJ_latest/com.ibm.mq.mon.doc/mo00013_.htm)
 with further description in [an MQDev blog entry]
 (https://www.ibm.com/developerworks/community/blogs/messaging/entry/Statistics_published_to_the_system_topic_in_MQ_v9?lang=en)
 
diff --git a/cmd/mq_aws/config.go b/cmd/mq_aws/config.go
@@ -76,7 +76,7 @@ func initConfig() {
 		if config.cf.ConfigFile != "" {
 			// Set defaults
 			cfy.Global.UsePublications = true
-			err := cf.ReadConfigFile(config.cf.ConfigFile, &cfy)
+			err = cf.ReadConfigFile(config.cf.ConfigFile, &cfy)
 			if err == nil {
 				cf.CopyYamlConfig(&config.cf, cfy.Global, cfy.Connection, cfy.Objects)
 				config.ci = cfy.Cloudwatch
diff --git a/cmd/mq_coll/README.md b/cmd/mq_coll/README.md
@@ -56,7 +56,7 @@ about specific queues or the queue manager.
 
 More information on the metrics collected through the publish/subscribe
 interface can be found in the [MQ KnowledgeCenter]
-(https://www.ibm.com/support/knowledgecenter/SSFKSJ_9.1.0/com.ibm.mq.mon.doc/mo00013_.htm)
+(https://www.ibm.com/support/knowledgecenter/SSFKSJ_latest/com.ibm.mq.mon.doc/mo00013_.htm)
 with further description in [an MQDev blog entry]
 (https://www.ibm.com/developerworks/community/blogs/messaging/entry/Statistics_published_to_the_system_topic_in_MQ_v9?lang=en)
 
diff --git a/cmd/mq_coll/config.go b/cmd/mq_coll/config.go
@@ -1,7 +1,7 @@
 package main
 
 /*
-  Copyright (c) IBM Corporation 2016
+  Copyright (c) IBM Corporation 2016,2020
 
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
@@ -71,7 +71,7 @@ func initConfig() {
 		if config.cf.ConfigFile != "" {
 			// Set defaults
 			cfy.Global.UsePublications = true
-			err := cf.ReadConfigFile(config.cf.ConfigFile, &cfy)
+			err = cf.ReadConfigFile(config.cf.ConfigFile, &cfy)
 			if err == nil {
 				cf.CopyYamlConfig(&config.cf, cfy.Global, cfy.Connection, cfy.Objects)
 				config.interval = cfy.Collectd.Interval
diff --git a/cmd/mq_influx/README.md b/cmd/mq_influx/README.md
@@ -60,7 +60,7 @@ about specific objects or the queue manager.
 
 More information on the metrics collected through the publish/subscribe
 interface can be found in the [MQ KnowledgeCenter]
-(https://www.ibm.com/support/knowledgecenter/SSFKSJ_9.1.0/com.ibm.mq.mon.doc/mo00013_.htm)
+(https://www.ibm.com/support/knowledgecenter/SSFKSJ_latest/com.ibm.mq.mon.doc/mo00013_.htm)
 with further description in [an MQDev blog entry]
 (https://www.ibm.com/developerworks/community/blogs/messaging/entry/Statistics_published_to_the_system_topic_in_MQ_v9?lang=en)
 
diff --git a/cmd/mq_influx/config.go b/cmd/mq_influx/config.go
@@ -80,7 +80,7 @@ func initConfig() error {
 		if config.cf.ConfigFile != "" {
 			// Set defaults
 			cfy.Global.UsePublications = true
-			err := cf.ReadConfigFile(config.cf.ConfigFile, &cfy)
+			err = cf.ReadConfigFile(config.cf.ConfigFile, &cfy)
 			if err == nil {
 				cf.CopyYamlConfig(&config.cf, cfy.Global, cfy.Connection, cfy.Objects)
 				config.ci = cfy.Influx
diff --git a/cmd/mq_json/README.md b/cmd/mq_json/README.md
@@ -103,7 +103,7 @@ jq -c '.collectionTime.timeStamp as $t | .points[] |
 Once the monitor program has been started, you will see metrics being available.
 More information on the metrics collected through the publish/subscribe
 interface can be found in the [MQ KnowledgeCenter]
-(https://www.ibm.com/support/knowledgecenter/SSFKSJ_9.1.0/com.ibm.mq.mon.doc/mo00013_.htm)
+(https://www.ibm.com/support/knowledgecenter/SSFKSJ_latest/com.ibm.mq.mon.doc/mo00013_.htm)
 with further description in [an MQDev blog entry]
 (https://www.ibm.com/developerworks/community/blogs/messaging/entry/Statistics_published_to_the_system_topic_in_MQ_v9?lang=en)
 
diff --git a/cmd/mq_json/config.go b/cmd/mq_json/config.go
@@ -64,10 +64,10 @@ func initConfig() error {
 		if config.cf.ConfigFile != "" {
 			// Set defaults
 			cfy.Global.UsePublications = true
-			err := cf.ReadConfigFile(config.cf.ConfigFile, &cfy)
+			err = cf.ReadConfigFile(config.cf.ConfigFile, &cfy)
 			if err == nil {
 				cf.CopyYamlConfig(&config.cf, cfy.Global, cfy.Connection, cfy.Objects)
-				config.interval = cfy.JSON.Interval
+				config.interval = cf.CopyIfSet(config.interval, cfy.JSON.Interval)
 			}
 		}
 	}
diff --git a/cmd/mq_opentsdb/README.md b/cmd/mq_opentsdb/README.md
@@ -57,7 +57,7 @@ about specific object or the queue manager.
 
 More information on the metrics collected through the publish/subscribe
 interface can be found in the [MQ KnowledgeCenter]
-(https://www.ibm.com/support/knowledgecenter/SSFKSJ_9.1.0/com.ibm.mq.mon.doc/mo00013_.htm)
+(https://www.ibm.com/support/knowledgecenter/SSFKSJ_latest/com.ibm.mq.mon.doc/mo00013_.htm)
 with further description in [an MQDev blog entry]
 (https://www.ibm.com/developerworks/community/blogs/messaging/entry/Statistics_published_to_the_system_topic_in_MQ_v9?lang=en)
 
diff --git a/cmd/mq_opentsdb/config.go b/cmd/mq_opentsdb/config.go
@@ -77,7 +77,7 @@ func initConfig() {
 		if config.cf.ConfigFile != "" {
 			// Set defaults
 			cfy.Global.UsePublications = true
-			err := cf.ReadConfigFile(config.cf.ConfigFile, &cfy)
+			err = cf.ReadConfigFile(config.cf.ConfigFile, &cfy)
 			if err == nil {
 				cf.CopyYamlConfig(&config.cf, cfy.Global, cfy.Connection, cfy.Objects)
 				config.ci = cfy.OpenTSDB
diff --git a/cmd/mq_prometheus/README.md b/cmd/mq_prometheus/README.md
@@ -82,7 +82,7 @@ default is **ibmmq**. The name can be configured with the `-namespace` option
 on the command line.
 
 More information on the metrics collected through the publish/subscribe
-interface can be found in the [MQ KnowledgeCenter](https://www.ibm.com/support/knowledgecenter/SSFKSJ_9.0.0/com.ibm.mq.mon.doc/mo00013_.htm)
+interface can be found in the [MQ KnowledgeCenter](https://www.ibm.com/support/knowledgecenter/SSFKSJ_latest/com.ibm.mq.mon.doc/mo00013_.htm)
 with further description in [an MQDev blog entry](https://www.ibm.com/developerworks/community/blogs/messaging/entry/Statistics_published_to_the_system_topic_in_MQ_v9?lang=en)
 
 The queue and queue manager metrics shown in the Prometheus console are named after the descriptions
diff --git a/cmd/mq_prometheus/config.collector.yaml b/cmd/mq_prometheus/config.collector.yaml
@@ -2,5 +2,8 @@
 # This is the collector-specific piece of the configuration
 prometheus:
   port: 9157
+# We can constrain the http listener to a single adapter via the 'host' config. Default is
+# to bind to all local addresses  
+# host: 1.2.3.4
   metricsPath: "/metrics"
   namespace: ibmmq
diff --git a/cmd/mq_prometheus/config.go b/cmd/mq_prometheus/config.go
@@ -28,12 +28,14 @@ type mqExporterConfig struct {
 	cf cf.Config // Common configuration attributes for all collectors
 
 	httpListenPort string
+	httpListenHost string
 	httpMetricPath string
 	namespace      string
 }
 
 type ConfigYProm struct {
 	Port        string
+	Host        string
 	MetricsPath string `yaml:"metricsPath"`
 	Namespace   string
 }
@@ -65,7 +67,9 @@ func initConfig() error {
 
 	cf.InitConfig(&config.cf)
 
-	flag.StringVar(&config.httpListenPort, "ibmmq.httpListenPort", defaultPort, "HTTP Listener")
+	flag.StringVar(&config.httpListenPort, "ibmmq.httpListenPort", defaultPort, "HTTP Listener Port")
+	flag.StringVar(&config.httpListenHost, "ibmmq.httpListenHost", "", "HTTP Listener Hose")
+
 	flag.StringVar(&config.httpMetricPath, "ibmmq.httpMetricPath", "/metrics", "Path to exporter metrics")
 
 	flag.StringVar(&config.namespace, "namespace", defaultNamespace, "Namespace for metrics")
@@ -81,12 +85,13 @@ func initConfig() error {
 		if config.cf.ConfigFile != "" {
 			// Set defaults
 			cfy.Global.UsePublications = true
-			err := cf.ReadConfigFile(config.cf.ConfigFile, &cfy)
+			err = cf.ReadConfigFile(config.cf.ConfigFile, &cfy)
 			if err == nil {
 				cf.CopyYamlConfig(&config.cf, cfy.Global, cfy.Connection, cfy.Objects)
-				config.httpListenPort = cfy.Prometheus.Port
-				config.httpMetricPath = cfy.Prometheus.MetricsPath
-				config.namespace = cfy.Prometheus.Namespace
+				config.httpListenPort = cf.CopyIfSet(config.httpListenPort, cfy.Prometheus.Port)
+				config.httpListenHost = cf.CopyIfSet(config.httpListenHost, cfy.Prometheus.Host)
+				config.httpMetricPath = cf.CopyIfSet(config.httpMetricPath, cfy.Prometheus.MetricsPath)
+				config.namespace = cf.CopyIfSet(config.namespace, cfy.Prometheus.Namespace)
 			}
 		}
 	}
diff --git a/cmd/mq_prometheus/main.go b/cmd/mq_prometheus/main.go
@@ -114,8 +114,9 @@ func main() {
 			w.Write(landingPage())
 		})
 
-		log.Infoln("Listening on port", config.httpListenPort)
-		log.Fatal(http.ListenAndServe(":"+config.httpListenPort, nil))
+		address := config.httpListenHost + ":" + config.httpListenPort
+		log.Infoln("Listening on address", address)
+		log.Fatal(http.ListenAndServe(address, nil))
 
 	}
 
diff --git a/pkg/config/configyaml.go b/pkg/config/configyaml.go
@@ -71,32 +71,32 @@ func CopyYamlConfig(cm *Config, cyg ConfigYGlobal, cyc ConfigYConnection, cyo Co
 	cm.CC.UsePublications = cyg.UsePublications
 	cm.CC.ShowInactiveChannels = cyo.ShowInactiveChannels
 
-	cm.LogLevel = copyIfSet(cm.LogLevel, cyg.LogLevel)
-	cm.MetaPrefix = copyIfSet(cm.MetaPrefix, cyg.MetaPrefix)
-	cm.pollInterval = copyIfSet(cm.pollInterval, cyg.PollInterval)
-	cm.rediscoverInterval = copyIfSet(cm.rediscoverInterval, cyg.RediscoverInterval)
-	cm.TZOffsetString = copyIfSet(cm.TZOffsetString, cyg.TZOffset)
-	cm.Locale = copyIfSet(cm.Locale, cyg.Locale)
-
-	cm.QMgrName = copyIfSet(cm.QMgrName, cyc.QueueManager)
-	cm.CC.CcdtUrl = copyIfSet(cm.CC.CcdtUrl, cyc.CcdtUrl)
-	cm.CC.ConnName = copyIfSet(cm.CC.ConnName, cyc.ConnName)
-	cm.CC.Channel = copyIfSet(cm.CC.Channel, cyc.Channel)
+	cm.LogLevel = CopyIfSet(cm.LogLevel, cyg.LogLevel)
+	cm.MetaPrefix = CopyIfSet(cm.MetaPrefix, cyg.MetaPrefix)
+	cm.pollInterval = CopyIfSet(cm.pollInterval, cyg.PollInterval)
+	cm.rediscoverInterval = CopyIfSet(cm.rediscoverInterval, cyg.RediscoverInterval)
+	cm.TZOffsetString = CopyIfSet(cm.TZOffsetString, cyg.TZOffset)
+	cm.Locale = CopyIfSet(cm.Locale, cyg.Locale)
+
+	cm.QMgrName = CopyIfSet(cm.QMgrName, cyc.QueueManager)
+	cm.CC.CcdtUrl = CopyIfSet(cm.CC.CcdtUrl, cyc.CcdtUrl)
+	cm.CC.ConnName = CopyIfSet(cm.CC.ConnName, cyc.ConnName)
+	cm.CC.Channel = CopyIfSet(cm.CC.Channel, cyc.Channel)
 	cm.CC.ClientMode = cyc.Client
-	cm.CC.UserId = copyIfSet(cm.CC.UserId, cyc.User)
-	cm.CC.Password = copyIfSet(cm.CC.Password, cyc.Password)
-	cm.ReplyQ = copyIfSet(cm.ReplyQ, cyc.ReplyQueue)
+	cm.CC.UserId = CopyIfSet(cm.CC.UserId, cyc.User)
+	cm.CC.Password = CopyIfSet(cm.CC.Password, cyc.Password)
+	cm.ReplyQ = CopyIfSet(cm.ReplyQ, cyc.ReplyQueue)
 
-	cm.MonitoredQueues = copyIfSetArray(cm.MonitoredQueues, cyo.Queues)
-	cm.MonitoredChannels = copyIfSetArray(cm.MonitoredChannels, cyo.Channels)
-	cm.MonitoredTopics = copyIfSetArray(cm.MonitoredTopics, cyo.Topics)
-	cm.MonitoredSubscriptions = copyIfSetArray(cm.MonitoredSubscriptions, cyo.Subscriptions)
-	cm.QueueSubscriptionSelector = copyIfSetArray(cm.QueueSubscriptionSelector, cyo.QueueSubscriptionSelector)
+	cm.MonitoredQueues = CopyIfSetArray(cm.MonitoredQueues, cyo.Queues)
+	cm.MonitoredChannels = CopyIfSetArray(cm.MonitoredChannels, cyo.Channels)
+	cm.MonitoredTopics = CopyIfSetArray(cm.MonitoredTopics, cyo.Topics)
+	cm.MonitoredSubscriptions = CopyIfSetArray(cm.MonitoredSubscriptions, cyo.Subscriptions)
+	cm.QueueSubscriptionSelector = CopyIfSetArray(cm.QueueSubscriptionSelector, cyo.QueueSubscriptionSelector)
 
 	return
 }
 
-func copyIfSetArray(a string, b []string) string {
+func CopyIfSetArray(a string, b []string) string {
 	s := a
 	for i := 0; i < len(b); i++ {
 		if i == 0 {
@@ -108,7 +108,7 @@ func copyIfSetArray(a string, b []string) string {
 	return s
 }
 
-func copyIfSet(a string, b string) string {
+func CopyIfSet(a string, b string) string {
 	if b != "" {
 		return b
 	} else {

Original file line number	Diff line number	Diff line change
`@@ -64,10 +64,10 @@ func initConfig() error {`
`64`	`64`	`if config.cf.ConfigFile != "" {`
`65`	`65`	`// Set defaults`
`66`	`66`	`cfy.Global.UsePublications = true`
`67`		`- err := cf.ReadConfigFile(config.cf.ConfigFile, &cfy)`
	`67`	`+ err = cf.ReadConfigFile(config.cf.ConfigFile, &cfy)`
`68`	`68`	`if err == nil {`
`69`	`69`	`cf.CopyYamlConfig(&config.cf, cfy.Global, cfy.Connection, cfy.Objects)`
`70`		`- config.interval = cfy.JSON.Interval`
	`70`	`+ config.interval = cf.CopyIfSet(config.interval, cfy.JSON.Interval)`
`71`	`71`	`}`
`72`	`72`	`}`
`73`	`73`	`}`