Add hostname_transform config option to Nutanix integration (DataDog#23769)

* feat(nutanix): add hostname_transform config option to spec

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

* feat(nutanix): apply hostname_transform in infrastructure monitor

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

* test(nutanix): add tests for hostname_transform option

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

* test(nutanix): fix false-positive hostname_transform tests

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

* chore(nutanix): add changelog entry for hostname_transform

* fix ddev validate

* Use enum type for hostname_transform config option

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* ddev validate models -s

* Restore original description for hostname_transform

* fix(nutanix): use display_hostname in stats exception log

---------

Co-authored-by: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

Author: NouemanKHAL

nutanix/assets/configuration/spec.yaml

@@ -229,6 +229,20 @@ files:
               type: boolean
               example: true
             fleet_configurable: false
+          - name: hostname_transform
+            description: |
+              Should be either 'upper' or 'lower' or 'default'.
+              If 'upper', the check will convert the Nutanix hostname to uppercase.
+              If 'lower', the check will convert the Nutanix hostname to lowercase.
+              If 'default', the check will not transform the Nutanix 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.
+            fleet_configurable: false
+            value:
+              type: string
+              enum:
+              - upper
+              - lower
+              - default
           - template: instances/http
           - template: instances/default
             overrides:

nutanix/changelog.d/23769.added

@@ -0,0 +1 @@
+Add `hostname_transform` config option to transform all Nutanix hostnames (hosts and VMs) to uppercase, lowercase, or leave them unchanged.

nutanix/datadog_checks/nutanix/config_models/instance.py

@@ -90,6 +90,7 @@ class InstanceConfig(BaseModel):
     exclude_filtered_resources_from_cluster_capacity: Optional[bool] = None
     extra_headers: Optional[MappingProxyType[str, Any]] = None
     headers: Optional[MappingProxyType[str, Any]] = None
+    hostname_transform: Optional[Literal['upper', 'lower', 'default']] = None
     kerberos_auth: Optional[Literal['required', 'optional', 'disabled']] = None
     kerberos_cache: Optional[str] = None
     kerberos_delegate: Optional[bool] = None

nutanix/datadog_checks/nutanix/data/conf.yaml.example

@@ -186,6 +186,15 @@ instances:
     #
     # batch_vm_collection: true
 
+    ## @param hostname_transform - string - optional
+    ## Should be either 'upper' or 'lower' or 'default'.
+    ## If 'upper', the check will convert the Nutanix hostname to uppercase.
+    ## If 'lower', the check will convert the Nutanix hostname to lowercase.
+    ## If 'default', the check will not transform the Nutanix 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: <HOSTNAME_TRANSFORM>
+
     ## @param proxy - mapping - optional
     ## This overrides the `proxy` setting in `init_config`.
     ##

nutanix/datadog_checks/nutanix/infrastructure_monitor.py

@@ -237,10 +237,12 @@ def _process_vm(self, vm: dict, vm_stats_dict: dict[str, list[dict]], cluster_na
         if not self._should_collect_vm(vm):
             return False
 
+        display_hostname = self._transform_hostname(vm_name)
+
         vm_tags = self.check.base_tags + self._extract_vm_tags(vm)
-        self._set_external_tags_for_host(vm_name, vm_tags)
-        self._report_vm_basic_metrics(vm, vm_name, vm_tags)
-        self._report_vm_stats(vm_id, vm_name, vm_tags, vm_stats_dict, cluster_name)
+        self._set_external_tags_for_host(display_hostname, vm_tags)
+        self._report_vm_basic_metrics(vm, display_hostname, vm_tags)
+        self._report_vm_stats(vm_id, display_hostname, vm_tags, vm_stats_dict, cluster_name)
         return True
 
     def _report_vm_basic_metrics(self, vm: dict, vm_name: str, vm_tags: list[str]) -> None:
@@ -435,11 +437,13 @@ def _process_single_host(
             self.host_count += 1
             self.host_names[host_id] = host_name
 
+            display_hostname = self._transform_hostname(host_name)
+
             host_tags = cluster_tags + self._extract_host_tags(host)
-            self.check.gauge("host.count", 1, hostname=host_name, tags=host_tags)
-            self._report_host_status_metrics(host, host_name, host_tags)
-            self._set_external_tags_for_host(host_name, host_tags)
-            self._report_host_capacity_metrics(host, host_name, host_tags)
+            self.check.gauge("host.count", 1, hostname=display_hostname, tags=host_tags)
+            self._report_host_status_metrics(host, display_hostname, host_tags)
+            self._set_external_tags_for_host(display_hostname, host_tags)
+            self._report_host_capacity_metrics(host, display_hostname, host_tags)
 
             try:
                 stats = self._get_stats(f"api/clustermgmt/v4.0/stats/clusters/{cluster_id}/hosts/{host_id}")
@@ -449,12 +453,12 @@ def _process_single_host(
                         stats,
                         HOST_STATS_METRICS,
                         host_tags,
-                        hostname=host_name,
+                        hostname=display_hostname,
                         extra_tags_by_key=self._get_disk_status_storage_tags(host_id),
                     )
             except Exception:
                 self.check.log.exception(
-                    "[%s][%s] Failed to fetch stats for host %s", self._pc_label, cluster_name, host_name
+                    "[%s][%s] Failed to fetch stats for host %s", self._pc_label, cluster_name, display_hostname
                 )
 
         host_label = host_name or host_id
@@ -573,6 +577,17 @@ def _set_external_tags_for_host(self, hostname: str, tags: list[str]) -> None:
 
         self.external_tags.append((hostname, {self.check.__NAMESPACE__: tags}))
 
+    def _transform_hostname(self, hostname: str | None) -> str | None:
+        """Apply hostname_transform config to a hostname."""
+        if not hostname:
+            return hostname
+        transform = self.check.config.hostname_transform
+        if transform == 'upper':
+            return hostname.upper()
+        if transform == 'lower':
+            return hostname.lower()
+        return hostname
+
     def _should_collect_vm(self, vm: dict) -> bool:
         """Check if a VM should be collected based on power state and resource filters."""
         has_power_state_filter = any(

nutanix/tests/test_configuration.py

@@ -110,3 +110,12 @@ def test_category_tags_with_prefix_for_system_and_user_types(dd_run_check, aggre
         category_tags = [t for t in metric.tags if "Environment:" in t or "Team:" in t]
         unprefixed_tags = [t for t in category_tags if not t.startswith("ntnx_")]
         assert not unprefixed_tags, f"Category tags must have ntnx_ prefix, found without: {unprefixed_tags}"
+
+
+def test_invalid_hostname_transform_raises_error(dd_run_check, mock_instance):
+    instance = mock_instance.copy()
+    instance['hostname_transform'] = 'INVALID'
+    check = NutanixCheck('nutanix', {}, [instance])
+
+    with pytest.raises(Exception, match="hostname_transform"):
+        dd_run_check(check)

nutanix/tests/test_hosts.py

@@ -102,3 +102,47 @@ def test_external_tags_for_host(dd_run_check, aggregator, mock_instance, mock_ht
         HOST_NAME,
         {'nutanix': HOST_TAGS},
     )
+
+
+def test_hostname_transform_upper_applies_to_host(dd_run_check, aggregator, mock_instance, mock_http_get):
+    instance = mock_instance.copy()
+    instance['hostname_transform'] = 'upper'
+    check = NutanixCheck('nutanix', {}, [instance])
+    dd_run_check(check)
+
+    aggregator.assert_metric("nutanix.host.count", value=1, tags=HOST_TAGS, hostname=HOST_NAME.upper())
+
+
+def test_hostname_transform_lower_applies_to_host(dd_run_check, aggregator, mock_instance, mock_http_get, mocker):
+    cluster_id = "00064715-c043-5d8f-ee4b-176ec875554d"
+    uppercase_host = {
+        "extId": "d8787814-4fe8-4ba5-931f-e1ee31c294a6",
+        "hostName": "UPPER-HOST-10-0-0-103",
+        "hostType": "HYPER_CONVERGED",
+        "maintenanceState": "NORMAL",
+        "hypervisor": {
+            "type": "AHV",
+            "acropolisConnectionState": "CONNECTED",
+            "fullName": "AHV 10.3",
+        },
+        "nodeStatus": "NORMAL",
+    }
+    mocker.patch(
+        "datadog_checks.nutanix.infrastructure_monitor.InfrastructureMonitor._list_hosts_by_cluster",
+        side_effect=lambda cid: [uppercase_host] if cid == cluster_id else [],
+    )
+    instance = mock_instance.copy()
+    instance['hostname_transform'] = 'lower'
+    check = NutanixCheck('nutanix', {}, [instance])
+    dd_run_check(check)
+
+    aggregator.assert_metric("nutanix.host.count", value=1, hostname="upper-host-10-0-0-103")
+
+
+def test_hostname_transform_default_leaves_host_unchanged(dd_run_check, aggregator, mock_instance, mock_http_get):
+    instance = mock_instance.copy()
+    instance['hostname_transform'] = 'default'
+    check = NutanixCheck('nutanix', {}, [instance])
+    dd_run_check(check)
+
+    aggregator.assert_metric("nutanix.host.count", value=1, tags=HOST_TAGS, hostname=HOST_NAME)

nutanix/tests/test_vms.py

@@ -8,7 +8,7 @@
 
 from datadog_checks.nutanix import NutanixCheck
 from tests.conftest import load_fixture_page
-from tests.constants import OFF_VM_NAME, OFF_VM_TAGS, PCVM_NAME, PCVM_TAGS
+from tests.constants import OFF_VM_NAME, OFF_VM_TAGS, PCVM_NAME, PCVM_TAGS, UBUNTU_VM_NAME, UBUNTU_VM_TAGS
 from tests.metrics import VM_STATS_METRICS_REQUIRED
 
 pytestmark = [pytest.mark.unit]
@@ -170,3 +170,21 @@ def test_external_tags_for_vm(dd_run_check, aggregator, mock_instance, mock_http
         PCVM_NAME,
         {'nutanix': PCVM_TAGS},
     )
+
+
+def test_hostname_transform_upper_applies_to_vm(dd_run_check, aggregator, mock_instance, mock_http_get):
+    instance = mock_instance.copy()
+    instance['hostname_transform'] = 'upper'
+    check = NutanixCheck('nutanix', {}, [instance])
+    dd_run_check(check)
+
+    aggregator.assert_metric("nutanix.vm.count", value=1, tags=UBUNTU_VM_TAGS, hostname=UBUNTU_VM_NAME.upper())
+
+
+def test_hostname_transform_lower_applies_to_vm(dd_run_check, aggregator, mock_instance, mock_http_get):
+    instance = mock_instance.copy()
+    instance['hostname_transform'] = 'lower'
+    check = NutanixCheck('nutanix', {}, [instance])
+    dd_run_check(check)
+
+    aggregator.assert_metric("nutanix.vm.count", value=1, tags=PCVM_TAGS, hostname=PCVM_NAME.lower())