Skip to content

Commit fadf7f1

Browse files
JEFFLUFCGitHub Enterprise
authored andcommitted
Document HTTPS metrics (#837)
* Document HTTPS metrics
1 parent bcd6555 commit fadf7f1

File tree

2 files changed

+19
-1
lines changed

2 files changed

+19
-1
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
## 9.4.2.0 (2025-02)
44

55
* Updated to MQ version 9.4.2.0
6+
* Queue Manager metrics can be served via HTTPS by populating `/etc/mqm/metrics/pki/keys` with TLS keys.
67

78
## 9.4.1.0 (2024-10)
89

docs/usage.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ docker run \
4040
The Docker image always uses `/mnt/mqm` for MQ data, which is correctly linked for you under `/var/mqm` at runtime. This is to handle problems with file permissions on some platforms.
4141

4242
## Running with the default configuration and Prometheus metrics enabled
43-
You can run a queue manager with [Prometheus](https://prometheus.io) metrics enabled. The following command will generate Prometheus metrics for your queue manager on `/metrics` port `9157`:
43+
You can run a queue manager with [Prometheus](https://prometheus.io) metrics enabled. The following command will generate Prometheus metrics for your queue manager on `/metrics` port `9157` via **HTTP**:
4444

4545
```sh
4646
docker run \
@@ -54,6 +54,23 @@ docker run \
5454
icr.io/ibm-messaging/mq
5555
```
5656

57+
To configure a queue manager to serve metrics via **HTTPS**, TLS keys must be provided in `/etc/mqm/metrics/pki/keys`. These files must be PEM encoded certificates named `tls.key` (server public certificate) and `tls.crt` (server private key), you may optionally provide a `ca.crt` file (CA public certificate). If no TLS keys are provided, an HTTP server will be used. The following command will generate Prometheus metrics for your queue manager on `/metrics` port `9157` via **HTTPS**:
58+
59+
60+
```sh
61+
docker run \
62+
--env LICENSE=accept \
63+
--env MQ_QMGR_NAME=QM1 \
64+
--env MQ_ENABLE_METRICS=true \
65+
-v "<TLS_DIR>:/etc/mqm/metrics/pki/keys" \
66+
--publish 1414:1414 \
67+
--publish 9443:9443 \
68+
--publish 9157:9157 \
69+
--detach \
70+
icr.io/ibm-messaging/mq
71+
```
72+
**Note:** <TLS_DIR> should be replaced with a directory in which you have the required TLS files.
73+
5774
## Customizing the queue manager configuration
5875

5976
You can customize the configuration in several ways:

0 commit comments

Comments
 (0)