Remove invalid host tags (#17549)

* remove invalid host tags

* Improve validation

* Add changelog

* Update test after merge

Author: sarah-witt

esxi/assets/configuration/spec.yaml

@@ -147,8 +147,8 @@ files:
           description: |
             Use this option to send a subset of host tags as metric tags.
             The ESXi integration collects tags for every ESXi host or VM in your environment.
-            Those tags can be `esxi_url`, esxi_type`, `esxi_host`, `esxi_folder`, `esxi_cluster`
-            `esxi_compute`, `esxi_datacenter`, `esxi_datastore` and are attached to the ESXi metrics by default.
+            Those tags can be `esxi_url`, esxi_type`, `esxi_host`, and `esxi_datastore`
+            and are attached to the ESXi metrics by default.
             By default these tags are submitted as host tags, but you can submit them as metric tags instead by using
             this configuration option, see: https://docs.datadoghq.com/tagging/using_tags/
             You will lose the ability to filter your hosts on the tags you specify but they will appear faster

esxi/changelog.d/17549.fixed

@@ -0,0 +1 @@
+Remove invalid host tags

esxi/datadog_checks/esxi/check.py

@@ -63,8 +63,7 @@ def _validate_excluded_host_tags(self, excluded_host_tags):
             if excluded_host_tag not in AVAILABLE_HOST_TAGS:
                 self.log.warning(
                     "Unknown host tag `%s` cannot be excluded. Available host tags are: "
-                    "`esxi_url`, `esxi_type`, `esxi_host`, `esxi_folder`, `esxi_cluster` "
-                    "`esxi_compute`, `esxi_datacenter`, and `esxi_datastore`",
+                    "`esxi_url`, `esxi_type`, `esxi_host`, `esxi_compute`, and `esxi_datastore`",
                     excluded_host_tag,
                 )
             else:
@@ -423,17 +422,12 @@ def check(self, _):
                 runtime_hostname = to_string(runtime_host_props.get("name", "unknown"))
                 tags.append('esxi_host:{}'.format(runtime_hostname))
 
-                if runtime_host is not None:
-                    tags.extend(
-                        get_tags_recursively(
-                            runtime_host,
-                            resource_map,
-                            include_only=['esxi_cluster'],
-                        )
-                    )
-
             if parent is not None:
-                tags.extend(get_tags_recursively(parent, resource_map))
+                tags.extend(
+                    get_tags_recursively(
+                        parent, resource_map, include_only=["esxi_compute", "esxi_host", "esxi_datastore"]
+                    )
+                )
 
             tags.append('esxi_type:{}'.format(resource_type_name))
 

esxi/datadog_checks/esxi/constants.py

@@ -61,10 +61,7 @@
     "esxi_url",
     "esxi_type",
     "esxi_host",
-    "esxi_folder",
-    "esxi_cluster",
     "esxi_compute",
-    "esxi_datacenter",
     "esxi_datastore",
 ]
 

esxi/datadog_checks/esxi/data/conf.yaml.example

@@ -108,8 +108,8 @@ instances:
     ## @param excluded_host_tags - list of strings - optional - default: []
     ## Use this option to send a subset of host tags as metric tags.
     ## The ESXi integration collects tags for every ESXi host or VM in your environment.
-    ## Those tags can be `esxi_url`, esxi_type`, `esxi_host`, `esxi_folder`, `esxi_cluster`
-    ## `esxi_compute`, `esxi_datacenter`, `esxi_datastore` and are attached to the ESXi metrics by default.
+    ## Those tags can be `esxi_url`, esxi_type`, `esxi_host`, and `esxi_datastore`
+    ## and are attached to the ESXi metrics by default.
     ## By default these tags are submitted as host tags, but you can submit them as metric tags instead by using
     ## this configuration option, see: https://docs.datadoghq.com/tagging/using_tags/
     ## You will lose the ability to filter your hosts on the tags you specify but they will appear faster

esxi/tests/test_integration.py

@@ -85,9 +85,6 @@ def test_vcsim_external_host_tags(vcsim_instance, datadog_agent, dd_run_check):
         {
             'esxi': [
                 'esxi_compute:localhost.localdomain',
-                'esxi_datacenter:ha-datacenter',
-                'esxi_folder:ha-folder-root',
-                'esxi_folder:host',
                 'esxi_type:host',
                 'esxi_url:127.0.0.1:8989',
             ]
@@ -97,9 +94,6 @@ def test_vcsim_external_host_tags(vcsim_instance, datadog_agent, dd_run_check):
         'ha-host_VM0',
         {
             'esxi': [
-                'esxi_datacenter:ha-datacenter',
-                'esxi_folder:ha-folder-root',
-                'esxi_folder:vm',
                 'esxi_type:vm',
                 'esxi_host:localhost.localdomain',
                 'esxi_url:127.0.0.1:8989',
@@ -110,9 +104,6 @@ def test_vcsim_external_host_tags(vcsim_instance, datadog_agent, dd_run_check):
         'ha-host_VM1',
         {
             'esxi': [
-                'esxi_datacenter:ha-datacenter',
-                'esxi_folder:ha-folder-root',
-                'esxi_folder:vm',
                 'esxi_type:vm',
                 'esxi_host:localhost.localdomain',
                 'esxi_url:127.0.0.1:8989',
@@ -129,16 +120,10 @@ def test_esxi_resource_count_metrics(vcsim_instance, dd_run_check, aggregator):
 
     host_tags = [
         'esxi_compute:localhost.localdomain',
-        'esxi_datacenter:ha-datacenter',
-        'esxi_folder:ha-folder-root',
-        'esxi_folder:host',
         'esxi_type:host',
         'esxi_url:127.0.0.1:8989',
     ]
     vm_tags = [
-        'esxi_datacenter:ha-datacenter',
-        'esxi_folder:ha-folder-root',
-        'esxi_folder:vm',
         'esxi_type:vm',
         'esxi_host:localhost.localdomain',
         'esxi_url:127.0.0.1:8989',

esxi/tests/test_unit.py

@@ -154,8 +154,6 @@ def test_external_host_tags(vcsim_instance, datadog_agent, dd_run_check):
         'localhost.localdomain',
         {
             'esxi': [
-                'esxi_datacenter:dc2',
-                'esxi_folder:folder_1',
                 'esxi_type:host',
                 'esxi_url:127.0.0.1:8989',
             ]
@@ -165,8 +163,6 @@ def test_external_host_tags(vcsim_instance, datadog_agent, dd_run_check):
         'vm1',
         {
             'esxi': [
-                'esxi_datacenter:dc2',
-                'esxi_folder:folder_1',
                 'esxi_type:vm',
                 'esxi_host:localhost.localdomain',
                 'esxi_url:127.0.0.1:8989',
@@ -177,7 +173,6 @@ def test_external_host_tags(vcsim_instance, datadog_agent, dd_run_check):
         'vm2',
         {
             'esxi': [
-                'esxi_cluster:c1',
                 'esxi_compute:c1',
                 'esxi_type:vm',
                 'esxi_url:127.0.0.1:8989',
@@ -275,10 +270,8 @@ def test_external_host_tags_all_resources(vcsim_instance, datadog_agent, dd_run_
         'hostname',
         {
             'esxi': [
-                'esxi_cluster:c1',
                 'esxi_compute:c1',
                 'esxi_datastore:ds1',
-                'esxi_datastore_cluster:pod1',
                 'esxi_type:host',
                 'esxi_url:127.0.0.1:8989',
             ]
@@ -289,7 +282,6 @@ def test_external_host_tags_all_resources(vcsim_instance, datadog_agent, dd_run_
         {
             'esxi': [
                 'esxi_type:vm',
-                'esxi_cluster:c1',
                 'esxi_host:hostname',
                 'esxi_url:127.0.0.1:8989',
             ]
@@ -544,13 +536,13 @@ def test_invalid_instance_filters(dd_run_check, vcsim_instance, caplog):
         pytest.param(
             ['test'],
             "Unknown host tag `test` cannot be excluded. Available host tags are: `esxi_url`, `esxi_type`, "
-            "`esxi_host`, `esxi_folder`, `esxi_cluster` `esxi_compute`, `esxi_datacenter`, and `esxi_datastore`",
+            "`esxi_host`, `esxi_compute`, and `esxi_datastore`",
             id="unknown tag",
         ),
         pytest.param(
-            ['esxi_type', 'esxi_cluster', 'hello'],
+            ['esxi_type', 'hello'],
             "Unknown host tag `hello` cannot be excluded. Available host tags are: `esxi_url`, `esxi_type`, "
-            "`esxi_host`, `esxi_folder`, `esxi_cluster` `esxi_compute`, `esxi_datacenter`, and `esxi_datastore`",
+            "`esxi_host`, `esxi_compute`, and `esxi_datastore`",
             id="known and unknown tags together",
         ),
     ],
@@ -568,16 +560,13 @@ def test_excluded_host_tags(
     if expected_warning is not None:
         assert expected_warning in caplog.text
 
-    host_external_tags = ['esxi_datacenter:dc2', 'esxi_folder:folder_1', 'esxi_type:host', 'esxi_url:127.0.0.1:8989']
+    host_external_tags = ['esxi_type:host', 'esxi_url:127.0.0.1:8989']
     vm_1_external_tags = [
-        'esxi_datacenter:dc2',
-        'esxi_folder:folder_1',
         'esxi_type:vm',
         'esxi_url:127.0.0.1:8989',
         'esxi_host:localhost.localdomain',
     ]
     vm_2_external_tags = [
-        'esxi_cluster:c1',
         'esxi_compute:c1',
         'esxi_type:vm',
         'esxi_url:127.0.0.1:8989',
@@ -1216,8 +1205,6 @@ def test_use_configured_hostname(vcsim_instance, dd_run_check, aggregator, datad
         '127.0.0.1:8989',
         {
             'esxi': [
-                'esxi_datacenter:dc2',
-                'esxi_folder:folder_1',
                 'esxi_type:host',
                 'esxi_url:127.0.0.1:8989',
             ]