Skip to content

Commit 595a3ff

Browse files
atoulmegithub-actions[bot]
atoulme
and
github-actions[bot]
authored
Add back yaml templates used to generate the default config an example (#2123)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
1 parent b373e2e commit 595a3ff

File tree

3 files changed

+342
-0
lines changed

3 files changed

+342
-0
lines changed

‎ibm-mq-metrics/config.yml‎

Lines changed: 213 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,213 @@
1+
#Run it as a scheduled task instead of running every minute.
2+
#If you want to run this every minute, comment this out
3+
#taskSchedule:
4+
# numberOfThreads: 20
5+
# taskDelaySeconds: 300
6+
7+
#This is the timeout on queue metrics and channel metrics threads.Default value is 20 seconds.
8+
#No need to change the default unless you know what you are doing.
9+
#queueMetricsCollectionTimeoutInSeconds: 40
10+
#channelMetricsCollectionTimeoutInSeconds: 40
11+
#topicMetricsCollectionTimeoutInSeconds: 40
12+
13+
queueManagers:
14+
- name: "QM1"
15+
host: "localhost"
16+
port: 1414
17+
18+
# Indicate the MaxActiveChannels as set in qm.ini, see https://www.ibm.com/docs/en/ibm-mq/9.3.x?topic=qmini-channels-stanza-file
19+
maxActiveChannels: 4200
20+
21+
#The transport type for the queue manager connection, the default is "Bindings" for a binding type connection
22+
#For bindings type, connection WMQ extension (i.e machine agent) need to be on the same machine on which WebbsphereMQ server is running
23+
#For client type, connection change it to "Client".
24+
transportType: "Bindings"
25+
26+
#Channel name of the queue manager, channel should be server-conn type.
27+
#This field is not required in case of transportType: Bindings
28+
#channelName: "SYSTEM.ADMIN.SVRCONN"
29+
30+
#for user access level, please check "Access Permissions" section on the extensions page
31+
#comment out the username and password in case of transportType: Bindings.
32+
#username: ""
33+
#password: ""
34+
35+
#PCF requests are always sent to SYSTEM.ADMIN.COMMAND.QUEUE. The PCF responses to these requests are sent to the default reply-to queue called
36+
#SYSTEM.DEFAULT.MODEL.QUEUE. However, you can override this behavior and send it to a temporary dynamic queue by changing the modelQueueName and replyQueuePrefix fields.
37+
#For more details around this https://www.ibm.com/support/knowledgecenter/SSFKSJ_7.5.0/com.ibm.mq.ref.adm.doc/q083240_.htm & https://www.ibm.com/support/knowledgecenter/SSFKSJ_8.0.0/com.ibm.mq.adm.doc/q020010_.htm
38+
#modelQueueName: ""
39+
#replyQueuePrefix: ""
40+
41+
# Name of the temporary dynamic queue holding the configuration events. This queue contains information regarding the configuration of the queue manager, notable MaxChannels and MaxActiveChannels.
42+
# If unset, the default queue name `SYSTEM.ADMIN.CONFIG.EVENT` is applied.
43+
# Configuration events need to be enabled explicitly in the queue manager configuration. See https://www.ibm.com/docs/en/ibm-mq/9.4.x?topic=monitoring-configuration-events for reference.
44+
#configurationQueueName: "SYSTEM.ADMIN.CONFIG.EVENT"
45+
46+
# Interval in milliseconds at which the configuration events in the configuration queue can be consumed.
47+
# By default, no events are consumed.
48+
#consumeConfigurationEventInterval: 600000 # 10 minutes
49+
50+
# Enable running a queue manager refresh request to reload its configuration and create a configuration event.
51+
# This action is only executed if no configuration events are found when reading the configuration queue.name:
52+
# By default, this action is disabled.
53+
#refreshQueueManagerConfigurationEnabled: false
54+
55+
#Sets the CCSID used in the message descriptor of request and response messages. The default value is MQC.MQCCSI_Q_MGR.
56+
#To set this, please use the integer value.
57+
#ccsid:
58+
59+
#Sets the encoding used in the message descriptor of request and response messages. The default value is MQC.MQENC_NATIVE.
60+
#To set this, please use the integer value.
61+
#encoding:
62+
63+
# IBM Cipher Suite e.g. "SSL_RSA_WITH_AES_128_CBC_SHA256"..
64+
# For translation to IBM Cipher http://www.ibm.com/support/knowledgecenter/SSFKSJ_8.0.0/com.ibm.mq.dev.doc/q113210_.htm
65+
# A cipher working for IBM Cloud MQ and Temurin JDK 8 is TLS_AES_128_GCM_SHA256
66+
#cipherSuite: ""
67+
68+
queueFilters:
69+
#Can provide complete queue name or generic names. A generic name is a character string followed by an asterisk (*),
70+
#for example ABC*, and it selects all objects having names that start with the selected character string.
71+
#An asterisk on its own matches all possible names.
72+
include: ["*"]
73+
exclude:
74+
#type value: STARTSWITH, EQUALS, ENDSWITH, CONTAINS
75+
- type: "STARTSWITH"
76+
#The name of the queue or queue name pattern as per queue filter, comma separated values
77+
values: ["SYSTEM","AMQ"]
78+
79+
80+
channelFilters:
81+
#Can provide complete channel name or generic names. A generic name is a character string followed by an asterisk (*),
82+
#for example ABC*, and it selects all objects having names that start with the selected character string.
83+
#An asterisk on its own matches all possible names.
84+
include: ["*"]
85+
exclude:
86+
#type value: STARTSWITH, EQUALS, ENDSWITH, CONTAINS
87+
- type: "STARTSWITH"
88+
#The name of the queue or queue name pattern as per queue filter, comma separated values
89+
values: ["SYSTEM"]
90+
91+
listenerFilters:
92+
#Can provide complete channel name or generic names. A generic name is a character string followed by an asterisk (*),
93+
#for example ABC*, and it selects all objects having names that start with the selected character string.
94+
#An asterisk on its own matches all possible names.
95+
include: ["*"]
96+
exclude:
97+
#type value: STARTSWITH, EQUALS, ENDSWITH, CONTAINS
98+
- type: "STARTSWITH"
99+
#The name of the queue or queue name pattern as per queue filter, comma separated values
100+
values: ["SYSTEM"]
101+
102+
topicFilters:
103+
# For topics, IBM MQ uses the topic wildcard characters ('#' and '+') and does not treat a trailing asterisk as a wildcard
104+
# https://www.ibm.com/support/knowledgecenter/en/SSFKSJ_7.5.0/com.ibm.mq.pla.doc/q005020_.htm
105+
include: ["#"]
106+
exclude:
107+
#type value: STARTSWITH, EQUALS, ENDSWITH, CONTAINS
108+
- type: "STARTSWITH"
109+
#The name of the queue or queue name pattern as per queue filter, comma separated values
110+
values: ["SYSTEM","$SYS"]
111+
112+
metrics:
113+
"ibm.mq.message.retry.count": # Number of message retries
114+
enabled: true
115+
"ibm.mq.status": # Channel status
116+
enabled: true
117+
"ibm.mq.max.sharing.conversations": # Maximum number of conversations permitted on this channel instance.
118+
enabled: true
119+
"ibm.mq.current.sharing.conversations": # Current number of conversations permitted on this channel instance.
120+
enabled: true
121+
"ibm.mq.byte.received": # Number of bytes received
122+
enabled: true
123+
"ibm.mq.byte.sent": # Number of bytes sent
124+
enabled: true
125+
"ibm.mq.buffers.received": # Buffers received
126+
enabled: true
127+
"ibm.mq.buffers.sent": # Buffers sent
128+
enabled: true
129+
"ibm.mq.message.count": # Message count
130+
enabled: true
131+
"ibm.mq.open.input.count": # Count of applications sending messages to the queue
132+
enabled: true
133+
"ibm.mq.open.output.count": # Count of applications consuming messages from the queue
134+
enabled: true
135+
"ibm.mq.high.queue.depth": # The current high queue depth
136+
enabled: true
137+
"ibm.mq.service.interval": # The queue service interval
138+
enabled: true
139+
"ibm.mq.queue.depth.full.event": # The number of full queue events
140+
enabled: true
141+
"ibm.mq.queue.depth.high.event": # The number of high queue events
142+
enabled: true
143+
"ibm.mq.queue.depth.low.event": # The number of low queue events
144+
enabled: true
145+
"ibm.mq.uncommitted.messages": # Number of uncommitted messages
146+
enabled: true
147+
"ibm.mq.oldest.msg.age": # Queue message oldest age
148+
enabled: true
149+
"ibm.mq.current.max.queue.filesize": # Current maximum queue file size
150+
enabled: true
151+
"ibm.mq.current.queue.filesize": # Current queue file size
152+
enabled: true
153+
"ibm.mq.instances.per.client": # Instances per client
154+
enabled: true
155+
"ibm.mq.message.deq.count": # Message dequeue count
156+
enabled: true
157+
"ibm.mq.message.enq.count": # Message enqueue count
158+
enabled: true
159+
"ibm.mq.queue.depth": # Current queue depth
160+
enabled: true
161+
"ibm.mq.service.interval.event": # Queue service interval event
162+
enabled: true
163+
"ibm.mq.reusable.log.size": # The amount of space occupied, in megabytes, by log extents available to be reused.
164+
enabled: true
165+
"ibm.mq.manager.active.channels": # The queue manager active maximum channels limit
166+
enabled: true
167+
"ibm.mq.restart.log.size": # Size of the log data required for restart recovery in megabytes.
168+
enabled: true
169+
"ibm.mq.max.queue.depth": # Maximum queue depth
170+
enabled: true
171+
"ibm.mq.onqtime.short_period": # Amount of time, in microseconds, that a message spent on the queue, over a short period
172+
enabled: true
173+
"ibm.mq.onqtime.long_period": # Amount of time, in microseconds, that a message spent on the queue, over a longer period
174+
enabled: true
175+
"ibm.mq.message.received.count": # Number of messages received
176+
enabled: true
177+
"ibm.mq.message.sent.count": # Number of messages sent
178+
enabled: true
179+
"ibm.mq.max.instances": # Max channel instances
180+
enabled: true
181+
"ibm.mq.connection.count": # Active connections count
182+
enabled: true
183+
"ibm.mq.manager.status": # Queue manager status
184+
enabled: true
185+
"ibm.mq.heartbeat": # Queue manager heartbeat
186+
enabled: true
187+
"ibm.mq.archive.log.size": # Queue manager archive log size
188+
enabled: true
189+
"ibm.mq.manager.max.active.channels": # Queue manager max active channels
190+
enabled: true
191+
"ibm.mq.manager.statistics.interval": # Queue manager statistics interval
192+
enabled: true
193+
"ibm.mq.publish.count": # Topic publication count
194+
enabled: true
195+
"ibm.mq.subscription.count": # Topic subscription count
196+
enabled: true
197+
"ibm.mq.listener.status": # Listener status
198+
enabled: true
199+
"ibm.mq.unauthorized.event": # Number of authentication error events
200+
enabled: true
201+
"ibm.mq.manager.max.handles": # Max open handles
202+
enabled: true
203+
204+
sslConnection:
205+
trustStorePath: ""
206+
trustStorePassword: ""
207+
208+
keyStorePath: ""
209+
keyStorePassword: ""
210+
211+
# Configure the OTLP exporter using system properties keys following the specification https://opentelemetry.io/docs/languages/java/configuration/
212+
otlpExporter:
213+
otel.exporter.otlp.endpoint: http://localhost:4318

‎ibm-mq-metrics/templates/registry/yaml/config.yml.j2‎

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
#Run it as a scheduled task instead of running every minute.
2+
#If you want to run this every minute, comment this out
3+
#taskSchedule:
4+
# numberOfThreads: 20
5+
# taskDelaySeconds: 300
6+
7+
#This is the timeout on queue metrics and channel metrics threads.Default value is 20 seconds.
8+
#No need to change the default unless you know what you are doing.
9+
#queueMetricsCollectionTimeoutInSeconds: 40
10+
#channelMetricsCollectionTimeoutInSeconds: 40
11+
#topicMetricsCollectionTimeoutInSeconds: 40
12+
13+
queueManagers:
14+
- name: "QM1"
15+
host: "localhost"
16+
port: 1414
17+
18+
# Indicate the MaxActiveChannels as set in qm.ini, see https://www.ibm.com/docs/en/ibm-mq/9.3.x?topic=qmini-channels-stanza-file
19+
maxActiveChannels: 4200
20+
21+
#The transport type for the queue manager connection, the default is "Bindings" for a binding type connection
22+
#For bindings type, connection WMQ extension (i.e machine agent) need to be on the same machine on which WebbsphereMQ server is running
23+
#For client type, connection change it to "Client".
24+
transportType: "Bindings"
25+
26+
#Channel name of the queue manager, channel should be server-conn type.
27+
#This field is not required in case of transportType: Bindings
28+
#channelName: "SYSTEM.ADMIN.SVRCONN"
29+
30+
#for user access level, please check "Access Permissions" section on the extensions page
31+
#comment out the username and password in case of transportType: Bindings.
32+
#username: ""
33+
#password: ""
34+
35+
#PCF requests are always sent to SYSTEM.ADMIN.COMMAND.QUEUE. The PCF responses to these requests are sent to the default reply-to queue called
36+
#SYSTEM.DEFAULT.MODEL.QUEUE. However, you can override this behavior and send it to a temporary dynamic queue by changing the modelQueueName and replyQueuePrefix fields.
37+
#For more details around this https://www.ibm.com/support/knowledgecenter/SSFKSJ_7.5.0/com.ibm.mq.ref.adm.doc/q083240_.htm & https://www.ibm.com/support/knowledgecenter/SSFKSJ_8.0.0/com.ibm.mq.adm.doc/q020010_.htm
38+
#modelQueueName: ""
39+
#replyQueuePrefix: ""
40+
41+
# Name of the temporary dynamic queue holding the configuration events. This queue contains information regarding the configuration of the queue manager, notable MaxChannels and MaxActiveChannels.
42+
# If unset, the default queue name `SYSTEM.ADMIN.CONFIG.EVENT` is applied.
43+
# Configuration events need to be enabled explicitly in the queue manager configuration. See https://www.ibm.com/docs/en/ibm-mq/9.4.x?topic=monitoring-configuration-events for reference.
44+
#configurationQueueName: "SYSTEM.ADMIN.CONFIG.EVENT"
45+
46+
# Interval in milliseconds at which the configuration events in the configuration queue can be consumed.
47+
# By default, no events are consumed.
48+
#consumeConfigurationEventInterval: 600000 # 10 minutes
49+
50+
# Enable running a queue manager refresh request to reload its configuration and create a configuration event.
51+
# This action is only executed if no configuration events are found when reading the configuration queue.name:
52+
# By default, this action is disabled.
53+
#refreshQueueManagerConfigurationEnabled: false
54+
55+
#Sets the CCSID used in the message descriptor of request and response messages. The default value is MQC.MQCCSI_Q_MGR.
56+
#To set this, please use the integer value.
57+
#ccsid:
58+
59+
#Sets the encoding used in the message descriptor of request and response messages. The default value is MQC.MQENC_NATIVE.
60+
#To set this, please use the integer value.
61+
#encoding:
62+
63+
# IBM Cipher Suite e.g. "SSL_RSA_WITH_AES_128_CBC_SHA256"..
64+
# For translation to IBM Cipher http://www.ibm.com/support/knowledgecenter/SSFKSJ_8.0.0/com.ibm.mq.dev.doc/q113210_.htm
65+
# A cipher working for IBM Cloud MQ and Temurin JDK 8 is TLS_AES_128_GCM_SHA256
66+
#cipherSuite: ""
67+
68+
queueFilters:
69+
#Can provide complete queue name or generic names. A generic name is a character string followed by an asterisk (*),
70+
#for example ABC*, and it selects all objects having names that start with the selected character string.
71+
#An asterisk on its own matches all possible names.
72+
include: ["*"]
73+
exclude:
74+
#type value: STARTSWITH, EQUALS, ENDSWITH, CONTAINS
75+
- type: "STARTSWITH"
76+
#The name of the queue or queue name pattern as per queue filter, comma separated values
77+
values: ["SYSTEM","AMQ"]
78+
79+
80+
channelFilters:
81+
#Can provide complete channel name or generic names. A generic name is a character string followed by an asterisk (*),
82+
#for example ABC*, and it selects all objects having names that start with the selected character string.
83+
#An asterisk on its own matches all possible names.
84+
include: ["*"]
85+
exclude:
86+
#type value: STARTSWITH, EQUALS, ENDSWITH, CONTAINS
87+
- type: "STARTSWITH"
88+
#The name of the queue or queue name pattern as per queue filter, comma separated values
89+
values: ["SYSTEM"]
90+
91+
listenerFilters:
92+
#Can provide complete channel name or generic names. A generic name is a character string followed by an asterisk (*),
93+
#for example ABC*, and it selects all objects having names that start with the selected character string.
94+
#An asterisk on its own matches all possible names.
95+
include: ["*"]
96+
exclude:
97+
#type value: STARTSWITH, EQUALS, ENDSWITH, CONTAINS
98+
- type: "STARTSWITH"
99+
#The name of the queue or queue name pattern as per queue filter, comma separated values
100+
values: ["SYSTEM"]
101+
102+
topicFilters:
103+
# For topics, IBM MQ uses the topic wildcard characters ('#' and '+') and does not treat a trailing asterisk as a wildcard
104+
# https://www.ibm.com/support/knowledgecenter/en/SSFKSJ_7.5.0/com.ibm.mq.pla.doc/q005020_.htm
105+
include: ["#"]
106+
exclude:
107+
#type value: STARTSWITH, EQUALS, ENDSWITH, CONTAINS
108+
- type: "STARTSWITH"
109+
#The name of the queue or queue name pattern as per queue filter, comma separated values
110+
values: ["SYSTEM","$SYS"]
111+
112+
metrics:
113+
{% for metric in ctx %} {{ metric.metric_name }}: # {{ metric.brief | safe }}
114+
enabled: true
115+
{% endfor %}
116+
sslConnection:
117+
trustStorePath: ""
118+
trustStorePassword: ""
119+
120+
keyStorePath: ""
121+
keyStorePassword: ""
122+
123+
# Configure the OTLP exporter using system properties keys following the specification https://opentelemetry.io/docs/languages/java/configuration/
124+
otlpExporter:
125+
otel.exporter.otlp.endpoint: http://localhost:4318

‎ibm-mq-metrics/templates/registry/yaml/weaver.yaml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
templates:
2+
- pattern: config.yml.j2
3+
filter: '.groups | map(select(.type == "metric"))'
4+
application_mode: single

0 commit comments

Comments
 (0)