Regenerate integrations docs (#21648)
Co-authored-by: ilyam8 <22274335+ilyam8@users.noreply.github.com>
Netdata bot committed
Jan 27, 2026 at 19:31 UTC
d5c610d5684a07712fc379109d39418cd5695c62
1 file changed
+18
-42
src/go/plugin/go.d/collector/mssql/integrations/microsoft_sql_server.md
+18
-42
@@ -49,7 +49,7 @@ This collector is supported on all platforms.
49
This collector supports collecting metrics from multiple instances of this integration, including remote instances.
50
51
The monitoring user requires the VIEW SERVER STATE permission to access DMVs.
52
-For SQL Agent job monitoring (queried during collector startup), access to
52
+SQL Agent job monitoring is part of collector startup, so access to
53
`msdb.dbo.sysjobs` is required.
54
55
@@ -382,7 +382,6 @@ Aggregated query execution statistics from Query Store runtime views, providing
382
| Max TempDB (8KB pages) | integer | | hidden | Maximum tempdb space observed. Spikes may indicate queries with large sort operations, hash joins, index spool usage, or temporary table creation consuming substantial tempdb space. Can lead to tempdb autogrow and disk space issues. |
383
| StdDev TempDB | float | | hidden | Standard deviation of tempdb space usage. High variability suggests inconsistent temporary object usage patterns, potentially varying by query complexity, parameter types, or different data access patterns affecting temporary object creation. |
384
385
-
385
### Deadlock Info
386
387
Retrieves the most recent deadlock event from SQL Server's `system_health` Extended Events ring buffer (`xml_deadlock_report`).
@@ -407,23 +406,7 @@ Query text and wait resource strings are truncated at 4096 characters for displa
406
407
#### Prerequisites
408
410
-1. Ensure the account has the required permission:
411
- ```sql
412
- GRANT VIEW SERVER STATE TO [netdata];
413
- ```
414
-2. Enable the function in Netdata collector config:
415
- ```yaml
416
- jobs:
417
- - name: local
418
- dsn: "sqlserver://user:pass@localhost:1433"
419
- deadlock_info_function_enabled: true
420
- ```
421
-3. Verify the deadlock source is accessible:
422
- ```sql
423
- SELECT name
424
- FROM sys.dm_xe_sessions
425
- WHERE name = 'system_health';
426
- ```
409
+No additional configuration is required.
410
411
#### Parameters
412
@@ -451,7 +434,17 @@ Parsed deadlock participants from the latest detected deadlock event. Each row r
434
### Error Info
435
436
Retrieves recent SQL errors from a user-managed Extended Events session that captures `sqlserver.error_reported`
454
-with the `sql_text` and `query_hash` actions (query_hash enables reliable mapping to top-queries).
437
+with both the `sql_text` and `query_hash` actions.
438
+
439
+The session must be created by an administrator and include a `ring_buffer` target. Netdata reads the ring buffer
440
+and returns recent error events with error number, message, and SQL text. The `query_hash` action is required for
441
+reliable mapping into `top-queries` (query text fallback is best-effort).
442
+
443
+Use cases:
444
+- Identify recent query errors and their messages
445
+- Correlate errors to query text
446
+- Validate error rates seen in top-queries
447
+
448
449
| Aspect | Description |
450
|:-------|:------------|
@@ -463,28 +456,7 @@ with the `sql_text` and `query_hash` actions (query_hash enables reliable mappin
456
457
#### Prerequisites
458
466
-1. Create an Extended Events session (admin-controlled) that captures `sqlserver.error_reported` with `sql_text` and `query_hash`:
467
- ```sql
468
- CREATE EVENT SESSION [netdata_errors] ON SERVER
469
- ADD EVENT sqlserver.error_reported(
470
- ACTION(sqlserver.sql_text, sqlserver.query_hash)
471
- )
472
- ADD TARGET package0.ring_buffer;
473
- GO
474
- ALTER EVENT SESSION [netdata_errors] ON SERVER STATE = START;
475
- ```
476
-2. Ensure the account has the required permission:
477
- ```sql
478
- GRANT VIEW SERVER STATE TO [netdata];
479
- ```
480
-3. Enable the function and (optionally) set the session name in Netdata config:
481
- ```yaml
482
- jobs:
483
- - name: local
484
- dsn: "sqlserver://user:pass@localhost:1433"
485
- error_info_function_enabled: true
486
- error_info_session_name: netdata_errors
487
- ```
459
+No additional configuration is required.
460
461
#### Parameters
462
@@ -504,6 +476,7 @@ Recent error events from the configured Extended Events session.
476
| Query Hash | string | | hidden | Query hash captured with the error event (used for mapping into top-queries). |
477
478
479
+
480
## Alerts
481
482
There are no alerts configured by default for this integration.
@@ -807,3 +780,6 @@ Ensure SQL Server is configured for mixed mode authentication if using SQL login
780
781
The monitoring user needs VIEW SERVER STATE permission.
782
Grant it with: `GRANT VIEW SERVER STATE TO netdata_user;`
783
+
784
+
785
+