Add SQL Server database metric user_access (DataDog#21406)

* test_sqlserver_database_stats_metrics

* test_check_docker

* test_database_state

* Add relnote

* Lint

* Validate metadata

* Remove user_access_desc tag from database metrics

* Remove multi user

Author: nenadnoveljic

sqlserver/changelog.d/21406.added

@@ -0,0 +1 @@
+Add SQL Server database metric `user_access`.

sqlserver/datadog_checks/sqlserver/const.py

@@ -212,6 +212,7 @@
     ('sqlserver.database.files.state', 'sys.database_files', 'state'),
 ]
 DATABASE_STATS_METRICS = [
+    ('sqlserver.database.user_access', 'sys.databases', 'user_access'),
     ('sqlserver.database.state', 'sys.databases', 'state'),
     ('sqlserver.database.is_sync_with_backup', 'sys.databases', 'is_sync_with_backup'),
     ('sqlserver.database.is_in_standby', 'sys.databases', 'is_in_standby'),

sqlserver/datadog_checks/sqlserver/database_metrics/database_stats_metrics.py

@@ -12,6 +12,7 @@
         name as database_name,
         state_desc,
         recovery_model_desc,
+        user_access,
         state,
         is_sync_with_backup,
         is_in_standby,
@@ -23,6 +24,7 @@
         {"name": "database", "type": "tag"},
         {"name": "database_state_desc", "type": "tag"},
         {"name": "database_recovery_model_desc", "type": "tag"},
+        {"name": "database.user_access", "type": "gauge"},
         {"name": "database.state", "type": "gauge"},
         {"name": "database.is_sync_with_backup", "type": "gauge"},
         {"name": "database.is_in_standby", "type": "gauge"},

sqlserver/metadata.csv

@@ -56,6 +56,7 @@ sqlserver.database.master_files.state,gauge,,,,"Database file state: 0 = Online,
 sqlserver.database.replica.transaction_delay,gauge,,millisecond,,"Total delay in waiting for unterminated commit acknowledgment for all the current transactions, in milliseconds. Tags: `db`. (Perf. Counter: `Database Replica - Transaction Delay`)",0,sql_server,transaction delay,,
 sqlserver.database.state,gauge,,,,"Database state: 0 = Online, 1 = Restoring, 2 = Recovering, 3 = Recovery_Pending, 4 = Suspect, 5 = Emergency, 6 = Offline, 7 = Copying, 10 = Offline_Secondary. Tags: `db`, `database_state_desc`, `database_recovery_model_desc`",0,sql_server,database state,,
 sqlserver.database.transactions,gauge,,transaction,,Number of transactions started for the SQL Server instance per second. Tags: `db`. (Perf. Counter: `Databases - Transactions/sec`),0,sql_server,database trans,,
+sqlserver.database.user_access,gauge,,,,"Database user access: 0 = Multi_user, 1 = Single_user, 2 = Restricted_user. Tags: `db`, `database_state_desc`, `database_recovery_model_desc`",0,sql_server,database state,,
 sqlserver.database.write_transactions,gauge,,transaction,,"Number of transactions that wrote to all databases on the SQL Server instance and committed, in the last second. Tags: `db`. (Perf. Counter: `Databases - Write Transactions/sec`)",0,sql_server,database trans write,,
 sqlserver.fci.is_current_owner,gauge,,,,"Whether or not this node is the current owner of the SQL Server FCI. Tags: `node_name`, `status`, `failover_cluster`",0,sql_server,fci current owner,,
 sqlserver.fci.status,gauge,,,,"Status of the node in a SQL Server failover cluster instance. Tags: `node_name`, `status`, `failover_cluster`",0,sql_server,fci status,,

sqlserver/tests/test_database_metrics.py

@@ -1477,11 +1477,11 @@ def test_sqlserver_database_stats_metrics(
     }
 
     mocked_results = [
-        ('master', 'master', 'ONLINE', 'SIMPLE', 0, False, False, False),
-        ('tempdb', 'tempdb', 'ONLINE', 'SIMPLE', 0, False, False, False),
-        ('model', 'model', 'ONLINE', 'FULL', 0, False, False, False),
-        ('msdb', 'msdb', 'ONLINE', 'SIMPLE', 0, False, False, False),
-        ('datadog_test', 'datadog_test', 'ONLINE', 'FULL', 0, False, False, False),
+        ('master', 'master', 'ONLINE', 'SIMPLE', 0, 0, False, False, False),
+        ('tempdb', 'tempdb', 'ONLINE', 'SIMPLE', 0, 0, False, False, False),
+        ('model', 'model', 'ONLINE', 'FULL', 0, 0, False, False, False),
+        ('msdb', 'msdb', 'ONLINE', 'SIMPLE', 0, 0, False, False, False),
+        ('datadog_test', 'datadog_test', 'ONLINE', 'FULL', 0, 0, False, False, False),
     ]
 
     sqlserver_check = SQLServer(CHECK_NAME, init_config, [instance_docker_metrics])
@@ -1511,7 +1511,13 @@ def execute_query_handler_mocked(query, db=None):
             "sqlserver_servername:{}".format(sqlserver_check.static_info_cache.get(STATIC_INFO_SERVERNAME)),
         ]
         for result in mocked_results:
-            db, database, database_state_desc, database_recovery_model_desc, *metric_values = result
+            (
+                db,
+                database,
+                database_state_desc,
+                database_recovery_model_desc,
+                *metric_values,
+            ) = result
             metrics = zip(database_stats_metrics.metric_names()[0], metric_values)
             expected_tags = [
                 f'db:{db}',