[FRAGENT-2908] Added the hostname_transform config option (#18652)

* adding hostname_to_upper and hostname_to_lower config options

* added a changelog

* addressing comments

* modified changelog

* improved testing coverage

* changed 'none' keyword to 'default' and assert_external_tags

* addressing comments

vsphere/assets/configuration/spec.yaml

@@ -509,6 +509,16 @@ files:
         value:
           type: boolean
           example: true
+      - name: hostname_transform
+        description: |
+          Should be either 'upper' or 'lower' or 'default'
+          If 'upper', the check will convert the vSphere hostname to uppercase.
+          If 'lower', the check will convert the vSphere hostname to lowercase.
+          If 'default', the check will not transform the vSphere hostname (the default option).
+          Use this if you install the agent in VMs so that the hosts are not duplicated in the web application UI.
+        value:
+          type: string
+          example: default
       - name: rest_api_options
         description: |
           REST API options

vsphere/changelog.d/18652.added

@@ -0,0 +1 @@
+Added the hostname_transform config option

vsphere/datadog_checks/vsphere/config.py

@@ -28,6 +28,7 @@
     EXCLUDE_FILTERS,
     EXTRA_FILTER_PROPERTIES_FOR_VMS,
     HISTORICAL,
+    HOSTNAME_CASE_OPTIONS,
     MOR_TYPE_AS_STRING,
     OBJECT_PROPERTIES_BY_RESOURCE_TYPE,
     PROPERTY_METRICS_BY_RESOURCE_TYPE,
@@ -141,6 +142,12 @@ def __init__(self, instance, init_config, log):
         )
         self.include_datastore_cluster_folder_tag = instance.get("include_datastore_cluster_folder_tag", True)
         self.custom_tags = instance.get('tags', [])
+        self.hostname_transform = instance.get('hostname_transform', 'default')
+        if self.hostname_transform not in HOSTNAME_CASE_OPTIONS:
+            raise ConfigurationError(
+                "Invalid value for `hostname_transform` in the configuration file: "
+                + "use one of: `default`, `lower`, or `upper`"
+            )
         self.validate_config()
 
     def is_historical(self):

vsphere/datadog_checks/vsphere/config_models/defaults.py

@@ -60,6 +60,10 @@ def instance_excluded_host_tags():
     return []
 
 
+def instance_hostname_transform():
+    return 'default'
+
+
 def instance_include_datastore_cluster_folder_tag():
     return True
 

vsphere/datadog_checks/vsphere/config_models/instance.py

@@ -154,6 +154,7 @@ class InstanceConfig(BaseModel):
     event_resource_filters: Optional[tuple[str, ...]] = None
     excluded_host_tags: Optional[tuple[str, ...]] = None
     host: str
+    hostname_transform: Optional[str] = None
     include_datastore_cluster_folder_tag: Optional[bool] = None
     include_events: Optional[tuple[IncludeEvent, ...]] = None
     max_historical_metrics: Optional[int] = None

vsphere/datadog_checks/vsphere/constants.py

@@ -217,3 +217,5 @@
     'PermissionEvent',
     'ScheduledTaskEvent',
 ]
+
+HOSTNAME_CASE_OPTIONS = ['default', 'lower', 'upper']

vsphere/datadog_checks/vsphere/data/conf.yaml.example

@@ -445,6 +445,15 @@ instances:
     #
     # include_datastore_cluster_folder_tag: true
 
+    ## @param hostname_transform - string - optional - default: default
+    ## Should be either 'upper' or 'lower' or 'default'
+    ## If 'upper', the check will convert the vSphere hostname to uppercase.
+    ## If 'lower', the check will convert the vSphere hostname to lowercase.
+    ## If 'default', the check will not transform the vSphere hostname (the default option).
+    ## Use this if you install the agent in VMs so that the hosts are not duplicated in the web application UI.
+    #
+    # hostname_transform: default
+
     ## REST API options
     ## The options are used when making vSphere REST API calls to retrieve vSphere tags
     ## when `collect_tags` instance config is enabled.

vsphere/datadog_checks/vsphere/vsphere.py

@@ -340,6 +340,10 @@ def refresh_infrastructure_cache(self):
             mor_payload["tags"] = tags  # type: Dict[str, Any]
 
             if hostname:
+                if self._config.hostname_transform == 'upper':
+                    hostname = hostname.upper()
+                elif self._config.hostname_transform == 'lower':
+                    hostname = hostname.lower()
                 mor_payload['hostname'] = hostname
 
             self.infrastructure_cache.set_mor_props(mor, mor_payload)

vsphere/tests/fixtures/host_tags_values.json

@@ -356,7 +356,7 @@
         }
     ],
     [
-        "VM4-6",
+        "vm4-6",
         {
             "vsphere": [
                 "vsphere_host:10.0.0.104",
@@ -371,7 +371,7 @@
         }
     ],
     [
-        "VM4-7",
+        "vm4-7",
         {
             "vsphere": [
                 "vsphere_host:10.0.0.104",
@@ -386,7 +386,7 @@
         }
     ],
     [
-        "VM4-8",
+        "vm4-8",
         {
             "vsphere": [
                 "vsphere_host:10.0.0.104",