Skip to content

Commit 64ad158

Browse files
authored
Changed readme structure
1 parent 192e8b7 commit 64ad158

File tree

1 file changed

+19
-20
lines changed

1 file changed

+19
-20
lines changed

README.md

Lines changed: 19 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,33 @@
11
# mq-java-exporter
22

3-
IBM MQ exporter for Prometheus.
3+
Prometheus exporter for API and system metrics exposed by IBM MQ, written in Java.
44

5-
Compatibility
6-
-------------
5+
## Getting Started
76

8-
Support [IBM MQ](https://www.ibm.com/support/knowledgecenter/en/SSFKSJ_9.0.0/com.ibm.mq.helphome.v90.doc/WelcomePagev9r0.htm) version 9.0.0.0 (and later).
7+
#### Compatibility
98

10-
Dependency
11-
----------
9+
Support [IBM MQ](https://www.ibm.com/support/knowledgecenter/en/SSFKSJ_9.0.0/com.ibm.mq.helphome.v90.doc/WelcomePagev9r0.htm) version 9.0.x.x.
1210

13-
- [Prometheus](https://prometheus.io)
14-
- [Maven](https://maven.apache.org/)
15-
- [IBM MQ](https://www.ibm.com/support/knowledgecenter/en/SSFKSJ_9.0.0/com.ibm.mq.helphome.v90.doc/WelcomePagev9r0.htm)
11+
#### Prerequisites
1612

17-
Download
18-
--------
13+
- [IBM JRE 8 or higher](https://developer.ibm.com/javasdk/downloads/sdk8/) \ [Oracle JRE 8 or higher](https://www.oracle.com/technetwork/java/javase/downloads/index.html) \ [OpenJDK JRE 8 or higher](https://jdk.java.net/java-se-ri/8)
14+
- [Maven](https://maven.apache.org/)
1915

20-
At the moment build from sources is only available.
16+
#### Dependencies
17+
- [Prometheus](https://prometheus.io)
18+
- [IBM MQ](https://www.ibm.com/support/knowledgecenter/en/SSFKSJ_9.0.0/com.ibm.mq.helphome.v90.doc/WelcomePagev9r0.htm)
2119

20+
#### Configuration
2221

23-
Preparations
24-
-------
22+
All settings have to be set in mq-java-exporter\src\main\resources\exporter_config.yaml.
23+
- MQ connection information. Describes MQ connection information.
24+
- Prometheus connection information. Describes Prometheus connection information.
25+
- Monitoring objects. Sets names of objects, that have to be monitored: queues, channels.
2526

2627
1. Download current repository.
2728
2. Go to mq-java-exporter\src\main\resources. exporter_config.yaml file is located there. Fill it with actual data.
2829

29-
Build
30-
-------
30+
#### Build
3131

3232
1. Download current repository.
3333
2. Install [Maven](https://maven.apache.org/).
@@ -38,15 +38,14 @@ mvn package
3838
```
3939

4040
4. After processing is completed, go to mq-java-exporter/target. dependency-jars directory and webspheremq_exporter.jar should appear there.
41-
5. To run exporter, dependency-jars directory (and all jars in it) and webspheremq_exporter.jar should be located in the same folder.
41+
5. To run exporter, dependency-jars directory (and all jars in it) and mq_exporter.jar should be located in the same folder.
4242
6. To run exporter execute the following command:
4343

4444
```shell
45-
java -jar webspheremq_exporter.jar /opt/mq_exporter/exporter_config.yaml
45+
java -jar mq_exporter.jar /opt/mq_exporter/exporter_config.yaml
4646
```
4747

48-
Metrics
49-
-------
48+
## Metrics
5049
#### Platform central processing units
5150
###### CPU performance - platform wide
5251
<table class="wrapped confluenceTable">

0 commit comments

Comments
 (0)