Rename cluster_name tag to envoy_cluster

envoy/assets/configuration/spec.yaml

@@ -77,6 +77,14 @@ files:
       value:
         type: boolean
         example: true
+    - name: disable_legacy_cluster_tag
+      description: |
+        Enable to stop submitting the tag `cluster_name` and `virtual_cluster_name`,
+        which has been renamed to `envoy_cluster` and `virtual_envoy_cluster`.
+      value:
+        type: boolean
+        display_default: false
+        example: true
     - template: instances/default
     - template: instances/http
       overrides:

envoy/datadog_checks/envoy/config_models/defaults.py

@@ -52,6 +52,10 @@ def instance_connect_timeout(field, value):
     return get_default_field_value(field, value)
 
 
+def instance_disable_legacy_cluster_tag(field, value):
+    return True
+
+
 def instance_empty_default_hostname(field, value):
     return False
 

envoy/datadog_checks/envoy/config_models/instance.py

@@ -42,6 +42,7 @@ class Config:
     cache_metrics: Optional[bool]
     collect_server_info: Optional[bool]
     connect_timeout: Optional[float]
+    disable_legacy_cluster_tag: Optional[bool]
     empty_default_hostname: Optional[bool]
     excluded_metrics: Optional[Sequence[str]]
     extra_headers: Optional[Mapping[str, Any]]

envoy/datadog_checks/envoy/data/conf.yaml.example

@@ -120,6 +120,12 @@ instances:
     #
     # collect_server_info: true
 
+    ## @param disable_legacy_cluster_tag - boolean - optional - default: false
+    ## Enable to stop submitting the tag `cluster_name` and `virtual_cluster_name`,
+    ## which has been renamed to `envoy_cluster` and `virtual_envoy_cluster`.
+    #
+    # disable_legacy_cluster_tag: true
+
     ## @param tags - list of strings - optional
     ## A list of tags to attach to every metric and service check emitted by this instance.
     ##

envoy/datadog_checks/envoy/envoy.py

@@ -51,6 +51,7 @@ def __init__(self, name, init_config, instances):
 
         self.caching_metrics = None
         self.parse_unknown_metrics = is_affirmative(self.instance.get('parse_unknown_metrics', False))
+        self.disable_legacy_cluster_tag = is_affirmative(self.instance.get('disable_legacy_cluster_tag', False))
 
     def check(self, _):
         self._collect_metadata()
@@ -88,7 +89,11 @@ def check(self, _):
                 continue
 
             try:
-                metric, tags, method = parse_metric(envoy_metric, retry=self.parse_unknown_metrics)
+                metric, tags, method = parse_metric(
+                    envoy_metric,
+                    retry=self.parse_unknown_metrics,
+                    disable_legacy_cluster_tag=self.disable_legacy_cluster_tag,
+                )
             except UnknownMetric:
                 if envoy_metric not in self.unknown_metrics:
                     self.log.debug('Unknown metric `%s`', envoy_metric)