Add improved support for Azure SQL Database (#6111)

plugins/inputs/sqlserver/README.md

@@ -18,9 +18,21 @@ GRANT VIEW ANY DEFINITION TO [telegraf];
 GO
 ```
 
+For Azure SQL Database, you require the View Database State permission and can create a user with a password directly in the database.
+```sql
+CREATE USER [telegraf] WITH PASSWORD = N'mystrongpassword';
+GO
+GRANT VIEW DATABASE STATE TO [telegraf];
+GO
+```
+
 ### Configuration:
 
 ```toml
+[agent]
+  ## Default data collection interval for all inputs, can be changed as per collection interval needs
+  interval = "10s"
+
 # Read metrics from Microsoft SQL Server
 [[inputs.sqlserver]]
   ## Specify instances to monitor with a list of connection strings.
@@ -35,7 +47,7 @@ GO
 
   ## Optional parameter, setting this to 2 will use a new version
   ## of the collection queries that break compatibility with the original
-  ## dashboards.
+  ## dashboards. All new functionality is under V2
   query_version = 2
 
   ## If you are using AzureDB, setting this to true will gather resource utilization metrics
@@ -52,7 +64,10 @@ GO
   ## - DatabaseStats
   ## - MemoryClerk
   ## - VolumeSpace
-  exclude_query = [ 'DatabaseIO' ]
+  ## - Schedulers
+  ## - AzureDBResourceStats
+  ## - AzureDBResourceGovernance 
+  exclude_query = [ 'Schedulers' ]
 ```
 
 ### Metrics:
@@ -79,7 +94,6 @@ If you are using the original queries all stats have the following tags:
 
 #### Version 2:
 The new (version 2) metrics provide:
-- *AzureDB*: AzureDB resource utilization from `sys.dm_db_resource_stats`
 - *Database IO*: IO stats from `sys.dm_io_virtual_file_stats`
 - *Memory Clerk*: Memory clerk breakdown from `sys.dm_os_memory_clerks`, most clerks have been given a friendly name.
 - *Performance Counters*: A select list of performance counters from `sys.dm_os_performance_counters`. Some of the important metrics included:
@@ -89,8 +103,9 @@ The new (version 2) metrics provide:
   - *Memory*: PLE, Page reads/sec, Page writes/sec, + more
   - *TempDB*: Free space, Version store usage, Active temp tables, temp table creation rate, + more
   - *Resource Governor*: CPU Usage, Requests/sec, Queued Requests, and Blocked tasks per workload group + more
-- *Server properties*: Number of databases in all possible states (online, offline, suspect, etc.), cpu count, physical memory, SQL Server service uptime, and SQL Server version
+- *Server properties*: Number of databases in all possible states (online, offline, suspect, etc.), cpu count, physical memory, SQL Server service uptime, and SQL Server version. In the case of Azure SQL relevent properties such as Tier, #Vcores, Memory etc.
 - *Wait stats*: Wait time in ms, number of waiting tasks, resource wait time, signal wait time, max wait time in ms, wait type, and wait category. The waits are categorized using the same categories used in Query Store.
+- *Schedulers* - This captures sys.dm_os_schedulers.
 - *Azure Managed Instances*
   - Stats from `sys.server_resource_stats`:
     - cpu_count
@@ -101,6 +116,11 @@ The new (version 2) metrics provide:
     - total_storage_mb
     - available_storage_mb
     - uptime
+  - Resource governance stats from sys.dm_instance_resource_governance
+- *Azure SQL Database*
+  - Stats from sys.dm_db_wait_stats
+  - Resource governance stats from sys.dm_user_db_resource_governance
+  - Stats from sys.dm_db_resource_stats
 
 The following metrics can be used directly, with no delta calculations:
  - SQLServer:Buffer Manager\Buffer cache hit ratio
@@ -140,3 +160,4 @@ The following metrics can be used directly, with no delta calculations:
 
 Version 2 queries have the following tags:
 - `sql_instance`: Physical host and instance name (hostname:instance)
+- database_name:  For Azure SQLDB, database_name denotes the name of the Azure SQL Database as server name is a logical construct.

plugins/inputs/sqlserver/sqlserver.go

@@ -66,7 +66,10 @@ var sampleConfig = `
   ## - MemoryClerk
   ## - VolumeSpace
   ## - PerformanceMetrics
-  # exclude_query = [ 'DatabaseIO' ]
+  ## - Schedulers
+  ## - AzureDBResourceStats
+  ## - AzureDBResourceGovernance
+  exclude_query = [ 'Schedulers' ]
 `
 
 // SampleConfig return the sample configuration
@@ -88,7 +91,8 @@ func initQueries(s *SQLServer) {
 
 	// If this is an AzureDB instance, grab some extra metrics
 	if s.AzureDB {
-		queries["AzureDB"] = Query{Script: sqlAzureDB, ResultByRow: false}
+		queries["AzureDBResourceStats"] = Query{Script: sqlAzureDBResourceStats, ResultByRow: false}
+		queries["AzureDBResourceGovernance"] = Query{Script: sqlAzureDBResourceGovernance, ResultByRow: false}
 	}
 
 	// Decide if we want to run version 1 or version 2 queries
@@ -98,6 +102,7 @@ func initQueries(s *SQLServer) {
 		queries["DatabaseIO"] = Query{Script: sqlDatabaseIOV2, ResultByRow: false}
 		queries["ServerProperties"] = Query{Script: sqlServerPropertiesV2, ResultByRow: false}
 		queries["MemoryClerk"] = Query{Script: sqlMemoryClerkV2, ResultByRow: false}
+		queries["Schedulers"] = Query{Script: sqlServerSchedulersV2, ResultByRow: false}
 	} else {
 		queries["PerformanceCounters"] = Query{Script: sqlPerformanceCounters, ResultByRow: true}
 		queries["WaitStatsCategorized"] = Query{Script: sqlWaitStatsCategorized, ResultByRow: false}
@@ -240,6 +245,7 @@ const sqlMemoryClerkV2 = `SET DEADLOCK_PRIORITY -10;
 DECLARE @SQL NVARCHAR(MAX) = 'SELECT
 "sqlserver_memory_clerks" As [measurement],
 REPLACE(@@SERVERNAME,"\",":") AS [sql_instance],
+DB_NAME() as [database_name],
 ISNULL(clerk_names.name,mc.type) AS clerk_type,
 SUM({pages_kb}) AS size_kb
 FROM
@@ -341,6 +347,8 @@ ELSE
 EXEC(@SQL)
 `
 
+// Conditional check based on Azure SQL DB OR On-prem SQL Server
+// EngineEdition=5 is Azure SQL DB
 const sqlDatabaseIOV2 = `SET DEADLOCK_PRIORITY -10;
 IF SERVERPROPERTY('EngineEdition') = 5
 BEGIN
@@ -382,6 +390,9 @@ inner join sys.master_files b on b.database_id = vfs.database_id and b.file_id =
 END
 `
 
+// Conditional check based on Azure SQL DB, Azure SQL Managed instance OR On-prem SQL Server
+// EngineEdition=5 is Azure SQL DB, EngineEdition=8 is Managed instance
+
 const sqlServerPropertiesV2 = `SET DEADLOCK_PRIORITY -10;
 DECLARE @sys_info TABLE (
 	cpu_count INT,
@@ -394,41 +405,54 @@ DECLARE @sys_info TABLE (
 	uptime INT
 )
 
-IF OBJECT_ID('master.sys.dm_os_sys_info') IS NOT NULL
+IF SERVERPROPERTY('EngineEdition') = 8  -- Managed Instance
-BEGIN
+ 	INSERT INTO @sys_info ( cpu_count, server_memory, sku, engine_edition, hardware_type, total_storage_mb, available_storage_mb, uptime )
-	IF SERVERPROPERTY('EngineEdition') = 8  -- Managed Instance
+	SELECT 	TOP(1)
-		INSERT INTO @sys_info ( cpu_count, server_memory, sku, engine_edition, hardware_type, total_storage_mb, available_storage_mb, uptime )
+			virtual_core_count AS cpu_count,
-		SELECT 	TOP(1)
+			(SELECT process_memory_limit_mb FROM sys.dm_os_job_object) AS server_memory,
-				virtual_core_count AS cpu_count,
+			sku,
-				(SELECT process_memory_limit_mb FROM sys.dm_os_job_object) AS server_memory,
+			cast(SERVERPROPERTY('EngineEdition') as smallint) AS engine_edition,
-				sku,
+			hardware_generation AS hardware_type,
-				cast(SERVERPROPERTY('EngineEdition') as smallint) AS engine_edition,
+			reserved_storage_mb AS total_storage_mb,
-				hardware_generation AS hardware_type,
+			(reserved_storage_mb - storage_space_used_mb) AS available_storage_mb,
-				reserved_storage_mb AS total_storage_mb,
+			(select DATEDIFF(MINUTE,sqlserver_start_time,GETDATE()) from sys.dm_os_sys_info) as uptime
-				(reserved_storage_mb - storage_space_used_mb) AS available_storage_mb,
+	FROM	sys.server_resource_stats
-				(select DATEDIFF(MINUTE,sqlserver_start_time,GETDATE()) from sys.dm_os_sys_info) as uptime
+	ORDER BY start_time DESC
-		FROM	sys.server_resource_stats
-		ORDER BY start_time DESC
 
-	ELSE
+IF SERVERPROPERTY('EngineEdition') = 5  -- Azure SQL DB
-	BEGIN
+	INSERT INTO @sys_info ( cpu_count, server_memory, sku, engine_edition, hardware_type, total_storage_mb, available_storage_mb, uptime )
-		INSERT INTO @sys_info ( cpu_count, server_memory, sku, engine_edition, hardware_type, total_storage_mb, available_storage_mb, uptime )
+	SELECT 	TOP(1)
-		SELECT	cpu_count,
+			(SELECT count(*) FROM sys.dm_os_schedulers WHERE status = 'VISIBLE ONLINE') AS cpu_count,
-				(SELECT total_physical_memory_kb FROM sys.dm_os_sys_memory) AS server_memory,
+			(SELECT process_memory_limit_mb FROM sys.dm_os_job_object) AS server_memory,
-				CAST(SERVERPROPERTY('Edition') AS NVARCHAR(64)) as sku,
+			slo.edition as sku,
-				CAST(SERVERPROPERTY('EngineEdition') as smallint) as engine_edition,
+			cast(SERVERPROPERTY('EngineEdition') as smallint)  AS engine_edition,
-				CASE virtual_machine_type_desc
+			slo.service_objective AS hardware_type,
-					WHEN 'NONE' THEN 'PHYSICAL Machine'
+                        cast(DATABASEPROPERTYEX(DB_NAME(),'MaxSizeInBytes') as bigint)/(1024*1024)  AS total_storage_mb,
-					ELSE virtual_machine_type_desc
+			NULL AS available_storage_mb,  -- Can we find out storage?
-				END AS hardware_type,
+			NULL as uptime
-				NULL,
+	FROM	 sys.databases d   
-				NULL,
+			JOIN sys.database_service_objectives slo    
-				 DATEDIFF(MINUTE,sqlserver_start_time,GETDATE())
+			ON d.database_id = slo.database_id
-		FROM	sys.dm_os_sys_info
+
-	END
+ELSE
+BEGIN
+	INSERT INTO @sys_info ( cpu_count, server_memory, sku, engine_edition, hardware_type, total_storage_mb, available_storage_mb, uptime )
+	SELECT	cpu_count,
+			(SELECT total_physical_memory_kb FROM sys.dm_os_sys_memory) AS server_memory,
+			CAST(SERVERPROPERTY('Edition') AS NVARCHAR(64)) as sku,
+			CAST(SERVERPROPERTY('EngineEdition') as smallint) as engine_edition,
+			CASE virtual_machine_type_desc
+				WHEN 'NONE' THEN 'PHYSICAL Machine'
+				ELSE virtual_machine_type_desc
+			END AS hardware_type,
+			NULL,
+			NULL,
+			 DATEDIFF(MINUTE,sqlserver_start_time,GETDATE())
+	FROM	sys.dm_os_sys_info
 END
 SELECT	'sqlserver_server_properties' AS [measurement],
 		REPLACE(@@SERVERNAME,'\',':') AS [sql_instance],
+		DB_NAME() as [database_name],
 		s.cpu_count,
 		s.server_memory,
 		s.sku,
@@ -457,7 +481,16 @@ FROM	(
 			SELECT	cpu_count, server_memory, sku, engine_edition, hardware_type, total_storage_mb, available_storage_mb, uptime
 			FROM	@sys_info
 		) AS s
-OPTION( RECOMPILE )
+`
+
+//Recommend disabling this by default, but is useful to detect single CPU spikes/bottlenecks
+const sqlServerSchedulersV2 string = `SET DEADLOCK_PRIORITY -10;
+SELECT  'sqlserver_schedulers' AS [measurement],
+                REPLACE(@@SERVERNAME,'\',':') AS [sql_instance],
+                DB_NAME() as [database_name],
+  cast(scheduler_id as varchar(4)) as scheduler_id, cast(cpu_id as varchar(4)) as cpu_id,is_online,is_idle,preemptive_switches_count,context_switches_count,current_tasks_count,runnable_tasks_count,current_workers_count
+  , active_workers_count,work_queue_count, pending_disk_io_count,load_factor,yield_count, total_cpu_usage_ms, total_scheduler_delay_ms
+from sys.dm_os_schedulers
 `
 
 const sqlPerformanceCountersV2 string = `SET DEADLOCK_PRIORITY -10;
@@ -572,8 +605,7 @@ WHERE	(
 		)
 
 DECLARE @SQL NVARCHAR(MAX)
-SET  @SQL = REPLACE('
+SET  @SQL = REPLACE('SELECT
-SELECT
 "SQLServer:Workload Group Stats" AS object,
 counter,
 instance,
@@ -605,6 +637,7 @@ EXEC( @SQL )
 
 SELECT	'sqlserver_performance' AS [measurement],
 		REPLACE(@@SERVERNAME,'\',':') AS [sql_instance],
+		DB_NAME() as [database_name],
 		pc.object_name AS [object],
 		pc.counter_name AS [counter],
 		CASE pc.instance_name WHEN '_Total' THEN 'Total' ELSE ISNULL(pc.instance_name,'') END AS [instance],
@@ -622,10 +655,14 @@ WHERE	pc.counter_name NOT LIKE '% base'
 OPTION(RECOMPILE);
 `
 
+// Conditional check based on Azure SQL DB v/s the rest aka (Azure SQL Managed instance OR On-prem SQL Server)
+// EngineEdition=5 is Azure SQL DB
 const sqlWaitStatsCategorizedV2 string = `SET DEADLOCK_PRIORITY -10;
+IF SERVERPROPERTY('EngineEdition') != 5
 SELECT
-'sqlserver_waitstats' AS [measurement],
+	'sqlserver_waitstats' AS [measurement],
 REPLACE(@@SERVERNAME,'\',':') AS [sql_instance],
+DB_NAME() as [database_name],
 ws.wait_type,
 wait_time_ms,
 wait_time_ms - signal_wait_time_ms AS [resource_wait_ms],
@@ -1178,16 +1215,68 @@ ws.wait_type NOT IN (
 	N'XE_DISPATCHER_WAIT', N'XE_LIVE_TARGET_TVF', N'XE_TIMER_EVENT',
 	N'SOS_WORK_DISPATCHER','RESERVED_MEMORY_ALLOCATION_EXT')
 AND waiting_tasks_count > 0
-AND wait_time_ms > 100
+AND wait_time_ms > 100;
-OPTION (RECOMPILE);
+
+ELSE
+	SELECT
+	'sqlserver_azuredb_waitstats' AS [measurement],
+	REPLACE(@@SERVERNAME,'\',':') AS [sql_instance],
+	DB_NAME() as [database_name'],
+	dbws.wait_type,
+	dbws.wait_time_ms,
+	dbws.wait_time_ms - signal_wait_time_ms AS [resource_wait_ms],
+	dbws.signal_wait_time_ms,
+	dbws.max_wait_time_ms,
+	dbws.waiting_tasks_count
+	FROM
+	sys.dm_db_wait_stats AS dbws WITH (NOLOCK)
+	WHERE
+		dbws.wait_type NOT IN (
+		N'BROKER_EVENTHANDLER', N'BROKER_RECEIVE_WAITFOR', N'BROKER_TASK_STOP',
+		N'BROKER_TO_FLUSH', N'BROKER_TRANSMITTER', N'CHECKPOINT_QUEUE',
+		N'CHKPT', N'CLR_AUTO_EVENT', N'CLR_MANUAL_EVENT', N'CLR_SEMAPHORE',
+		N'DBMIRROR_DBM_EVENT', N'DBMIRROR_EVENTS_QUEUE', N'DBMIRROR_WORKER_QUEUE',
+		N'DBMIRRORING_CMD', N'DIRTY_PAGE_POLL', N'DISPATCHER_QUEUE_SEMAPHORE',
+		N'EXECSYNC', N'FSAGENT', N'FT_IFTS_SCHEDULER_IDLE_WAIT', N'FT_IFTSHC_MUTEX',
+		N'HADR_CLUSAPI_CALL', N'HADR_FILESTREAM_IOMGR_IOCOMPLETION', N'HADR_LOGCAPTURE_WAIT',
+		N'HADR_NOTIFICATION_DEQUEUE', N'HADR_TIMER_TASK', N'HADR_WORK_QUEUE',
+		N'KSOURCE_WAKEUP', N'LAZYWRITER_SLEEP', N'LOGMGR_QUEUE',
+		N'MEMORY_ALLOCATION_EXT', N'ONDEMAND_TASK_QUEUE',
+		N'PARALLEL_REDO_WORKER_WAIT_WORK',
+		N'PREEMPTIVE_HADR_LEASE_MECHANISM', N'PREEMPTIVE_SP_SERVER_DIAGNOSTICS',
+		N'PREEMPTIVE_OS_LIBRARYOPS', N'PREEMPTIVE_OS_COMOPS', N'PREEMPTIVE_OS_CRYPTOPS',
+		N'PREEMPTIVE_OS_PIPEOPS','PREEMPTIVE_OS_GENERICOPS', N'PREEMPTIVE_OS_VERIFYTRUST',
+		N'PREEMPTIVE_OS_DEVICEOPS',
+		N'PREEMPTIVE_XE_CALLBACKEXECUTE', N'PREEMPTIVE_XE_DISPATCHER',
+		N'PREEMPTIVE_XE_GETTARGETSTATE', N'PREEMPTIVE_XE_SESSIONCOMMIT',
+		N'PREEMPTIVE_XE_TARGETINIT', N'PREEMPTIVE_XE_TARGETFINALIZE',
+		N'PWAIT_ALL_COMPONENTS_INITIALIZED', N'PWAIT_DIRECTLOGCONSUMER_GETNEXT',
+		N'QDS_PERSIST_TASK_MAIN_LOOP_SLEEP',
+		N'QDS_ASYNC_QUEUE',
+		N'QDS_CLEANUP_STALE_QUERIES_TASK_MAIN_LOOP_SLEEP', N'REQUEST_FOR_DEADLOCK_SEARCH',
+		N'RESOURCE_QUEUE', N'SERVER_IDLE_CHECK', N'SLEEP_BPOOL_FLUSH', N'SLEEP_DBSTARTUP',
+		N'SLEEP_DCOMSTARTUP', N'SLEEP_MASTERDBREADY', N'SLEEP_MASTERMDREADY',
+		N'SLEEP_MASTERUPGRADED', N'SLEEP_MSDBSTARTUP', N'SLEEP_SYSTEMTASK', N'SLEEP_TASK',
+		N'SLEEP_TEMPDBSTARTUP', N'SNI_HTTP_ACCEPT', N'SP_SERVER_DIAGNOSTICS_SLEEP',
+		N'SQLTRACE_BUFFER_FLUSH', N'SQLTRACE_INCREMENTAL_FLUSH_SLEEP',
+		N'SQLTRACE_WAIT_ENTRIES',
+		N'WAIT_FOR_RESULTS', N'WAITFOR', N'WAITFOR_TASKSHUTDOWN', N'WAIT_XTP_HOST_WAIT',
+		N'WAIT_XTP_OFFLINE_CKPT_NEW_LOG', N'WAIT_XTP_CKPT_CLOSE',
+		N'XE_BUFFERMGR_ALLPROCESSED_EVENT', N'XE_DISPATCHER_JOIN',
+		N'XE_DISPATCHER_WAIT', N'XE_LIVE_TARGET_TVF', N'XE_TIMER_EVENT',
+		N'SOS_WORK_DISPATCHER','RESERVED_MEMORY_ALLOCATION_EXT')
+	AND waiting_tasks_count > 0
+	AND wait_time_ms > 100;
 `
 
-const sqlAzureDB string = `SET DEADLOCK_PRIORITY -10;
+// Only executed if AzureDB flag is set
-IF OBJECT_ID('sys.dm_db_resource_stats') IS NOT NULL
+const sqlAzureDBResourceStats string = `SET DEADLOCK_PRIORITY -10;
+IF SERVERPROPERTY('EngineEdition') = 5  -- Is this Azure SQL DB?
 BEGIN
 	SELECT TOP(1)
 		'sqlserver_azurestats' AS [measurement],
 		REPLACE(@@SERVERNAME,'\',':') AS [sql_instance],
+		DB_NAME() as [database_name],
 		avg_cpu_percent,
 		avg_data_io_percent,
 		avg_log_write_percent,
@@ -1197,18 +1286,79 @@ BEGIN
 		max_session_percent,
 		dtu_limit,
 		avg_login_rate_percent,
-		end_time
+		end_time,
+		avg_instance_memory_percent,
+		avg_instance_cpu_percent
 	FROM
 		sys.dm_db_resource_stats WITH (NOLOCK)
 	ORDER BY
 		end_time DESC
-	OPTION (RECOMPILE)
-END
-ELSE
-BEGIN
-	RAISERROR('This does not seem to be an AzureDB instance. Set "azureDB = false" in your telegraf configuration.',16,1)
 END`
 
+//Only executed if AzureDB Flag is set
+const sqlAzureDBResourceGovernance string = `
+IF SERVERPROPERTY('EngineEdition') = 5  -- Is this Azure SQL DB?
+SELECT
+  'sqlserver_db_resource_governance' AS [measurement],
+   server_name AS [sql_instance],
+   DB_NAME() as [database_name],
+   slo_name,
+	dtu_limit,
+	max_cpu,
+	cap_cpu,
+	instance_cap_cpu,
+	max_db_memory,
+	max_db_max_size_in_mb,
+	db_file_growth_in_mb,
+	log_size_in_mb,
+	instance_max_worker_threads,
+	primary_group_max_workers,
+	instance_max_log_rate,
+	primary_min_log_rate,
+	primary_max_log_rate,
+	primary_group_min_io,
+	primary_group_max_io,
+	primary_group_min_cpu,
+	primary_group_max_cpu,
+	primary_pool_max_workers,
+	pool_max_io,
+	checkpoint_rate_mbps,
+	checkpoint_rate_io,
+	volume_local_iops,
+	volume_managed_xstore_iops,
+	volume_external_xstore_iops,
+	volume_type_local_iops,
+	volume_type_managed_xstore_iops,
+	volume_type_external_xstore_iops,
+	volume_pfs_iops,
+	volume_type_pfs_iops
+    FROM
+    sys.dm_user_db_resource_governance WITH (NOLOCK);
+ELSE
+  IF SERVERPROPERTY('EngineEdition') = 8  -- Is this Azure SQL Managed Instance?
+  BEGIN
+  	 SELECT
+	  'sqlserver_instance_resource_governance' AS [measurement],
+	   server_name AS [sql_instance],
+	   instance_cap_cpu,
+	   instance_max_log_rate,
+	   instance_max_worker_threads,
+	   volume_local_iops,
+	   volume_external_xstore_iops,
+	   volume_managed_xstore_iops,
+	   volume_type_local_iops,
+	   volume_type_managed_xstore_iops,
+	   volume_type_external_xstore_iops,
+	   volume_external_xstore_iops,
+	   volume_local_max_oustanding_io,
+	   volume_managed_xstore_max_oustanding_io,
+	   volume_external_xstore_max_oustanding_io,
+	   tempdb_log_file_number
+	  from
+	   sys.dm_instance_resource_governance
+  END;
+`
+
 // Queries V1
 const sqlPerformanceMetrics string = `SET DEADLOCK_PRIORITY -10;
 SET NOCOUNT ON;