Add full_server_name support as template variable to sqlserver template config key (#20342)

joelmarcotte · web-flow · commit d10b952ba1ba · 2025-05-23T12:28:05.000Z
* Add  support as template variable to sqlserver template config key

* changelog entry

* do not treat instancename as a snowflake for fallback

* updated config

* updated config

* fix unit test

* fix tests

* fix conf
diff --git a/sqlserver/assets/configuration/spec.yaml b/sqlserver/assets/configuration/spec.yaml
@@ -80,7 +80,7 @@ files:
       default: false
     - name: database_identifier
       description: |
-        Controls how the database is identified. The default value is the resolved hostname for the instance, 
+        Controls how the database is identified. The default value is the resolved hostname for the instance,
         which respects the `reported_hostname` option.
 
         This value will be used as-is for the display name of the instance but will be normalized
@@ -91,7 +91,7 @@ files:
           value:
             type: string
             display_default: "$resolved_hostname"
-            example: "$env-$resolved_hostname:$port"
+            example: "$env-$resolved_hostname-$full_server_name"
           description: |
             The template to use for the database identifier. The default value is `$resolved_hostname`.
             You can use the following variables, prefixed by `$` in the template:
@@ -103,6 +103,7 @@ files:
             - database: The connection database.
             - server_name: The resolved server name of the instance.
             - instance_name: The resolved instance name of the instance.
+            - full_server_name: The resolved full server name of the instance i.e. the value returned by `@@SERVERNAME`.
             In addition, you can use any key from the `tags` section of the configuration.
           default: "$resolved_hostname"
     - name: database_autodiscovery
@@ -173,9 +174,9 @@ files:
 
             Set `ao_metrics.enabled` to true to enable collection of AlwaysOn metrics. Defaults to false.
 
-            When `ao_metrics.enabled` is True, use `ao_metrics.availability_group` to specify the 
-            resource group id of a specific availability group that you would like to monitor. 
-            If no availability group is specified, then we will collect AlwaysOn metrics for all 
+            When `ao_metrics.enabled` is True, use `ao_metrics.availability_group` to specify the
+            resource group id of a specific availability group that you would like to monitor.
+            If no availability group is specified, then we will collect AlwaysOn metrics for all
             availability groups on the current replica.
 
             Primary replicas may emit metrics for remote secondary replicas
@@ -202,7 +203,7 @@ files:
 
             Set `db_backup_metrics.enabled` to true to enable collection of database backup metrics. Defaults to true.
 
-            Use `db_backup_metrics.collection_interval` to set the interval (in seconds) for the collection of 
+            Use `db_backup_metrics.collection_interval` to set the interval (in seconds) for the collection of
             database backup metrics. Defaults to 300 seconds (5 minutes). If you intend on updating this value,
             it is strongly recommended to use a consistent value throughout all SQL Server agent deployments.
           hidden: true
@@ -242,11 +243,11 @@ files:
               example: true
         - name: db_fragmentation_metrics
           description: |
-            Configure collection of database fragmentation metrics. 
-            Note these queries can be resource intensive on large datasets. Recommend to limit these via 
+            Configure collection of database fragmentation metrics.
+            Note these queries can be resource intensive on large datasets. Recommend to limit these via
             autodiscovery or specific database instances.
 
-            Set `db_fragmentation_metrics.enabled` to true to enable collection of 
+            Set `db_fragmentation_metrics.enabled` to true to enable collection of
             database index fragmentation statistics. Defaults to false.
 
             Use `db_fragmentation_metrics.enabled_tempdb` to enable collection of database index fragmentation statistics
@@ -343,7 +344,7 @@ files:
               type: boolean
               example: true
         - name: master_files_metrics
-          description: | 
+          description: |
             Configure collection of database file size and state from `sys.master_files`
 
             Set `master_files_metrics.enabled` to true to enable collection of database file size and state metrics.
@@ -356,7 +357,7 @@ files:
               example: false
         - name: primary_log_shipping_metrics
           description: |
-            Configure collection of metrics for a log shipping setup. Required to run against the 
+            Configure collection of metrics for a log shipping setup. Required to run against the
             primary instance in a transaction log shipping configuration. Note that
             the Datadog user needs to be present in msdb and must be added to the db_datareader role.
 
@@ -370,7 +371,7 @@ files:
               example: false
         - name: secondary_log_shipping_metrics
           description: |
-            Configure collection of metrics for a log shipping setup. Required to run against the 
+            Configure collection of metrics for a log shipping setup. Required to run against the
             secondary instance in a transaction log shipping configuration. Note that
             the Datadog user needs to be present in msdb and must be added to the db_datareader role.
 
@@ -410,7 +411,7 @@ files:
           description: |
             Configure collection of tempdb file space usage metrics for how space is used in tempdb data files.
 
-            Set `tempdb_file_space_usage_metrics.enabled` to true to enable collection of 
+            Set `tempdb_file_space_usage_metrics.enabled` to true to enable collection of
             tempdb file space usage metrics. Defaults to true.
           value:
             type: object
@@ -420,7 +421,7 @@ files:
               example: true
         - name: xe_metrics
           description: |
-            Configure collection of extended events (XE) metrics. 
+            Configure collection of extended events (XE) metrics.
 
             Set `xe_metrics.enabled` to true to enable collection of extended events metrics. Defaults to false.
           value:
@@ -889,12 +890,12 @@ files:
     - name: collect_raw_query_statement
       description: |
         Configure the collection of raw query statements in query activity, execution plans, and XE events.
-        To collect raw query statements from XE events, set `xe_collection.query_completions.enabled` and 
+        To collect raw query statements from XE events, set `xe_collection.query_completions.enabled` and
         `xe_collection.query_errors.enabled` to `true`.
         Raw query statements and execution plans may contain sensitive information (e.g., passwords)
         or personally identifiable information in query text.
-        Enabling this option will allow the collection and ingestion of raw query statements and 
-        execution plans into Datadog, which can then become viewable in query samples or explain plans. 
+        Enabling this option will allow the collection and ingestion of raw query statements and
+        execution plans into Datadog, which can then become viewable in query samples or explain plans.
         This option is disabled by default.
         Note: Collection of raw query statements is currently in preview.
         If you are interested in participating, please reach out to your Datadog Customer Success Manager.
@@ -1022,13 +1023,13 @@ files:
             Configure the collection of completed queries from the `datadog_query_completions` XE session.
 
             Set `query_completions.enabled` to `true` to enable the collection of query completion events.
-            
-            Use `query_completions.collection_interval` to set the interval (in seconds) for the collection of 
+
+            Use `query_completions.collection_interval` to set the interval (in seconds) for the collection of
             query completion events. Defaults to 10 seconds. If you intend on updating this value,
             it is strongly recommended to use a consistent value throughout all SQL Server agent deployments.
-            
-            Use `query_completions.max_events` to set the maximum number of query completion events to process 
-            per collection. Note that SQL Server's ring buffer has a maximum of 1000 events per query, 
+
+            Use `query_completions.max_events` to set the maximum number of query completion events to process
+            per collection. Note that SQL Server's ring buffer has a maximum of 1000 events per query,
             so values above 1000 will still be capped at 1000 by the database engine. Defaults to 1000.
           value:
             type: object
@@ -1049,13 +1050,13 @@ files:
             Configure the collection of query errors from the `datadog_query_errors` XE session.
 
             Set `query_errors.enabled` to `true` to enable the collection of query error events.
-            
-            Use `query_errors.collection_interval` to set the interval (in seconds) for the collection of 
+
+            Use `query_errors.collection_interval` to set the interval (in seconds) for the collection of
             query error events. Defaults to 10 seconds. If you intend on updating this value,
             it is strongly recommended to use a consistent value throughout all SQL Server agent deployments.
-            
-            Use `query_errors.max_events` to set the maximum number of query error events to process 
-            per collection. Note that SQL Server's ring buffer has a maximum of 1000 events per query, 
+
+            Use `query_errors.max_events` to set the maximum number of query error events to process
+            per collection. Note that SQL Server's ring buffer has a maximum of 1000 events per query,
             so values above 1000 will still be capped at 1000 by the database engine. Defaults to 1000.
           value:
             type: object
diff --git a/sqlserver/changelog.d/20342.added b/sqlserver/changelog.d/20342.added
@@ -0,0 +1 @@
+Add $full_server_name support as template variable to sqlserver template config key
diff --git a/sqlserver/datadog_checks/sqlserver/const.py b/sqlserver/datadog_checks/sqlserver/const.py
@@ -24,6 +24,7 @@
 # Keys of the static info cache, used to cache server info which does not change
 STATIC_INFO_SERVERNAME = 'servername'
 STATIC_INFO_INSTANCENAME = 'instancename'
+STATIC_INFO_FULL_SERVERNAME = 'full_servername'
 STATIC_INFO_VERSION = 'version'
 STATIC_INFO_MAJOR_VERSION = 'major_version'
 STATIC_INFO_ENGINE_EDITION = 'engine_edition'
diff --git a/sqlserver/datadog_checks/sqlserver/data/conf.yaml.example b/sqlserver/datadog_checks/sqlserver/data/conf.yaml.example
@@ -85,7 +85,7 @@ instances:
     #
     # exclude_hostname: false
 
-    ## Controls how the database is identified. The default value is the resolved hostname for the instance, 
+    ## Controls how the database is identified. The default value is the resolved hostname for the instance,
     ## which respects the `reported_hostname` option.
     ##
     ## This value will be used as-is for the display name of the instance but will be normalized
@@ -105,9 +105,10 @@ instances:
         ## - database: The connection database.
         ## - server_name: The resolved server name of the instance.
         ## - instance_name: The resolved instance name of the instance.
+        ## - full_server_name: The resolved full server name of the instance i.e. the value returned by `@@SERVERNAME`.
         ## In addition, you can use any key from the `tags` section of the configuration.
         #
-        # template: $env-$resolved_hostname:$port
+        # template: $env-$resolved_hostname-$full_server_name
 
     ## @param database_autodiscovery - boolean - optional - default: false
     ## Auto-discover and monitor databases. Supported for the metrics check.
@@ -165,9 +166,9 @@ instances:
         ##
         ## Set `ao_metrics.enabled` to true to enable collection of AlwaysOn metrics. Defaults to false.
         ##
-        ## When `ao_metrics.enabled` is True, use `ao_metrics.availability_group` to specify the 
-        ## resource group id of a specific availability group that you would like to monitor. 
-        ## If no availability group is specified, then we will collect AlwaysOn metrics for all 
+        ## When `ao_metrics.enabled` is True, use `ao_metrics.availability_group` to specify the
+        ## resource group id of a specific availability group that you would like to monitor.
+        ## If no availability group is specified, then we will collect AlwaysOn metrics for all
         ## availability groups on the current replica.
         ##
         ## Primary replicas may emit metrics for remote secondary replicas
@@ -179,11 +180,11 @@ instances:
         # ao_metrics: {}
 
         ## @param db_fragmentation_metrics - mapping - optional
-        ## Configure collection of database fragmentation metrics. 
-        ## Note these queries can be resource intensive on large datasets. Recommend to limit these via 
+        ## Configure collection of database fragmentation metrics.
+        ## Note these queries can be resource intensive on large datasets. Recommend to limit these via
         ## autodiscovery or specific database instances.
         ##
-        ## Set `db_fragmentation_metrics.enabled` to true to enable collection of 
+        ## Set `db_fragmentation_metrics.enabled` to true to enable collection of
         ## database index fragmentation statistics. Defaults to false.
         ##
         ## Use `db_fragmentation_metrics.enabled_tempdb` to enable collection of database index fragmentation statistics
@@ -247,7 +248,7 @@ instances:
         # master_files_metrics: {}
 
         ## @param primary_log_shipping_metrics - mapping - optional
-        ## Configure collection of metrics for a log shipping setup. Required to run against the 
+        ## Configure collection of metrics for a log shipping setup. Required to run against the
         ## primary instance in a transaction log shipping configuration. Note that
         ## the Datadog user needs to be present in msdb and must be added to the db_datareader role.
         ##
@@ -257,7 +258,7 @@ instances:
         # primary_log_shipping_metrics: {}
 
         ## @param secondary_log_shipping_metrics - mapping - optional
-        ## Configure collection of metrics for a log shipping setup. Required to run against the 
+        ## Configure collection of metrics for a log shipping setup. Required to run against the
         ## secondary instance in a transaction log shipping configuration. Note that
         ## the Datadog user needs to be present in msdb and must be added to the db_datareader role.
         ##
@@ -277,13 +278,13 @@ instances:
         ## @param tempdb_file_space_usage_metrics - mapping - optional
         ## Configure collection of tempdb file space usage metrics for how space is used in tempdb data files.
         ##
-        ## Set `tempdb_file_space_usage_metrics.enabled` to true to enable collection of 
+        ## Set `tempdb_file_space_usage_metrics.enabled` to true to enable collection of
         ## tempdb file space usage metrics. Defaults to true.
         #
         # tempdb_file_space_usage_metrics: {}
 
         ## @param xe_metrics - mapping - optional
-        ## Configure collection of extended events (XE) metrics. 
+        ## Configure collection of extended events (XE) metrics.
         ##
         ## Set `xe_metrics.enabled` to true to enable collection of extended events metrics. Defaults to false.
         #
@@ -647,12 +648,12 @@ instances:
         # keep_identifier_quotation: false
 
     ## Configure the collection of raw query statements in query activity, execution plans, and XE events.
-    ## To collect raw query statements from XE events, set `xe_collection.query_completions.enabled` and 
+    ## To collect raw query statements from XE events, set `xe_collection.query_completions.enabled` and
     ## `xe_collection.query_errors.enabled` to `true`.
     ## Raw query statements and execution plans may contain sensitive information (e.g., passwords)
     ## or personally identifiable information in query text.
-    ## Enabling this option will allow the collection and ingestion of raw query statements and 
-    ## execution plans into Datadog, which can then become viewable in query samples or explain plans. 
+    ## Enabling this option will allow the collection and ingestion of raw query statements and
+    ## execution plans into Datadog, which can then become viewable in query samples or explain plans.
     ## This option is disabled by default.
     ## Note: Collection of raw query statements is currently in preview.
     ## If you are interested in participating, please reach out to your Datadog Customer Success Manager.
@@ -813,12 +814,12 @@ instances:
         ##
         ## Set `query_completions.enabled` to `true` to enable the collection of query completion events.
         ##
-        ## Use `query_completions.collection_interval` to set the interval (in seconds) for the collection of 
+        ## Use `query_completions.collection_interval` to set the interval (in seconds) for the collection of
         ## query completion events. Defaults to 10 seconds. If you intend on updating this value,
         ## it is strongly recommended to use a consistent value throughout all SQL Server agent deployments.
         ##
-        ## Use `query_completions.max_events` to set the maximum number of query completion events to process 
-        ## per collection. Note that SQL Server's ring buffer has a maximum of 1000 events per query, 
+        ## Use `query_completions.max_events` to set the maximum number of query completion events to process
+        ## per collection. Note that SQL Server's ring buffer has a maximum of 1000 events per query,
         ## so values above 1000 will still be capped at 1000 by the database engine. Defaults to 1000.
         #
         # query_completions: {}
@@ -828,12 +829,12 @@ instances:
         ##
         ## Set `query_errors.enabled` to `true` to enable the collection of query error events.
         ##
-        ## Use `query_errors.collection_interval` to set the interval (in seconds) for the collection of 
+        ## Use `query_errors.collection_interval` to set the interval (in seconds) for the collection of
         ## query error events. Defaults to 10 seconds. If you intend on updating this value,
         ## it is strongly recommended to use a consistent value throughout all SQL Server agent deployments.
         ##
-        ## Use `query_errors.max_events` to set the maximum number of query error events to process 
-        ## per collection. Note that SQL Server's ring buffer has a maximum of 1000 events per query, 
+        ## Use `query_errors.max_events` to set the maximum number of query error events to process
+        ## per collection. Note that SQL Server's ring buffer has a maximum of 1000 events per query,
         ## so values above 1000 will still be capped at 1000 by the database engine. Defaults to 1000.
         #
         # query_errors: {}
diff --git a/sqlserver/datadog_checks/sqlserver/sqlserver.py b/sqlserver/datadog_checks/sqlserver/sqlserver.py
@@ -83,6 +83,7 @@
     PERF_RAW_LARGE_FRACTION,
     SERVICE_CHECK_NAME,
     STATIC_INFO_ENGINE_EDITION,
+    STATIC_INFO_FULL_SERVERNAME,
     STATIC_INFO_INSTANCENAME,
     STATIC_INFO_MAJOR_VERSION,
     STATIC_INFO_RDS,
@@ -340,6 +341,8 @@ def database_identifier(self):
                 tag_dict['server_name'] = self.static_info_cache.get(STATIC_INFO_SERVERNAME)
             if self.static_info_cache.get(STATIC_INFO_INSTANCENAME) is not None:
                 tag_dict['instance_name'] = self.static_info_cache.get(STATIC_INFO_INSTANCENAME)
+            if self.static_info_cache.get(STATIC_INFO_FULL_SERVERNAME) is not None:
+                tag_dict['full_server_name'] = self.static_info_cache.get(STATIC_INFO_FULL_SERVERNAME)
             self._database_identifier = template.safe_substitute(**tag_dict)
         return self._database_identifier
 
@@ -394,6 +397,7 @@ def load_static_information(self):
                             )
                             self.static_info_cache[STATIC_INFO_SERVERNAME] = servername
                             self.static_info_cache[STATIC_INFO_INSTANCENAME] = instancename
+                            self.static_info_cache[STATIC_INFO_FULL_SERVERNAME] = full_servername
 
                             self.tags.append("sqlserver_servername:{}".format(servername))
                             self.non_internal_tags.append("sqlserver_servername:{}".format(servername))
diff --git a/sqlserver/tests/test_integration.py b/sqlserver/tests/test_integration.py
diff --git a/sqlserver/tests/test_unit.py b/sqlserver/tests/test_unit.py

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Add $full_server_name support as template variable to sqlserver template config key`