Skip to content

Commit cb3a0a6

Browse files
authored
Extended readme
1 parent 64ad158 commit cb3a0a6

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# mq-java-exporter
22

3-
Prometheus exporter for API and system metrics exposed by IBM MQ, written in Java.
3+
Prometheus exporter for IBM MQ, written in Java. Exposes API of IBM MQ and system metrics of it's host machine.
44

55
## Getting Started
66

@@ -9,7 +9,6 @@ Prometheus exporter for API and system metrics exposed by IBM MQ, written in Jav
99
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.
1010

1111
#### Prerequisites
12-
1312
- [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)
1413
- [Maven](https://maven.apache.org/)
1514

@@ -18,14 +17,12 @@ Support [IBM MQ](https://www.ibm.com/support/knowledgecenter/en/SSFKSJ_9.0.0/com
1817
- [IBM MQ](https://www.ibm.com/support/knowledgecenter/en/SSFKSJ_9.0.0/com.ibm.mq.helphome.v90.doc/WelcomePagev9r0.htm)
1918

2019
#### Configuration
21-
2220
All settings have to be set in mq-java-exporter\src\main\resources\exporter_config.yaml.
2321
- MQ connection information. Describes MQ connection information.
2422
- Prometheus connection information. Describes Prometheus connection information.
2523
- Monitoring objects. Sets names of objects, that have to be monitored: queues, channels.
2624

27-
1. Download current repository.
28-
2. Go to mq-java-exporter\src\main\resources. exporter_config.yaml file is located there. Fill it with actual data.
25+
1. Fill exporter_config.yaml with your enviroments configuration.
2926

3027
#### Build
3128

@@ -1083,7 +1080,12 @@ mvn package
10831080
</tbody>
10841081
</table>
10851082

1086-
License
1087-
-------
1083+
## Issues and Contributions
1084+
Feel free to express your thoughts about the exporter, unexpected behaviour and\or issues. New feature suggestions are welcome, use [issue tracker](https://github.com/Cinimex-Informatica/mq-java-exporter/issues).
1085+
Pull requests are always welcome.
1086+
1087+
## Warning
1088+
The exporter is provided as-is with no guarantees.
10881089

1089-
Code is licensed under the [Apache License 2.0](https://github.com/Cinimex-Informatica/mq-java-exporter/blob/master/LICENSE).
1090+
## License
1091+
The exporter and it's code is licensed under the [Apache License 2.0](https://github.com/Cinimex-Informatica/mq-java-exporter/blob/master/LICENSE).

0 commit comments

Comments
 (0)