Regenerate integrations docs (#20466)
Co-authored-by: ilyam8 <22274335+ilyam8@users.noreply.github.com>
Netdata bot committed
Jun 11, 2025 at 12:10 UTC
cbfa502e20ad5f2b9250774b3a493267eb22ebcb
1 file changed
+42
-3
src/collectors/windows.plugin/integrations/ms_sql_server.md
+42
-3
@@ -38,7 +38,8 @@ This collector only supports collecting metrics from a single instance of this i
38
39
#### Auto-Detection
40
41
-The collector automatically discovers and monitors standard SQL Server metrics without additional setup. However, for transaction-level metrics, you must:
41
+The collector automatically discovers and monitors standard SQL Server metrics without additional setup. However, for transaction-level metrics,
42
+the size of all the data files, and the wait stats in the database you must:
43
44
- Complete the "Configure SQL Server for Monitoring" steps in the Setup -> Prerequisites section.
45
- Configure a database connection (see Setup → Configuration → Examples).
@@ -91,10 +92,48 @@ Metrics:
92
| mssql.instance_memmgr_connection_memory_bytes | memory | bytes |
93
| mssql.instance_memmgr_pending_memory_grants | pending | processes |
94
| mssql.instance_memmgr_external_benefit_of_memory | benefit | bytes |
94
-| mssql.instance_resource_deadlocks | alloc_unit, application, database, extent, file, hobt, key, metadata, oib, object, page, rid, row_group, xact | deadlocks/s |
95
-| mssql.instance_resource_lock_wait | alloc_unit, application, database, extent, file, hobt, key, metadata, oib, object, page, rid, row_group, xact | locks/s |
95
| mssql.instance_blocked_processes | blocked | processes |
96
97
+### Per MSSQL Resource Locks
98
+
99
+Monitors SQL Server resource locks by type. SQL Server uses locks to manage concurrent access to database resources during transactions, preventing conflicts when multiple users access the same data simultaneously. This metric tracks locks on different [resource types](https://learn.microsoft.com/en-us/sql/relational-databases/performance-monitor/sql-server-locks-object?view=sql-server-ver17) like rows, pages, tables, and databases.
100
+
101
+Labels:
102
+
103
+| Label | Description |
104
+|:-----------|:----------------|
105
+| mssql_instance | The SQL Server instance name (e.g., 'MSSQLSERVER' for default instance or named instance like 'INSTANCE01'). |
106
+| resource | The specific resource type being locked (e.g., 'Database', 'Table', 'Page', 'Row', 'Key', 'Extent', 'RID', 'Application', 'Metadata', 'Allocation_Unit'). |
107
+
108
+Metrics:
109
+
110
+| Metric | Dimensions | Unit |
111
+|:------|:----------|:----|
112
+| mssql.instance_resource_deadlocks | locks | deadlock/s |
113
+| mssql.instance_resource_lock_waits | locks | lock/s |
114
+
115
+### Per MSSQL Waits
116
+
117
+These metrics refer to the Microsoft SQL Server instances defined on the host and their associated wait events.
118
+
119
+Labels:
120
+
121
+| Label | Description |
122
+|:-----------|:----------------|
123
+| mssql_instance | The instance name. |
124
+| wait_type | A wait defined in https://learn.microsoft.com/en-us/sql/relational-databases/system-dynamic-management-views/sys-dm-os-wait-stats-transact-sql?view=sql-server-ver16#WaitTypes. |
125
+| wait_category | Wait categories are groupings of specific wait types that indicate the reason a SQL Server worker is waiting. |
126
+
127
+Metrics:
128
+
129
+| Metric | Dimensions | Unit |
130
+|:------|:----------|:----|
131
+| mssql.instance_total_wait_time | duration | ms |
132
+| mssql.instance_resource_wait_time | duration | ms |
133
+| mssql.instance_signal_wait_time | duration | ms |
134
+| mssql.instance_max_wait_time | duration | ms |
135
+| mssql.instance_waits | waits | waits/s |
136
+
137
### Per Database
138
139
These metrics refer to Microsoft SQL Server databases.