Sy/elastic sc tags

elastic/assets/configuration/spec.yaml

@@ -105,6 +105,15 @@ files:
         example: false
     - name: disable_legacy_cluster_tag
       description: Enable to stop submitting the tag `cluster_name`, which has been renamed to `elastic_cluster`.
+      value:
+        type: boolean
+        display_default: false
+        example: true
+      enabled: false
+    - name: disable_legacy_service_check_tags
+      description: |
+        Disable the submission of the elasticsearch `host` and `port` as tags in service checks. 
+        Submit them as `url` instead.
       value:
         type: boolean
         display_default: false

elastic/changelog.d/18687.added

@@ -0,0 +1 @@
+Add functionality to not use `host` and `port` tags in service checks

elastic/datadog_checks/elastic/config.py

@@ -58,7 +58,10 @@ def from_instance(instance):
     host = parsed.hostname
 
     custom_tags = instance.get('tags', [])
-    service_check_tags = ['host:{}'.format(host), 'port:{}'.format(port)]
+    if is_affirmative(instance.get('disable_legacy_service_check_tags', False)):
+        service_check_tags = ['url:{}'.format(url)]
+    else:
+        service_check_tags = ['host:{}'.format(host), 'port:{}'.format(port)]
     service_check_tags.extend(custom_tags)
 
     custom_queries = instance.get('custom_queries', [])

elastic/datadog_checks/elastic/config_models/defaults.py

@@ -48,6 +48,10 @@ def instance_disable_legacy_cluster_tag():
     return False
 
 
+def instance_disable_legacy_service_check_tags():
+    return False
+
+
 def instance_empty_default_hostname():
     return False
 

elastic/datadog_checks/elastic/config_models/instance.py

@@ -90,6 +90,7 @@ class InstanceConfig(BaseModel):
     detailed_index_stats: Optional[bool] = None
     disable_generic_tags: Optional[bool] = None
     disable_legacy_cluster_tag: Optional[bool] = None
+    disable_legacy_service_check_tags: Optional[bool] = None
     empty_default_hostname: Optional[bool] = None
     extra_headers: Optional[MappingProxyType[str, Any]] = None
     gc_collectors_as_rate: Optional[bool] = None

elastic/datadog_checks/elastic/data/conf.yaml.example

@@ -132,7 +132,13 @@ instances:
     ## @param disable_legacy_cluster_tag - boolean - optional - default: false
     ## Enable to stop submitting the tag `cluster_name`, which has been renamed to `elastic_cluster`.
     #
-    disable_legacy_cluster_tag: true
+    # disable_legacy_cluster_tag: true
+
+    ## @param disable_legacy_service_check_tags - boolean - optional - default: false
+    ## Disable the submission of the elasticsearch `host` and `port` as tags in service checks. 
+    ## Submit them as `url` instead.
+    #
+    disable_legacy_service_check_tags: true
 
     ## @param custom_queries - list of mappings - optional
     ## Run custom queries for Elasticsearch. Each custom query endpoint can collect multiple metrics and tags.

elastic/tests/test_unit.py

@@ -7,7 +7,7 @@
 import mock
 import pytest
 
-from datadog_checks.base import ConfigurationError
+from datadog_checks.base import ConfigurationError, is_affirmative
 from datadog_checks.dev.http import MockResponse
 from datadog_checks.elastic import ESCheck
 from datadog_checks.elastic.elastic import AuthenticationError, get_value_from_path
@@ -178,6 +178,42 @@ def test__get_data_creates_critical_service_alert(aggregator, instance):
         )
 
 
+@pytest.mark.parametrize(
+    'es_instance',
+    [
+        pytest.param(
+            {'url': 'http://localhost:9200', 'disable_legacy_service_check_tags': 'true'},
+            id="disable legacy service check behavior",
+        ),
+        pytest.param(
+            {'url': 'http://localhost:9200', 'disable_legacy_service_check_tags': 'false'},
+            id="use legacy service check behavior",
+        ),
+    ],
+)
+def test_disable_legacy_sc_tags(aggregator, es_instance):
+    with mock.patch(
+        'requests.get',
+        return_value=MockResponse(status_code=500),
+    ):
+        check = ESCheck('elastic', {}, instances=[es_instance])
+
+        with pytest.raises(Exception):
+            check._get_data(url='test.com')
+
+        if is_affirmative(es_instance['disable_legacy_service_check_tags']):
+            expected_tags = ['url:http://localhost:9200']
+        else:
+            expected_tags = ['host:localhost', 'port:9200']
+
+        aggregator.assert_service_check(
+            check.SERVICE_CHECK_CONNECT_NAME,
+            status=check.CRITICAL,
+            tags=expected_tags,
+            message="Error 500 Server Error: None for url: None when hitting test.com",
+        )
+
+
 @pytest.mark.parametrize(
     'version, return_value',
     [