Create exclude_hostname option (#20094)

* exclude_hostname

* Changelog

* Sync

Author: sethsamuel

mysql/changelog.d/20094.added

@@ -0,0 +1 @@
+Create exclude_hostname option for Postgres, MySQL, and SQLServer

mysql/datadog_checks/mysql/config.py

@@ -13,7 +13,7 @@ class MySQLConfig(object):
     def __init__(self, instance, init_config):
         self.log = get_check_logger()
         self.database_identifier = instance.get('database_identifier', {})
-        self.empty_default_hostname = instance.get("empty_default_hostname", False)
+        self.exclude_hostname = instance.get("exclude_hostname", False)
         self.host = instance.get('host', instance.get('server', ''))
         self.port = int(instance.get('port', 0))
         self.reported_hostname = instance.get('reported_hostname', '')

mysql/datadog_checks/mysql/mysql.py

@@ -163,7 +163,7 @@ def _send_metadata(self):
     @property
     def reported_hostname(self):
         # type: () -> str
-        if self._config.empty_default_hostname:
+        if self._config.exclude_hostname:
             return None
         return self.resolved_hostname
 

postgres/changelog.d/20094.added

@@ -0,0 +1 @@
+Create exclude_hostname option for Postgres, MySQL, and SQLServer

postgres/datadog_checks/postgres/config.py

@@ -29,7 +29,7 @@ class PostgresConfig:
     MONOTONIC = AgentCheck.monotonic_count
 
     def __init__(self, instance, init_config, check):
-        self.empty_default_hostname = instance.get("empty_default_hostname", False)
+        self.exclude_hostname = instance.get("exclude_hostname", False)
         self.database_identifier = instance.get('database_identifier', {})
         self.init_config = init_config
         self.host = instance.get('host', '')

postgres/datadog_checks/postgres/postgres.py

@@ -476,7 +476,7 @@ def initialize_is_aurora(self):
     @property
     def reported_hostname(self):
         # type: () -> str
-        if self._config.empty_default_hostname:
+        if self._config.exclude_hostname:
             return None
         return self.resolved_hostname
 

sqlserver/assets/configuration/spec.yaml

@@ -71,6 +71,13 @@ files:
         and can be useful to set a custom hostname when connecting to a remote database through a proxy.
       value:
         type: string
+    - name: exclude_hostname
+      description: |
+        Omit the hostname from tags and events. This is useful when the database host is not monitored by an agent.
+      value:
+        type: boolean
+        example: false
+      default: false
     - name: database_identifier
       description: |
         Controls how the database is identified. The default value is the resolved hostname for the instance, 

sqlserver/changelog.d/20094.added

@@ -0,0 +1 @@
+Create exclude_hostname option for Postgres, MySQL, and SQLServer

sqlserver/datadog_checks/sqlserver/config.py

@@ -24,7 +24,7 @@ def __init__(self, init_config, instance, log):
             propagate_agent_tags=self._should_propagate_agent_tags(instance, init_config),
             additional_tags=[],
         )
-        self.empty_default_hostname = instance.get("empty_default_hostname", False)
+        self.exclude_hostname = instance.get("exclude_hostname", False)
         self.reported_hostname: str = instance.get('reported_hostname')
         self.autodiscovery: bool = is_affirmative(instance.get('database_autodiscovery'))
         self.autodiscovery_include: list[str] = instance.get('autodiscovery_include', ['.*']) or ['.*']

sqlserver/datadog_checks/sqlserver/config_models/defaults.py

@@ -60,6 +60,10 @@ def instance_empty_default_hostname():
     return False
 
 
+def instance_exclude_hostname():
+    return False
+
+
 def instance_ignore_missing_database():
     return False
 

sqlserver/datadog_checks/sqlserver/config_models/instance.py

@@ -379,6 +379,7 @@ class InstanceConfig(BaseModel):
     driver: Optional[str] = None
     dsn: Optional[str] = None
     empty_default_hostname: Optional[bool] = None
+    exclude_hostname: Optional[bool] = None
     gcp: Optional[Gcp] = None
     host: str
     ignore_missing_database: Optional[bool] = None

sqlserver/datadog_checks/sqlserver/data/conf.yaml.example

@@ -80,6 +80,11 @@ instances:
     #
     # reported_hostname: <REPORTED_HOSTNAME>
 
+    ## @param exclude_hostname - boolean - optional - default: false
+    ## Omit the hostname from tags and events. This is useful when the database host is not monitored by an agent.
+    #
+    # exclude_hostname: false
+
     ## Controls how the database is identified. The default value is the resolved hostname for the instance, 
     ## which respects the `reported_hostname` option.
     ##

sqlserver/datadog_checks/sqlserver/sqlserver.py

@@ -276,7 +276,7 @@ def resolve_db_host(self):
     @property
     def reported_hostname(self):
         # type: () -> str
-        if self._config.empty_default_hostname:
+        if self._config.exclude_hostname:
             return None
         return self.resolved_hostname