Regenerate integrations docs (#21877)
Co-authored-by: ilyam8 <22274335+ilyam8@users.noreply.github.com>
Netdata bot committed
Mar 4, 2026 at 16:01 UTC
8cc3dfc1310b9d33dcd8ea1807dc671ae1baef9e
2 files changed
-404
src/collectors/COLLECTORS.md
-1
@@ -79,7 +79,6 @@ Need a dedicated integration? [Submit a feature request](https://github.com/netd
79
| [Microsoft SQL Server](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/mssql/integrations/microsoft_sql_server.md) | This collector monitors the health and performance of Microsoft SQL Server instances. |
80
| [MongoDB](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/mongodb/integrations/mongodb.md) | This collector monitors MongoDB servers. |
81
| [mosquitto](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/mosquitto.md) | Keep an eye on Mosquitto MQTT broker metrics for efficient IoT message transport and performance. |
82
-| [MS SQL Server](https://github.com/netdata/netdata/blob/master/src/collectors/windows.plugin/integrations/ms_sql_server.md) | This collector monitors Microsoft SQL Server statistics. |
82
| [MySQL](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/mysql/integrations/mysql.md) | This collector monitors the health and performance of MySQL servers and collects general statistics, replication and user metrics. |
83
| [NATS](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/nats/integrations/nats.md) | This collector monitors the activity and performance of NATS servers. |
84
| [OpenSearch](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/elasticsearch/integrations/opensearch.md) | This collector monitors the performance and health of the Elasticsearch cluster. |
src/collectors/windows.plugin/integrations/ms_sql_server.md
deleted
-403
@@ -1,403 +0,0 @@
1
-<!--startmeta
2
-custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/integrations/ms_sql_server.md"
3
-meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/metadata.yaml"
4
-sidebar_label: "MS SQL Server"
5
-learn_status: "Published"
6
-learn_rel_path: "Collecting Metrics/Databases"
7
-keywords: ['windows', 'microsoft', 'sql', 'queries']
8
-message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
9
-endmeta-->
10
-
11
-# MS SQL Server
12
-
13
-
14
-<img src="https://netdata.cloud/img/windows.svg" width="150"/>
15
-
16
-
17
-Plugin: windows.plugin
18
-Module: PerflibMSSQL
19
-
20
-<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
21
-
22
-## Overview
23
-
24
-This collector monitors Microsoft SQL Server statistics.
25
-
26
-
27
-It queries different SQL objects per instance from Perflib in order to gather the metrics.
28
-
29
-
30
-This collector is only supported on the following platforms:
31
-
32
-- windows
33
-
34
-This collector only supports collecting metrics from a single instance of this integration.
35
-
36
-
37
-### Default Behavior
38
-
39
-#### Auto-Detection
40
-
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).
46
-
47
-
48
-#### Limits
49
-
50
-The default configuration for this integration does not impose any limits on data collection.
51
-
52
-#### Performance Impact
53
-
54
-The default configuration for this integration is not expected to impose a significant performance impact on the system.
55
-
56
-## Metrics
57
-
58
-Metrics grouped by *scope*.
59
-
60
-The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
61
-
62
-
63
-
64
-### Per MSSQL instance
65
-
66
-These metrics refer to the Microsoft SQL Servers instances defined on host.
67
-
68
-Labels:
69
-
70
-| Label | Description |
71
-|:-----------|:----------------|
72
-| mssql_instance | The instance name. |
73
-
74
-Metrics:
75
-
76
-| Metric | Dimensions | Unit |
77
-|:------|:----------|:----|
78
-| mssql.instance_user_connections | user | connections |
79
-| mssql.instance_sessions_connections | session | connections |
80
-| mssql.instance_sqlstats_batch_requests | batch | requests/s |
81
-| mssql.instance_sql_errors | errors | errors/s |
82
-| mssql.instance_sqlstats_sql_compilations | compilations | compilations/s |
83
-| mssql.instance_sqlstats_sql_recompilations | recompiles | recompiles/s |
84
-| mssql.instance_sqlstats_auto_parameterization_attempts | failed | attempts/s |
85
-| mssql.instance_sqlstats_safe_auto_parameterization_attempts | safe | attempts/s |
86
-| mssql.instance_accessmethods_page_splits | page | splits/s |
87
-| mssql.instance_cache_hit_ratio | hit_ratio | percentage |
88
-| mssql.instance_bufman_iops | read, written | pages/s |
89
-| mssql.instance_bufman_checkpoint_pages | log | pages/s |
90
-| mssql.instance_bufman_page_life_expectancy | life_expectancy | seconds |
91
-| mssql.instance_bufman_lazy_write | writes | writes/s |
92
-| mssql.instance_bufman_page_lookups | lookups | lookups/s |
93
-| mssql.instance_memmgr_server_memory | memory | bytes |
94
-| mssql.database_readonly | writable, readonly | status |
95
-| mssql.database_state | online, restoring, recovering, recovering_pending, suspect, offline | status |
96
-| mssql.instance_memmgr_connection_memory_bytes | memory | bytes |
97
-| mssql.instance_memmgr_pending_memory_grants | pending | processes |
98
-| mssql.instance_memmgr_external_benefit_of_memory | benefit | bytes |
99
-| mssql.instance_blocked_processes | blocked | processes |
100
-
101
-### Per MSSQL Jobs
102
-
103
-These metrics refer to the Microsoft SQL Servers jobs on host.
104
-
105
-Labels:
106
-
107
-| Label | Description |
108
-|:-----------|:----------------|
109
-| mssql_instance | The instance name. |
110
-| job_name | The job name. |
111
-
112
-Metrics:
113
-
114
-| Metric | Dimensions | Unit |
115
-|:------|:----------|:----|
116
-| mssql.instance_jobs_status | enabled, disabled | jobs |
117
-
118
-### Per MSSQL Resource Locks
119
-
120
-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.
121
-
122
-Labels:
123
-
124
-| Label | Description |
125
-|:-----------|:----------------|
126
-| mssql_instance | The SQL Server instance name (e.g., 'MSSQLSERVER' for default instance or named instance like 'INSTANCE01'). |
127
-| resource | The specific resource type being locked (e.g., 'Database', 'Table', 'Page', 'Row', 'Key', 'Extent', 'RID', 'Application', 'Metadata', 'Allocation_Unit'). |
128
-
129
-Metrics:
130
-
131
-| Metric | Dimensions | Unit |
132
-|:------|:----------|:----|
133
-| mssql.instance_resource_deadlocks | locks | deadlock/s |
134
-| mssql.instance_resource_lock_waits | locks | lock/s |
135
-
136
-### Per MSSQL Waits
137
-
138
-These metrics refer to the Microsoft SQL Server instances defined on the host and their associated wait events.
139
-
140
-Labels:
141
-
142
-| Label | Description |
143
-|:-----------|:----------------|
144
-| mssql_instance | The instance name. |
145
-| 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. |
146
-| wait_category | Wait categories are groupings of specific wait types that indicate the reason a SQL Server worker is waiting. |
147
-
148
-Metrics:
149
-
150
-| Metric | Dimensions | Unit |
151
-|:------|:----------|:----|
152
-| mssql.instance_total_wait_time | duration | ms |
153
-| mssql.instance_resource_wait_time | duration | ms |
154
-| mssql.instance_signal_wait_time | duration | ms |
155
-| mssql.instance_max_wait_time | duration | ms |
156
-| mssql.instance_waits | waits | waits/s |
157
-
158
-### Per Database
159
-
160
-These metrics refer to Microsoft SQL Server databases.
161
-
162
-Labels:
163
-
164
-| Label | Description |
165
-|:-----------|:----------------|
166
-| mssql_instance | The instance name. |
167
-| database | The database name. |
168
-
169
-Metrics:
170
-
171
-| Metric | Dimensions | Unit |
172
-|:------|:----------|:----|
173
-| mssql.database_active_transactions | active | transactions |
174
-| mssql.database_transactions | transactions | transactions/s |
175
-| mssql.database_write_transactions | write | transactions/s |
176
-| mssql.database_lockwait | lock | locks/s |
177
-| mssql.database_deadlocks | deadlocks | deadlocks/s |
178
-| mssql.database_lock_timeouts | timeouts | timeouts/s |
179
-| mssql.database_lock_requests | requests | requests/s |
180
-| mssql.database_backup_restore_operations | backup | operations/s |
181
-| mssql.database_log_flushes | log | flushes/s |
182
-| mssql.database_log_flushed | flushed | bytes/s |
183
-| mssql.database_data_files_size | size | bytes |
184
-
185
-### Per MSSQL Replication
186
-
187
-These metrics refer to the Microsoft SQL Servers replication on host.
188
-
189
-Labels:
190
-
191
-| Label | Description |
192
-|:-----------|:----------------|
193
-| mssql_instance | The instance name. |
194
-| publisher | The SQL server publisher name. |
195
-| database | The database being replicated. |
196
-| publication | The publication name. |
197
-
198
-Metrics:
199
-
200
-| Metric | Dimensions | Unit |
201
-|:------|:----------|:----|
202
-| mssql.replication_status | started, succeeded, in_progress, idle, retrying, failed | status |
203
-| mssql.replication_warning | expiration, latency, merge expiration, fast duration, low duration, fast run speed, low run speed | status |
204
-| mssql.replication_avg_latency | latency | seconds |
205
-| mssql.replication_subscription | subscription | subscription |
206
-| mssql.replication_agent_running | agents | agents |
207
-| mssql.replication_synchronization | seconds | seconds |
208
-
209
-
210
-
211
-## Alerts
212
-
213
-There are no alerts configured by default for this integration.
214
-
215
-
216
-## Setup
217
-
218
-
219
-### Prerequisites
220
-
221
-#### Configure SQL Server for Monitoring
222
-
223
-For **each SQL Server** instance you want to monitor, complete the following steps:
224
-
225
-1. **Create Monitoring User**
226
-
227
- Create an SQL Server user with the necessary permissions to collect monitoring data:
228
-
229
- ```tsql
230
- USE master;
231
- CREATE LOGIN netdata_user WITH PASSWORD = '1ReallyStrongPasswordShouldBeInsertedHere';
232
- CREATE USER netdata_user FOR LOGIN netdata_user;
233
- GRANT CONNECT SQL TO netdata_user;
234
- GRANT VIEW SERVER STATE TO netdata_user;
235
- GO
236
- ```
237
-
238
-2. **Enable Query Store**
239
-
240
- Enable the [Query Store](https://learn.microsoft.com/en-us/sql/relational-databases/performance/monitoring-performance-by-using-the-query-store?view=sql-server-ver16) and grant access to the monitoring user on all relevant databases:
241
-
242
- ```tsql
243
- DECLARE @dbname NVARCHAR(max)
244
- DECLARE nd_user_cursor CURSOR FOR SELECT name
245
- FROM master.dbo.sysdatabases
246
- WHERE name NOT IN ('master')
247
-
248
- OPEN nd_user_cursor
249
- FETCH NEXT FROM nd_user_cursor INTO @dbname
250
- WHILE @@FETCH_STATUS = 0
251
- BEGIN
252
- EXECUTE ("USE "+ @dbname+"; CREATE USER netdata_user FOR LOGIN netdata_user; ALTER DATABASE "+@dbname+" SET QUERY_STORE = ON ( QUERY_CAPTURE_MODE = ALL, DATA_FLUSH_INTERVAL_SECONDS = 900 )");
253
- FETCH next FROM nd_user_cursor INTO @dbname;
254
- END
255
- CLOSE nd_user_cursor
256
- DEALLOCATE nd_user_cursor
257
- GO
258
- ```
259
-
260
-3. **Enable Query Job status**
261
-
262
- Connect to your database and grant `SELECT` permission to `netdata_user`:
263
-
264
- ```tsql
265
- USE msdb;
266
- GO
267
- GRANT SELECT ON SCHEMA::[dbo] TO netdata_user;
268
- GO
269
- ```
270
-
271
-4. **Enable Query replication stored procedure**
272
-
273
- Connect to your database and add `netdata_user` to `replmonitor`:
274
-
275
- ```tsql
276
- USE distribution;
277
- GO
278
- EXEC sp_addrolemember 'replmonitor', 'netdata_user';
279
- GO
280
- ```
281
-
282
-5. **Configure SQL Server Network Settings**
283
-
284
- Enable SQL Server to accept TCP connections:
285
-
286
- - Open `SQL Server Configuration Manager`
287
- - Expand `SQL Server Network Configuration`
288
- - Select `Protocols for <instance name>` in the console panel
289
- - Double-click the `TCP` protocol in the details panel and set `Enabled` to `Yes`
290
- - Go to the `IP Address` tab and locate the `IPAII` section:
291
- - Clear any value from the `TCP Dynamic Ports` field
292
- - Enter a port number in the `TCP Port` field (default is `1433`)
293
- - Select `SQL Server Services` and restart your SQL Server instance
294
-
295
-6. **Configure SQL Server Authentication (Optional)**
296
-
297
- If you're using SQL Server authentication (rather than Windows authentication):
298
-
299
- - Open `SQL Server Management Studio`
300
- - Right-click your server and select `Properties`
301
- - Select `Security` in the left panel
302
- - Choose `SQL Server and Windows Authentication mode` under `Server authentication`
303
- - Click `OK`
304
- - Right-click your server and select `Restart`
305
-
306
-
307
-
308
-### Configuration
309
-
310
-#### Options
311
-
312
-These options allow the collector to connect to your MSSQL instance and collect transaction data from it.
313
-
314
-
315
-
316
-| Option | Description | Default | Required |
317
-|:-----|:------------|:--------|:---------:|
318
-| update every | Data collection frequency. | 10 | no |
319
-| driver | ODBC driver used to connect to the SQL Server. | SQL Server | no |
320
-| instance | Instance name | empty | yes |
321
-| server | Server address or instance name. | empty | yes |
322
-| address | Alternative to `server`; supports named pipes if the server supports them. | empty | yes |
323
-| uid | SQL Server user identifier. | empty | yes |
324
-| pwd | Password for the specified user. | empty | yes |
325
-| additional instances | Number of additional SQL Server instances to monitor. | 0 | no |
326
-| windows authentication | Set to yes to use Windows credentials instead of SQL Server authentication. | no | no |
327
-| trust server certificate | Set to yes to trust the server's SSL certificate chain. | yes | no |
328
-| express | Set to yes when running SQL Express version. | no | no |
329
-| collect transactions | Run queries to collect information from the server's transactions. | yes | no |
330
-| collect waits | Run queries to collect information from the server's lock waits. | yes | no |
331
-| collect lock metrics | Run queries to collect information from the server's overall locks. | yes | no |
332
-| collect replication | Run queries to collect information from the server's replication. | yes | no |
333
-| collect jobs | Run queries to collect information from the server's jobs. | yes | no |
334
-| collect buffer stats | Run queries to collect information from the server's buffer statistics. | yes | no |
335
-| collect database size | Run queries to collect information from the server's database size. | yes | no |
336
-| collect user connections | Run queries to collect information from the server's connection. | yes | no |
337
-| collect blocked processes | Run queries to collect information from the server's blocked processes. | yes | no |
338
-
339
-
340
-
341
-
342
-#### via File
343
-
344
-The configuration file name for this integration is `netdata.conf`.
345
-Configuration for this specific integration is located in the `[plugin:windows:PerflibMSSQL]` section within that file.
346
-
347
-The file format is a modified INI syntax. The general structure is:
348
-
349
-```ini
350
-[section1]
351
- option1 = some value
352
- option2 = some other value
353
-
354
-[section2]
355
- option3 = some third value
356
-```
357
-You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
358
-Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
359
-
360
-```bash
361
-cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
362
-sudo ./edit-config netdata.conf
363
-```
364
-
365
-##### Examples
366
-
367
-###### Single Instance
368
-
369
-An example configuration with one instance.
370
-
371
-```yaml
372
-[plugin:windows:PerflibMSSQL]
373
- driver = SQL Server
374
- instance = Dev
375
- server = 127.0.0.1\\Dev, 1433
376
- uid = netdata_user
377
- pwd = 1ReallyStrongPasswordShouldBeInsertedHere
378
- express = no
379
-
380
-```
381
-###### Multiple Instances
382
-
383
-An example configuration with two instances.
384
-
385
-```yaml
386
-[plugin:windows:PerflibMSSQL]
387
- driver = SQL Server
388
- server = 127.0.0.1\\Dev, 1433
389
- instance = Dev
390
- uid = netdata_user
391
- pwd = 1ReallyStrongPasswordShouldBeInsertedHere
392
- additional instances = 1
393
- express = no
394
-[plugin:windows:PerflibMSSQL1]
395
- driver = SQL Server
396
- server = 127.0.0.1\\Production, 1434
397
- instance = Production
398
- uid = netdata_user
399
- pwd = AnotherReallyStrongPasswordShouldBeInsertedHere2
400
- express = no
401
-
402
-```
403
-