Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Properly close internal reply queues #9488

Merged
merged 2 commits into from
Jun 9, 2021
Merged

Properly close internal reply queues #9488

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1f39f59
Properly close internal reply queues
coignetp Jun 8, 2021
c05da10
Define pcf
coignetp Jun 8, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions ibm_mq/datadog_checks/ibm_mq/collectors/queue_metric_collector.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,7 @@ def _discover_queues(self, queue_manager, mq_pattern_filter):

for queue_type in SUPPORTED_QUEUE_TYPES:
args = {pymqi.CMQC.MQCA_Q_NAME: pymqi.ensure_bytes(mq_pattern_filter), pymqi.CMQC.MQIA_Q_TYPE: queue_type}
pcf = None
try:
pcf = pymqi.PCFExecute(queue_manager, convert=self.config.convert_endianness)
response = pcf.MQCMD_INQUIRE_Q(args)
Expand All @@ -94,6 +95,12 @@ def _discover_queues(self, queue_manager, mq_pattern_filter):
for queue_info in response:
queue = queue_info[pymqi.CMQC.MQCA_Q_NAME]
queues.append(to_string(queue).strip())
finally:
# Close internal reply queue to prevent filling up a dead-letter queue.
# https://github.com/dsuch/pymqi/blob/084ab0b2638f9d27303a2844badc76635c4ad6de/code/pymqi/__init__.py#L2892-L2902
# https://dsuch.github.io/pymqi/examples.html#how-to-specify-dynamic-reply-to-queues
if pcf is not None:
pcf.disconnect()
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

any chances this can throw an exception?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It shouldn't as exceptions are handled inside this method
https://github.com/dsuch/pymqi/blob/35d0e45ea16c0b2077b20906856f587d6f8ffa6a/code/pymqi/__init__.py#L2900-L2910


return queues

Expand All @@ -115,6 +122,7 @@ def queue_stats(self, queue_manager, queue_name, tags):
"""
Grab stats from queues
"""
pcf = None
try:
args = {pymqi.CMQC.MQCA_Q_NAME: pymqi.ensure_bytes(queue_name), pymqi.CMQC.MQIA_Q_TYPE: pymqi.CMQC.MQQT_ALL}
pcf = pymqi.PCFExecute(queue_manager, convert=self.config.convert_endianness)
Expand All @@ -128,6 +136,9 @@ def queue_stats(self, queue_manager, queue_name, tags):
# Response is a list. It likely has only one member in it.
for queue_info in response:
self._submit_queue_stats(queue_info, queue_name, tags)
finally:
if pcf is not None:
pcf.disconnect()

def _submit_queue_stats(self, queue_info, queue_name, tags):
for metric_suffix, mq_attr in iteritems(metrics.queue_metrics()):
Expand All @@ -146,6 +157,7 @@ def _submit_queue_stats(self, queue_info, queue_name, tags):
self.log.debug("Attribute %s (%s) not found for queue %s", metric_suffix, mq_attr, queue_name)

def get_pcf_queue_status_metrics(self, queue_manager, queue_name, tags):
pcf = None
try:
args = {
pymqi.CMQC.MQCA_Q_NAME: pymqi.ensure_bytes(queue_name),
Expand Down Expand Up @@ -174,8 +186,12 @@ def get_pcf_queue_status_metrics(self, queue_manager, queue_name, tags):
msg = "Unable to get {}, turn on queue level monitoring to access these metrics for {}"
msg = msg.format(mname, queue_name)
self.log.debug(msg)
finally:
if pcf is not None:
pcf.disconnect()

def get_pcf_queue_reset_metrics(self, queue_manager, queue_name, tags):
pcf = None
try:
args = {pymqi.CMQC.MQCA_Q_NAME: pymqi.ensure_bytes(queue_name)}
pcf = pymqi.PCFExecute(queue_manager, convert=self.config.convert_endianness)
Expand All @@ -191,3 +207,6 @@ def get_pcf_queue_reset_metrics(self, queue_manager, queue_name, tags):
metrics_map = metrics.pcf_status_reset_metrics()
prefix = "{}.queue".format(metrics.METRIC_PREFIX)
self.send_metrics_from_properties(queue_info, metrics_map, prefix, tags)
finally:
if pcf is not None:
pcf.disconnect()