Update for MQ 9.3.3

Author: ibmmqmet

CHANGELOG.md

@@ -1,6 +1,11 @@
 # Changelog
 Newest updates are at the top of this file.
 
+### Jun 20 2023 (v5.5.0)
+* Update to MQ 9.3.3
+* Update Dockerfile to support platforms without Redist client (#209)
+* Update all vendored dependencies
+
 ### Feb 17 2023 (v5.4.0)
 * Update to MQ 9.3.2
 * Add hostname tag for qmgrs running 9.3.2

Dockerfile

@@ -1,6 +1,15 @@
 # syntax=docker/dockerfile:1
 
+# This Dockerfile shows how you can both build and run a container with 
+# a specific exporter/collector program. It uses two stages, copying the relevant
+# material from the build step into the runtime container.
+#
+# It can cope with both platforms where a Redistributable Client is available, and platforms
+# where it is not - copy the .deb install images for such platforms into the MQDEB
+# subdirectory of this repository first.
+
 # Global ARG. To be used in all stages.
+# Override with "--build-arg EXPORTER=mq_xxxxx" when building.
 ARG EXPORTER=mq_prometheus
 
 # --- --- --- --- --- --- --- --- --- --- --- --- --- --- #
@@ -9,15 +18,10 @@ ARG EXPORTER=mq_prometheus
 FROM golang:1.19 AS builder
 
 ARG EXPORTER
-ARG GOARCH=amd64
-ARG MQARCH=X64
-
 ENV EXPORTER=${EXPORTER} \
     ORG="github.com/ibm-messaging" \
     REPO="mq-metric-samples" \
-    RDURL="https://public.dhe.ibm.com/ibmdl/export/pub/software/websphere/messaging/mqdev/redist" \
-    RDTAR="IBM-MQC-Redist-Linux${MQARCH}.tar.gz" \
-    VRMF=9.3.2.0 \
+    VRMF=9.3.3.0 \
     CGO_CFLAGS="-I/opt/mqm/inc/" \
     CGO_LDFLAGS_ALLOW="-Wl,-rpath.*" \
     genmqpkg_incnls=1 \
@@ -35,40 +39,62 @@ RUN mkdir -p /go/src /go/bin /go/pkg \
     && chmod -R 777 /go \
     && mkdir -p /go/src/$ORG \
     && mkdir -p /opt/mqm \
+    && mkdir -p /MQDEB \
     && chmod a+rx /opt/mqm
 
-# Install MQ client
-WORKDIR /opt/mqm
-RUN curl -LO "$RDURL/$VRMF-$RDTAR" \
-    && tar -zxf ./*.tar.gz \
-    && rm -f ./*.tar.gz \
-    && bin/genmqpkg.sh -b /opt/mqm
+# Install MQ client and SDK
+# For platforms with a Redistributable client, we can use curl to pull it in and unpack it.
+# For other platforms, we assume that you have the deb files available under the current directory
+# and we then copy them into the container image. Use dpkg to install from them; these have to be 
+# done in the right order.
+# 
+# If additional Redistributable Client platforms appear, then this block can be altered, including the MQARCH setting.
+# 
+# The copy of the README is so that at least one file always gets copied, even if you don't have the deb files locally. 
+# Using a wildcard in the directory name also helps to ensure that this part of the build should always succeed.
+COPY README.md MQDEB*/*deb /MQDEB
+
+# This is a value always set by the "docker build" process
+ARG TARGETPLATFORM
+RUN echo "Target arch is $TARGETPLATFORM"
+# Might need to refer to TARGETPLATFORM a few times in this block, so define something shorter.
+RUN T="$TARGETPLATFORM"; \
+      if [ "$T" = "linux/amd64" ]; \
+      then \
+        MQARCH=X64;\
+        RDURL="https://public.dhe.ibm.com/ibmdl/export/pub/software/websphere/messaging/mqdev/redist";\
+        RDTAR="IBM-MQC-Redist-Linux${MQARCH}.tar.gz"; \
+        cd /opt/mqm \
+        && curl -LO "$RDURL/$VRMF-$RDTAR" \
+        && tar -zxf ./*.tar.gz \
+        && rm -f ./*.tar.gz \
+        && bin/genmqpkg.sh -b /opt/mqm;\
+      elif [ "$T" = "linux/ppc64le" -o "$T" = "linux/s390x" ];\
+      then \
+        cd /MQDEB; \
+        c=`ls ibmmq-*$VRMF*.deb| wc -l`; if [ $c -lt 4 ]; then echo "MQ installation files do not exist in MQDEB subdirectory";exit 1;fi; \
+        for f in ibmmq-runtime_$VRMF*.deb ibmmq-gskit_$VRMF*.deb ibmmq-client_$VRMF*.deb ibmmq-sdk_$VRMF*.deb; do dpkg -i $f;done; \
+      else   \
+        echo "Unsupported platform $T";\
+        exit 1;\
+      fi
 
 # Build Go application
 WORKDIR /go/src/$ORG/$REPO
 COPY go.mod .
 COPY go.sum .
 COPY --chmod=777 ./cmd/${EXPORTER} .
-COPY vendor ./vendor
-COPY pkg ./pkg
+COPY --chmod=777 vendor ./vendor
+COPY --chmod=777 pkg ./pkg
 RUN go build -mod=vendor -o /go/bin/${EXPORTER} ./*.go
 
 # --- --- --- --- --- --- --- --- --- --- --- --- --- --- #
 ### ### ### ### ### ### ### RUN ### ### ### ### ### ### ###
 # --- --- --- --- --- --- --- --- --- --- --- --- --- --- #
-FROM golang:1.19
+FROM golang:1.19 AS runtime
 
 ARG EXPORTER
-ARG GOARCH=amd64
-ARG MQARCH=X64
-
 ENV EXPORTER=${EXPORTER} \
-    RDURL="https://public.dhe.ibm.com/ibmdl/export/pub/software/websphere/messaging/mqdev/redist" \
-    RDTAR="IBM-MQC-Redist-Linux${MQARCH}.tar.gz" \
-    VRMF=9.3.2.0 \
-    genmqpkg_incnls=1 \
-    genmqpkg_incsdk=1 \
-    genmqpkg_inctls=1 \
     LD_LIBRARY_PATH="/opt/mqm/lib64:/usr/lib64" \
     MQ_CONNECT_TYPE=CLIENT \
     IBMMQ_GLOBAL_CONFIGURATIONFILE=/opt/config/${EXPORTER}.yaml

Dockerfile.build

@@ -1,4 +1,4 @@
-# © Copyright IBM Corporation 2019
+# © Copyright IBM Corporation 2019, 2023
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -12,15 +12,17 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-ARG BASE_IMAGE=ubuntu:18.04
+ARG BASE_IMAGE=ubuntu:20.04
 FROM $BASE_IMAGE
 
 ARG GOPATH_ARG="/go"
 ARG GOVERSION=1.17        
+ARG GOARCH=amd64
+ARG MQARCH=X64
 
 ENV GOVERSION=${GOVERSION}   \
     GOPATH=$GOPATH_ARG \
-    GOTAR=go${GOVERSION}.linux-amd64.tar.gz \
+    GOTAR=go${GOVERSION}.linux-${GOARCH}.tar.gz \
     ORG="github.com/ibm-messaging"
 
 
@@ -58,8 +60,8 @@ RUN mkdir -p $GOPATH/src $GOPATH/bin $GOPATH/pkg \
 
 # Location of the downloadable MQ client package \
 ENV RDURL="https://public.dhe.ibm.com/ibmdl/export/pub/software/websphere/messaging/mqdev/redist" \
-    RDTAR="IBM-MQC-Redist-LinuxX64.tar.gz" \
-    VRMF=9.3.2.0
+    RDTAR="IBM-MQC-Redist-Linux${MQARCH}.tar.gz" \
+    VRMF=9.3.3.0
 
 # Install the MQ client from the Redistributable package. This also contains the
 # header files we need to compile against. Setup the subset of the package

Dockerfile.run

@@ -1,4 +1,4 @@
-# © Copyright IBM Corporation 2020
+# © Copyright IBM Corporation 2020,2023
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -12,9 +12,12 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-ARG BASE_IMAGE=ubuntu:18.04
+ARG BASE_IMAGE=ubuntu:20.04
 FROM $BASE_IMAGE
 
+ARG GOARCH=amd64
+ARG MQARCH=X64
+
 # Create location for the git clone and MQ installation
 RUN mkdir -p /opt/bin \
   && chmod -R 777 /opt/bin \
@@ -30,8 +33,8 @@ RUN apt-get update \
 
 # Location of the downloadable MQ client package \
 ENV RDURL="https://public.dhe.ibm.com/ibmdl/export/pub/software/websphere/messaging/mqdev/redist" \
-    RDTAR="IBM-MQC-Redist-LinuxX64.tar.gz" \
-    VRMF=9.3.2.0
+    RDTAR="IBM-MQC-Redist-Linux${MQARCH}.tar.gz" \
+    VRMF=9.3.3.0
 
 # Install the MQ client from the Redistributable package. This also contains the
 # header files we need to compile against. Setup the subset of the package

MQDEB/README

@@ -0,0 +1,5 @@
+If you are using the Dockerfile in the root of this repository
+to build and run an exporter/collector program:
+
+For Linux platforms without a Redistributable Client package, copy
+the .deb installation files into this directory.

README.md

@@ -36,7 +36,7 @@ You will require the following programs:
 
 
 ### MQ Client SDK
-The MQ Client SDK for C programs is required in order to compile and run Go programs. You may have this from an MQ Client installation image (eg rpm, dep formats for Linux, msi for Windows). 
+The MQ Client SDK for C programs is required in order to compile and run Go programs. You may have this from an MQ Client installation image (eg rpm, deb formats for Linux, msi for Windows). 
 
 For Linux x64 and Windows systems, you may also choose to use the 
 MQ Redistributable Client package which is a simple zip/tar file that does not need
@@ -84,9 +84,17 @@ containers. You still need to provide the configuration file at runtime, perhaps
 
 ```
   docker build -t mqprom:1.0 .
-  docker run   -v <directory>/mq_prometheus.yaml:/opt/config/mq_prometheus.yaml mqprom:1.0
+  docker run   -p 9157:9157 -v <directory>/mq_prometheus.yaml:/opt/config/mq_prometheus.yaml mqprom:1.0
 ```  
 
+### Platform support
+This Dockerfile should work for a variety of platforms. For those with a Redistributable client, it uses
+`curl` to automatically download and unpack the required MQ files. For other platforms, it assumes that
+you have an `MQDEB` subdirectory under this root, and then copied the `.deb` files from your
+real MQ installation tree into it.
+
+### Additional container scripts
+
 As a more flexible example, you can use the `buildMonitors.sh` script in the `scripts` subdirectory to 
 build a Docker container that in turn will build all the binary programs and copy them to a local directory. 
 That script also sets some extra version-related flags that will be shown when the program starts. The container will

cmd/mq_aws/README.md

@@ -1,5 +1,9 @@
 # MQ Exporter for Amazon CloudWatch monitoring
 
+This README should be read in conjunction with the repository-wide
+[README](https://github.com/ibm-messaging/mq-metric-samples/blob/master/README.md) 
+that covers features common to all of the collectors in this repository.
+
 This directory contains the code for a monitoring solution
 that exports queue manager data to a CloudWatch data collection
 system. It also contains configuration files to run the monitor program

cmd/mq_aws/exporter.go

@@ -36,6 +36,8 @@ import (
 	"github.com/ibm-messaging/mq-golang/v5/ibmmq"
 	"github.com/ibm-messaging/mq-golang/v5/mqmetric"
 
+	errors "github.com/ibm-messaging/mq-metric-samples/v5/pkg/errors"
+
 	log "github.com/sirupsen/logrus"
 )
 
@@ -192,9 +194,7 @@ func Collect() error {
 			err = pollError
 		}
 
-		if err != nil {
-			log.Fatalf("Error collecting status: %v", err)
-		}
+		errors.HandleStatus(err)
 
 		thisDiscovery := time.Now()
 		elapsed = thisDiscovery.Sub(lastQueueDiscovery)

cmd/mq_coll/README.md

@@ -1,5 +1,9 @@
 # MQ Exporter for Collectd monitoring
 
+This README should be read in conjunction with the repository-wide
+[README](https://github.com/ibm-messaging/mq-metric-samples/blob/master/README.md) 
+that covers features common to all of the collectors in this repository.
+
 This directory contains the code for a monitoring solution
 that sends queue manager data to the collectd system.
 It also contains configuration files to run the monitor program

cmd/mq_coll/exporter.go

@@ -34,6 +34,8 @@ import (
 	"time"
 
 	"github.com/ibm-messaging/mq-golang/v5/mqmetric"
+	errors "github.com/ibm-messaging/mq-metric-samples/v5/pkg/errors"
+
 	log "github.com/sirupsen/logrus"
 )
 
@@ -156,9 +158,7 @@ func Collect() error {
 			err = pollError
 		}
 
-		if err != nil {
-			log.Fatalf("Error collecting status: %v", err)
-		}
+		errors.HandleStatus(err)
 
 		thisDiscovery := time.Now()
 		elapsed = thisDiscovery.Sub(lastQueueDiscovery)