Add selected_message_queues flag to filter message queues and improve performances

ibm_i/assets/configuration/spec.yaml

@@ -94,4 +94,14 @@ files:
           - name: "job_queue"
           - name: "message_queue_info"
         default: *queries_default
+    - name: selected_message_queues
+      description: |
+        Filters the message queues to make your queries less computer-intensive. By default no filter is applied.
+      value:
+        type: array
+        items:
+          type: string
+        example:
+          - QSYSOPR
+          - QPGMR
     - template: instances/default

ibm_i/datadog_checks/ibm_i/config_models/defaults.py

@@ -68,6 +68,10 @@ def instance_query_timeout(field, value):
     return 30
 
 
+def instance_selected_message_queues(field, value):
+    return get_default_field_value(field, value)
+
+
 def instance_service(field, value):
     return get_default_field_value(field, value)
 

ibm_i/datadog_checks/ibm_i/config_models/instance.py

@@ -49,6 +49,7 @@ class Config:
     password: Optional[str]
     queries: Optional[Sequence[Query]]
     query_timeout: Optional[int] = Field(None, gt=0)
+    selected_message_queues: Optional[Sequence[str]]
     service: Optional[str]
     severity_threshold: Optional[int] = Field(None, ge=0, le=99)
     system: Optional[str]

ibm_i/datadog_checks/ibm_i/data/conf.yaml.example

@@ -78,6 +78,13 @@ instances:
     #   - name: job_queue
     #   - name: message_queue_info
 
+    ## @param selected_message_queues - list of strings - optional
+    ## Filters the message queues to make your queries less computer-intensive. By default no filter is applied.
+    #
+    # selected_message_queues:
+    #   - QSYSOPR
+    #   - QPGMR
+
     ## @param tags - list of strings - optional
     ## A list of tags to attach to every metric and service check emitted by this instance.
     ##

ibm_i/datadog_checks/ibm_i/queries.py

@@ -257,13 +257,17 @@ def get_job_queue_info(timeout):
     }
 
 
-def get_message_queue_info(timeout, sev):
+def get_message_queue_info(timeout, sev, selected_message_queues):
+    message_queues_list = [f"'{elt}'" for elt in selected_message_queues]
+    message_queues_filter = (
+        f"WHERE MESSAGE_QUEUE_NAME IN ({', '.join(message_queues_list)})" if selected_message_queues else ""
+    )
     return {
         'name': 'message_queue_info',
         'query': {
             'text': (
                 f'SELECT MESSAGE_QUEUE_NAME, MESSAGE_QUEUE_LIBRARY, COUNT(*), SUM(CASE WHEN SEVERITY >= {sev} THEN 1 ELSE 0 END) '  # noqa:E501
-                'FROM QSYS2.MESSAGE_QUEUE_INFO GROUP BY MESSAGE_QUEUE_NAME, MESSAGE_QUEUE_LIBRARY'
+                f'FROM QSYS2.MESSAGE_QUEUE_INFO {message_queues_filter} GROUP BY MESSAGE_QUEUE_NAME, MESSAGE_QUEUE_LIBRARY'  # noqa:E501
             ),
             'timeout': timeout,
         },
@@ -287,5 +291,7 @@ def query_map(config: InstanceConfig):
         "job_memory_usage": get_job_memory_usage(config.job_query_timeout),
         "memory_info": get_memory_info(config.query_timeout),
         "job_queue": get_job_queue_info(config.query_timeout),
-        "message_queue_info": get_message_queue_info(config.system_mq_query_timeout, config.severity_threshold),
+        "message_queue_info": get_message_queue_info(
+            config.system_mq_query_timeout, config.severity_threshold, config.selected_message_queues
+        ),
     }