Merge branch 'master' of github.com:influxdata/telegraf

.circleci/config.yml

@@ -71,14 +71,6 @@ commands:
           paths:
             - 'dist'
 jobs:
-  linter:
-    executor: go-1_16
-    steps:
-      - checkout
-      - restore_cache:
-          key: go-mod-v1-{{ checksum "go.sum" }}
-      - run: wget -O- -nv https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin v1.37.0
-      - run: make lint
   deps:
     executor: go-1_16
     steps:
@@ -209,7 +201,6 @@ workflows:
   version: 2
   check:
     jobs:
-      - 'linter'
       - 'macdeps':
           filters:
             tags:
@@ -287,7 +278,6 @@ workflows:
                 only: /.*/
   nightly:
     jobs:
-      - 'linter'
       - 'deps'
       - 'macdeps'
       - 'test-go-1_15':

.github/workflows/golangci-lint.yml

@@ -0,0 +1,23 @@
+name: golangci-lint
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+  schedule:
+    # Trigger every day at 16:00 UTC
+    - cron:  '0 16 * * *'
+jobs:
+  golangci-pr:
+    name: lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v2
+        with:
+          version: v1.38
+          only-new-issues: true
+          args: --timeout=5m0s

etc/telegraf.conf

@@ -5859,6 +5859,11 @@
 # ## If you are using AzureDB, setting this to true will gather resource utilization metrics
 # # azuredb = false
 
+# ## Toggling this to true will emit an additional metric called "sqlserver_telegraf_health". 
+# ## This metric tracks the count of attempted queries and successful queries for each SQL instance specified in "servers". 
+# ## The purpose of this metric is to assist with identifying and diagnosing any connectivity or query issues. 
+# ## This setting/metric is optional and is disabled by default.
+# # health_metric = false
 
 # # Gather timeseries from Google Cloud Platform v3 monitoring API
 # [[inputs.stackdriver]]

plugins/inputs/sqlserver/README.md

@@ -101,6 +101,12 @@ GO
   ## If you are using AzureDB, setting this to true will gather resource utilization metrics
   # azuredb = false
 
+  ## Toggling this to true will emit an additional metric called "sqlserver_telegraf_health". 
+  ## This metric tracks the count of attempted queries and successful queries for each SQL instance specified in "servers". 
+  ## The purpose of this metric is to assist with identifying and diagnosing any connectivity or query issues. 
+  ## This setting/metric is optional and is disabled by default.
+  # health_metric = false
+
   ## Possible queries accross different versions of the collectors
   ## Queries enabled by default for specific Database Type
 
@@ -323,4 +329,20 @@ 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.
 
+#### Health Metric
+All collection versions (version 1, version 2, and database_type) support an optional plugin health metric called `sqlserver_telegraf_health`. This metric tracks if connections to SQL Server are succeeding or failing. Users can leverage this metric to detect if their SQL Server monitoring is not working as intended.
+
+In the configuration file, toggling `health_metric` to `true` will enable collection of this metric. By default, this value is set to `false` and the metric is not collected. The health metric emits one record for each connection specified by `servers` in the configuration file.
+
+The health metric emits the following tags:
+- `sql_instance` - Name of the server specified in the connection string. This value is emitted as-is in the connection string. If the server could not be parsed from the connection string, a constant placeholder value is emitted
+- `database_name` -  Name of the database or (initial catalog) specified in the connection string. This value is emitted as-is in the connection string. If the database could not be parsed from the connection string, a constant placeholder value is emitted
+
+The health metric emits the following fields:
+- `attempted_queries` - Number of queries that were attempted for this connection
+- `successful_queries` - Number of queries that completed successfully for this connection
+- `database_type` - Type of database as specified by `database_type`. If `database_type` is empty, the `QueryVersion` and `AzureDB` fields are concatenated instead
+
+If `attempted_queries` and `successful_queries` are not equal for a given connection, some metrics were not successfully gathered for that connection. If `successful_queries` is 0, no metrics were successfully gathered.
+
 [cardinality]: /docs/FAQ.md#user-content-q-how-can-i-manage-series-cardinality

plugins/inputs/sqlserver/azuresqlqueries.go

@@ -438,106 +438,111 @@ WITH PerfCounters AS (
 			ELSE d.[physical_database_name]
 		END
 	WHERE
-		counter_name IN (
-			 'SQL Compilations/sec'
-			,'SQL Re-Compilations/sec'
-			,'User Connections'
-			,'Batch Requests/sec'
-			,'Logouts/sec'
-			,'Logins/sec'
-			,'Processes blocked'
-			,'Latch Waits/sec'
-			,'Full Scans/sec'
-			,'Index Searches/sec'
-			,'Page Splits/sec'
-			,'Page lookups/sec'
-			,'Page reads/sec'
-			,'Page writes/sec'
-			,'Readahead pages/sec'
-			,'Lazy writes/sec'
-			,'Checkpoint pages/sec'
-			,'Table Lock Escalations/sec'
-			,'Page life expectancy'
-			,'Log File(s) Size (KB)'
-			,'Log File(s) Used Size (KB)'
-			,'Data File(s) Size (KB)'
-			,'Transactions/sec'
-			,'Write Transactions/sec'
-			,'Active Transactions'
-			,'Log Growths'
-			,'Active Temp Tables'
-			,'Logical Connections'
-			,'Temp Tables Creation Rate'
-			,'Temp Tables For Destruction'
-			,'Free Space in tempdb (KB)'
-			,'Version Store Size (KB)'
-			,'Memory Grants Pending'
-			,'Memory Grants Outstanding'
-			,'Free list stalls/sec'
-			,'Buffer cache hit ratio'
-			,'Buffer cache hit ratio base'
-			,'Backup/Restore Throughput/sec'
-			,'Total Server Memory (KB)'
-			,'Target Server Memory (KB)'
-			,'Log Flushes/sec'
-			,'Log Flush Wait Time'
-			,'Memory broker clerk size'
-			,'Log Bytes Flushed/sec'
-			,'Bytes Sent to Replica/sec'
-			,'Log Send Queue'
-			,'Bytes Sent to Transport/sec'
-			,'Sends to Replica/sec'
-			,'Bytes Sent to Transport/sec'
-			,'Sends to Transport/sec'
-			,'Bytes Received from Replica/sec'
-			,'Receives from Replica/sec'
-			,'Flow Control Time (ms/sec)'
-			,'Flow Control/sec'
-			,'Resent Messages/sec'
-			,'Redone Bytes/sec'
-			,'XTP Memory Used (KB)'
-			,'Transaction Delay'
-			,'Log Bytes Received/sec'
-			,'Log Apply Pending Queue'
-			,'Redone Bytes/sec'
-			,'Recovery Queue'
-			,'Log Apply Ready Queue'
-			,'CPU usage %'
-			,'CPU usage % base'
-			,'Queued requests'
-			,'Requests completed/sec'
-			,'Blocked tasks'
-			,'Active memory grant amount (KB)'
-			,'Disk Read Bytes/sec'
-			,'Disk Read IO Throttled/sec'
-			,'Disk Read IO/sec'
-			,'Disk Write Bytes/sec'
-			,'Disk Write IO Throttled/sec'
-			,'Disk Write IO/sec'
-			,'Used memory (KB)'
-			,'Forwarded Records/sec'
-			,'Background Writer pages/sec'
-			,'Percent Log Used'
-			,'Log Send Queue KB'
-			,'Redo Queue KB'
-			,'Mirrored Write Transactions/sec'
-			,'Group Commit Time'
-			,'Group Commits/Sec'
-			,'Distributed Query'
-			,'DTC calls'
-			,'Query Store CPU usage'
-		) OR (
-			spi.[object_name] LIKE '%User Settable%'
-			OR spi.[object_name] LIKE '%SQL Errors%'
-			OR spi.[object_name] LIKE '%Batch Resp Statistics%'
-		) OR (
-			spi.[instance_name] IN ('_Total')
-			AND spi.[counter_name] IN (
-				 'Lock Timeouts/sec'
-				,'Lock Timeouts (timeout > 0)/sec'
-				,'Number of Deadlocks/sec'
-				,'Lock Waits/sec'
+		/*filter out unnecessary SQL DB system database counters, other than master and tempdb*/
+		NOT (spi.object_name LIKE 'MSSQL%:Databases%' AND spi.instance_name IN ('model','model_masterdb','model_userdb','msdb','mssqlsystemresource'))
+		AND
+		(
+			counter_name IN (
+				 'SQL Compilations/sec'
+				,'SQL Re-Compilations/sec'
+				,'User Connections'
+				,'Batch Requests/sec'
+				,'Logouts/sec'
+				,'Logins/sec'
+				,'Processes blocked'
 				,'Latch Waits/sec'
+				,'Full Scans/sec'
+				,'Index Searches/sec'
+				,'Page Splits/sec'
+				,'Page lookups/sec'
+				,'Page reads/sec'
+				,'Page writes/sec'
+				,'Readahead pages/sec'
+				,'Lazy writes/sec'
+				,'Checkpoint pages/sec'
+				,'Table Lock Escalations/sec'
+				,'Page life expectancy'
+				,'Log File(s) Size (KB)'
+				,'Log File(s) Used Size (KB)'
+				,'Data File(s) Size (KB)'
+				,'Transactions/sec'
+				,'Write Transactions/sec'
+				,'Active Transactions'
+				,'Log Growths'
+				,'Active Temp Tables'
+				,'Logical Connections'
+				,'Temp Tables Creation Rate'
+				,'Temp Tables For Destruction'
+				,'Free Space in tempdb (KB)'
+				,'Version Store Size (KB)'
+				,'Memory Grants Pending'
+				,'Memory Grants Outstanding'
+				,'Free list stalls/sec'
+				,'Buffer cache hit ratio'
+				,'Buffer cache hit ratio base'
+				,'Backup/Restore Throughput/sec'
+				,'Total Server Memory (KB)'
+				,'Target Server Memory (KB)'
+				,'Log Flushes/sec'
+				,'Log Flush Wait Time'
+				,'Memory broker clerk size'
+				,'Log Bytes Flushed/sec'
+				,'Bytes Sent to Replica/sec'
+				,'Log Send Queue'
+				,'Bytes Sent to Transport/sec'
+				,'Sends to Replica/sec'
+				,'Bytes Sent to Transport/sec'
+				,'Sends to Transport/sec'
+				,'Bytes Received from Replica/sec'
+				,'Receives from Replica/sec'
+				,'Flow Control Time (ms/sec)'
+				,'Flow Control/sec'
+				,'Resent Messages/sec'
+				,'Redone Bytes/sec'
+				,'XTP Memory Used (KB)'
+				,'Transaction Delay'
+				,'Log Bytes Received/sec'
+				,'Log Apply Pending Queue'
+				,'Redone Bytes/sec'
+				,'Recovery Queue'
+				,'Log Apply Ready Queue'
+				,'CPU usage %'
+				,'CPU usage % base'
+				,'Queued requests'
+				,'Requests completed/sec'
+				,'Blocked tasks'
+				,'Active memory grant amount (KB)'
+				,'Disk Read Bytes/sec'
+				,'Disk Read IO Throttled/sec'
+				,'Disk Read IO/sec'
+				,'Disk Write Bytes/sec'
+				,'Disk Write IO Throttled/sec'
+				,'Disk Write IO/sec'
+				,'Used memory (KB)'
+				,'Forwarded Records/sec'
+				,'Background Writer pages/sec'
+				,'Percent Log Used'
+				,'Log Send Queue KB'
+				,'Redo Queue KB'
+				,'Mirrored Write Transactions/sec'
+				,'Group Commit Time'
+				,'Group Commits/Sec'
+				,'Distributed Query'
+				,'DTC calls'
+				,'Query Store CPU usage'
+			) OR (
+				spi.[object_name] LIKE '%User Settable%'
+				OR spi.[object_name] LIKE '%SQL Errors%'
+				OR spi.[object_name] LIKE '%Batch Resp Statistics%'
+			) OR (
+				spi.[instance_name] IN ('_Total')
+				AND spi.[counter_name] IN (
+					 'Lock Timeouts/sec'
+					,'Lock Timeouts (timeout > 0)/sec'
+					,'Number of Deadlocks/sec'
+					,'Lock Waits/sec'
+					,'Latch Waits/sec'
+				)
 			)
 		)
 )