rename configuration value to allowed_service_tags

Author: mimato

consul/assets/configuration/spec.yaml

@@ -109,7 +109,7 @@ files:
           - <SERVICE_1>
           - <SERVICE_2>
 
-    - name: services_tags_keys_include
+    - name: allowed_service_tags
       description: |
         If set, only tags with keys matching this list will be sent to Datadog.
         This is helpful if you have a lot of tags on services that are not

consul/changelog.d/20306.added

@@ -1 +1 @@
-Add a new feature to filter Consul service tags being sent to Datadog using an allow list. It can be configured using the `services_tags_keys_include` option.
+Add a new feature to filter Consul service tags being sent to Datadog using an allow list. It can be configured using the `allowed_service_tags` option.

consul/datadog_checks/consul/config_models/instance.py

@@ -56,6 +56,7 @@ class InstanceConfig(BaseModel):
     )
     acl_token: Optional[str] = None
     allow_redirects: Optional[bool] = None
+    allowed_service_tags: Optional[tuple[str, ...]] = None
     auth_token: Optional[AuthToken] = None
     auth_type: Optional[str] = None
     aws_host: Optional[str] = None
@@ -91,7 +92,6 @@ class InstanceConfig(BaseModel):
     service: Optional[str] = None
     services_exclude: Optional[tuple[str, ...]] = None
     services_include: Optional[tuple[str, ...]] = None
-    services_tags_keys_include: Optional[tuple[str, ...]] = None
     single_node_install: Optional[bool] = None
     skip_proxy: Optional[bool] = None
     tags: Optional[tuple[str, ...]] = None

consul/datadog_checks/consul/consul.py

@@ -106,8 +106,8 @@ def __init__(self, name, init_config, instances):
             'service_whitelist', self.instance.get('services_include', default_services_include)
         )
         self.services_exclude = set(self.instance.get('services_exclude', self.init_config.get('services_exclude', [])))
-        self.services_tags_keys_include = set(
-            self.instance.get("services_tags_keys_include", self.init_config.get("services_tags_keys_include", []))
+        self.allowed_service_tags = set(
+            self.instance.get("allowed_service_tags", self.init_config.get("allowed_service_tags", []))
         )
         self.max_services = self.instance.get('max_services', self.init_config.get('max_services', MAX_SERVICES))
         self.threads_count = self.instance.get('threads_count', self.init_config.get('threads_count', THREADS_COUNT))
@@ -316,13 +316,13 @@ def _cull_services_list(self, services):
         return services
 
     def _cull_services_tags_list(self, services):
-        if self.services_tags_keys_include:
+        if self.allowed_service_tags:
             # services is a dict of {service_name: [tags]} where tags is a list
             # of string having the form of "tagkey=tagvalue"
             for service in services:
                 tags = services[service]
                 # get the tagkey (the part before the "=") and check it against the include list
-                tags = [t for t in tags if t.split("=")[0].lower() in self.services_tags_keys_include]
+                tags = [t for t in tags if t.split("=")[0].lower() in self.allowed_service_tags]
                 services[service] = tags
 
         return services

consul/datadog_checks/consul/data/conf.yaml.example

@@ -126,13 +126,13 @@ instances:
     #   - <SERVICE_1>
     #   - <SERVICE_2>
 
-    ## @param services_tags_keys_include - list of strings - optional
+    ## @param allowed_service_tags - list of strings - optional
     ## If set, only tags with keys matching this list will be sent to Datadog.
     ## This is helpful if you have a lot of tags on services that are not
     ## relevant to Datadog (ingress routing tags, etc). Tags should be specified
     ## here in lowercase. Otherwise, the check will downcase tags from Consul before comparing.
     #
-    # services_tags_keys_include:
+    # allowed_service_tags:
     #   - <TAG_1>
     #   - <TAG_2>
 

consul/tests/test_unit.py

@@ -81,7 +81,7 @@ def test_cull_services_tags_keys(aggregator):
         "unwanted.tag.noequals",
     }
 
-    consul_check.services_tags_keys_include = include_tags
+    consul_check.allowed_service_tags = include_tags
     services = consul_mocks.mock_get_n_custom_tagged_services_in_cluster(6, all_tags)
 
     services = consul_check._cull_services_tags_list(services)