Add new config use_ssl for Tibco EMS (#23732)

* Add option to connect via ssl

* Update model for new use_ssl config

* Fixing is_affirmative import error

* Add unit test for new config

* Add changelog

* Applying lint

* Displaying true as the example for config use_ssl

Author: ddog-nasirthomas

tibco_ems/assets/configuration/spec.yaml

@@ -63,4 +63,12 @@ files:
       value:
         type: string
         require_trusted_provider: true
+    - name: use_ssl
+      description: |
+        Set to `true` to connect to the Tibco EMS server using SSL (`ssl://host:port`).
+        When `false`, the check uses `tcp://host:port`.
+      value:
+        type: boolean
+        default: false
+        example: true
     - template: instances/default

tibco_ems/changelog.d/23732.added

@@ -0,0 +1 @@
+Add new config ``use_ssl`` to connect via SSL instead of TCP.

tibco_ems/datadog_checks/tibco_ems/config_models/defaults.py

@@ -34,3 +34,7 @@ def instance_min_collection_interval():
 
 def instance_port():
     return 7222
+
+
+def instance_use_ssl():
+    return False

tibco_ems/datadog_checks/tibco_ems/config_models/instance.py

@@ -49,6 +49,7 @@ class InstanceConfig(BaseModel):
     service: Optional[str] = None
     tags: Optional[tuple[str, ...]] = None
     tibemsadmin: Optional[str] = None
+    use_ssl: Optional[bool] = None
     username: Optional[str] = None
 
     @model_validator(mode='before')

tibco_ems/datadog_checks/tibco_ems/data/conf.yaml.example

@@ -58,6 +58,12 @@ instances:
     #
     # tibemsadmin: <TIBEMSADMIN>
 
+    ## @param use_ssl - boolean - optional - default: false
+    ## Set to `true` to connect to the Tibco EMS server using SSL (`ssl://host:port`).
+    ## When `false`, the check uses `tcp://host:port`.
+    #
+    # use_ssl: true
+
     ## @param tags - list of strings - optional
     ## A list of tags to attach to every metric and service check emitted by this instance.
     ##

tibco_ems/datadog_checks/tibco_ems/tibco_ems.py

@@ -5,14 +5,15 @@
 import subprocess
 from typing import Any  # noqa: F401
 
-from datadog_checks.base import AgentCheck
+from datadog_checks.base import AgentCheck, is_affirmative
 
 from .constants import SHOW_METRIC_DATA, UNIT_PATTERN
 
 DEFAULT_HOST = 'localhost'
 DEFAULT_PORT = 7222
 TO_BYTES = {'b': 1, 'kb': 1e3, 'mb': 1e6, 'gb': 1e9, 'tb': 1e12}
-CONNECTION_STRING = 'tcp://{}:{}'
+TCP_CONNECTION_STRING = 'tcp://{}:{}'
+SSL_CONNECTION_STRING = 'ssl://{}:{}'
 
 
 class TibcoEMSCheck(AgentCheck):
@@ -29,7 +30,11 @@ def __init__(self, name, init_config, instances):
         username = self.instance.get('username')
         password = self.instance.get('password')
         script_path = self.instance.get('script_path')
-        server_string = CONNECTION_STRING.format(host, port)
+        use_ssl = is_affirmative(self.instance.get('use_ssl', False))
+        if not use_ssl:
+            server_string = TCP_CONNECTION_STRING.format(host, port)
+        else:
+            server_string = SSL_CONNECTION_STRING.format(host, port)
         self.tags = self.instance.get('tags', [])
 
         self.cmd = tibemsadmin_cmd + [

tibco_ems/tests/test_unit.py

@@ -163,3 +163,8 @@ def test_base_tags(dd_run_check, instance):
 
     # assert the lenght of tags does not grow indefinitely
     assert len(check.tags) == 3
+
+
+def test_use_ssl_server_string(instance):
+    check = TibcoEMSCheck('tibco_ems', {}, [{**instance, 'use_ssl': True}])
+    assert 'ssl://localhost:7222' in check.cmd