Skip to content

Commit eb77243

Browse files
committed
Update READMEs
1 parent 172d438 commit eb77243

File tree

4 files changed

+76
-56
lines changed

4 files changed

+76
-56
lines changed

cmd/mq_aws/README.md

100755100644
Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -24,23 +24,25 @@ the queues to monitor. There may be better solutions using templates, but
2424
that starts to get more complex than I want to show in this example.
2525

2626
## Building
27-
* This github repository contains both the monitoring program and
28-
the ibmmq package that links to the core MQ application interface. It
29-
also contains the mqmetric package used as a common component for
30-
supporting alternative database collection protocols.
31-
32-
* You also need access to the AWS Go client interfaces.
33-
34-
The command `go get -u github.com/aws/aws-sdk-go/service` should pull
35-
down the client code and its dependencies.
36-
37-
* The error logger package may need to be explicitly downloaded
38-
39-
On my system, I also had to forcibly download the logger package,
40-
using `go get -u github.com/sirupsen/logrus`.
41-
42-
Run `go build -o <directory>/mq_aws cmd/mq_aws/*.go` to compile
43-
the program and put it to a specific directory.
27+
* You need to have the MQ client libraries installed first.
28+
* Set up an environment for compiling Go programs
29+
```
30+
export GOPATH=~/go (or wherever you want to put it)
31+
export GOROOT=/usr/lib/golang (or wherever you have installed it)
32+
mkdir -p $GOPATH/src
33+
cd $GOPATH/src
34+
```
35+
* Clone this GitHub repository for the monitoring programs into your GOPATH. The repository
36+
contains the prereq packages at a suitable version in the `vendor` tree
37+
```
38+
git clone https://github.com/ibm-message/mq-metric-samples ibm-messaging/mq-metric-samples
39+
```
40+
* From the root of your GOPATH you can then compile the code
41+
```
42+
cd $GOPATH
43+
export CGO_LDFLAGS_ALLOW='-Wl,-rpath.*'
44+
go build -o bin/mq_aws ibm-messaging/mq-metric-samples/cmd/mq_aws/*.go
45+
```
4446

4547
## Configuring MQ
4648
It is convenient to run the monitor program as a queue manager service.

cmd/mq_coll/README.md

100755100644
Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,16 +22,25 @@ create data sources in Grafana called "CollectD TSDB" or "CollectD Graphite"
2222
that point at your database server, and then import the JSON file.
2323

2424
## Building
25-
* This github repository contains both the monitoring program and
26-
the ibmmq package that links to the core MQ application interface. It
27-
also contains the mqmetric package used as a common component for
28-
supporting alternative database collection protocols.
29-
30-
* Get the error logger package used by all of these monitors
31-
using `go get -u github.com/sirupsen/logrus`.
32-
33-
Run `go build -o <directory>/mq_coll cmd/mq_coll/*.go` to compile
34-
the program and put it to a specific directory.
25+
* You need to have the MQ client libraries installed first.
26+
* Set up an environment for compiling Go programs
27+
```
28+
export GOPATH=~/go (or wherever you want to put it)
29+
export GOROOT=/usr/lib/golang (or wherever you have installed it)
30+
mkdir -p $GOPATH/src
31+
cd $GOPATH/src
32+
```
33+
* Clone this GitHub repository for the monitoring programs into your GOPATH. The repository
34+
contains the prereq packages at a suitable version in the `vendor` tree
35+
```
36+
git clone https://github.com/ibm-message/mq-metric-samples ibm-messaging/mq-metric-samples
37+
```
38+
* From the root of your GOPATH you can then compile the code
39+
```
40+
cd $GOPATH
41+
export CGO_LDFLAGS_ALLOW='-Wl,-rpath.*'
42+
go build -o bin/mq_coll ibm-messaging/mq-metric-samples/cmd/mq_coll/*.go
43+
```
3544

3645
## Configuring MQ
3746

cmd/mq_influx/README.md

100755100644
Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -21,25 +21,26 @@ create a data source in Grafana called "MQ Influx" that points at your
2121
database server, and then import the JSON file.
2222

2323
## Building
24-
* This github repository contains both the monitoring program and
25-
the ibmmq package that links to the core MQ application interface. It
26-
also contains the mqmetric package used as a common component for
27-
supporting alternative database collection protocols.
24+
* You need to have the MQ client libraries installed first.
25+
* Set up an environment for compiling Go programs
26+
```
27+
export GOPATH=~/go (or wherever you want to put it)
28+
export GOROOT=/usr/lib/golang (or wherever you have installed it)
29+
mkdir -p $GOPATH/src
30+
cd $GOPATH/src
31+
```
32+
* Clone this GitHub repository for the monitoring programs into your GOPATH. The repository
33+
contains the prereq packages at a suitable version in the `vendor` tree
34+
```
35+
git clone https://github.com/ibm-message/mq-metric-samples ibm-messaging/mq-metric-samples
36+
```
37+
* From the root of your GOPATH you can then compile the code
38+
```
39+
cd $GOPATH
40+
export CGO_LDFLAGS_ALLOW='-Wl,-rpath.*'
41+
go build -o bin/mq_influx ibm-messaging/mq-metric-samples/cmd/mq_influx/*.go
42+
```
2843

29-
* You also need access to the InfluxDB Go client interface.
30-
31-
The command `go get -u github.com/influxdata/influxdb1-client/v2` should pull
32-
down the client code and its dependencies. Although this package will automatically
33-
download the correct component via `dep ensure` or make use of the existing `vendor`
34-
directory.
35-
36-
* The error logger package may need to be explicitly downloaded
37-
38-
On my system, I also had to forcibly download the logger package,
39-
using `go get -u github.com/sirupsen/logrus`.
40-
41-
Run `go build -o <directory>/mq_influx cmd/mq_influx/*.go` to compile
42-
the program and put it to a specific directory.
4344

4445
## Configuring MQ
4546
It is convenient to run the monitor program as a queue manager service.

cmd/mq_opentsdb/README.md

100755100644
Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -21,18 +21,26 @@ create a data source in Grafana called "MQ OpenTSDB" that points at your
2121
database server, and then import the JSON file.
2222

2323
## Building
24-
* This github repository contains both the monitoring program and
25-
the ibmmq package that links to the core MQ application interface. It
26-
also contains the mqmetric package used as a common component for
27-
supporting alternative database collection protocols.
2824

29-
* The error logger package may need to be explicitly downloaded
30-
31-
On my system, I also had to forcibly download the logger package,
32-
using `go get -u github.com/sirupsen/logrus`.
33-
34-
Run `go build -o <directory>/mq_opentsdb cmd/mq_opentsdb/*.go` to compile
35-
the program and put it to a specific directory.
25+
* You need to have the MQ client libraries installed first.
26+
* Set up an environment for compiling Go programs
27+
```
28+
export GOPATH=~/go (or wherever you want to put it)
29+
export GOROOT=/usr/lib/golang (or wherever you have installed it)
30+
mkdir -p $GOPATH/src
31+
cd $GOPATH/src
32+
```
33+
* Clone this GitHub repository for the monitoring programs into your GOPATH. The repository
34+
contains the prereq packages at a suitable version in the `vendor` tree
35+
```
36+
git clone https://github.com/ibm-message/mq-metric-samples ibm-messaging/mq-metric-samples
37+
```
38+
* From the root of your GOPATH you can then compile the code
39+
```
40+
cd $GOPATH
41+
export CGO_LDFLAGS_ALLOW='-Wl,-rpath.*'
42+
go build -o bin/mq_opentsdb ibm-messaging/mq-metric-samples/cmd/mq_opentsdb/*.go
43+
```
3644

3745
## Configuring MQ
3846
It is convenient to run the monitor program as a queue manager service.

0 commit comments

Comments
 (0)