README
¶
mq-metric-samples
This repository contains a collection of IBM® MQ sample clients that utilize the IBM® MQ golang metric packages to provide a program that can be used with existing monitoring technologies such as Prometheus, AWS CloudWatch, etc.
Health Warning
This package is provided as-is with no guarantees of support or updates. There are also no guarantees of compatibility with any future versions of the package; interfaces and functions are subject to change based on any feedback.
These programs use a specific version of the mqmetric and ibmmq golang packages.
Those packages are in the mq-golang repository
and are also included in the vendor tree of this repository.
Getting started
Requirements
You will require the following programs:
- Go compiler. This should be at least version 10. If you see an error similar to "ld: NULL not defined" then it is likely you need to upgrade your compiler.
- dep - Golang dependency management tool
To build the programs on Linux and MacOS, you must set an environment variable to permit some compile/link flags. This is due to security controls in the compiler.
export CGO_LDFLAGS_ALLOW="-Wl,-rpath.*"
Building a component
- Change directory to your go path. (
cd $GOPATH) - Use git to get a copy of this repository into a new directory in the workspace:
git clone https://github.com/ibm-messaging/mq-metric-samples.git src/github.com/ibm-messaging/mq-metric-samples
- Navigate to the mq-metric-samples root directory (
$GOPATH/src/github.com/ibm-messaging/mq-metric-samples) - Run
depto ensure that you have the correct dependencies downloaded:
dep ensure
- Compile the sample program you wish to use. See the README in each directory for more information.
At this point, you should have a compiled copy of the code in $GOPATH/bin. Each
monitor agent directory also has sample scripts, configuration files etc to help
with getting the agent running in your specific environment.
Using a Docker container to build the programs
You can use the buildMonitors.sh script in this directory to build a Docker container that
in turn will build 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.
More information
Each of the sample monitor programs has its own README file describing the capabilities in more detail. In general, the Prometheus monitor program is likely to be the most recent, supporting the newest features of the MQ APIs.
History
See CHANGELOG in this directory.
Issues and Contributions
For feedback and issues relating specifically to this package, please use the GitHub issue tracker.
Contributions to this package can be accepted under the terms of the IBM Contributor License Agreement, found in the CLA file of this repository. When submitting a pull request, you must include a statement stating you accept the terms in the CLA.
Copyright
© Copyright IBM Corporation 2016, 2019
Directories