Regenerate integrations docs (#21653)
Co-authored-by: ilyam8 <22274335+ilyam8@users.noreply.github.com>
Netdata bot committed
Jan 28, 2026 at 00:47 UTC
174c5f5b4a7485e79d9893aca1fdf3adde06d81e
16 files changed
+130
-23
src/go/plugin/go.d/collector/clickhouse/integrations/clickhouse.md
+3
@@ -329,6 +329,9 @@ The following options can be defined globally: update_every, autodetection_retry
329
| | headers | Additional HTTP headers (one per line as key: value). | | no |
330
| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
331
| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
332
+| **Functions** | functions.top_queries.disabled | Disable the [top-queries](#top-queries) function. | no | no |
333
+| | functions.top_queries.timeout | Query timeout (seconds). Uses collector timeout if not set. | | no |
334
+| | functions.top_queries.limit | Maximum number of queries to return. | 500 | no |
335
| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
336
337
src/go/plugin/go.d/collector/cockroachdb/integrations/cockroachdb.md
+9
-4
@@ -349,9 +349,6 @@ The following options can be defined globally: update_every, autodetection_retry
349
| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
350
| **Target** | url | Target endpoint URL. | http://127.0.0.1:8080/_status/vars | yes |
351
| | timeout | HTTP request timeout (seconds). | 1 | no |
352
-| **Query Functions** | dsn | SQL DSN used by `top-queries` and `running-queries` functions. | | no |
353
-| | sql_timeout | SQL query timeout (seconds) for query functions. | 1 | no |
354
-| **Limits** | top_queries_limit | Maximum number of rows returned by the `top-queries` and `running-queries` functions. | 500 | no |
352
| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
353
| | password | Password for Basic HTTP authentication. | | no |
354
| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
@@ -367,6 +364,13 @@ The following options can be defined globally: update_every, autodetection_retry
364
| | headers | Additional HTTP headers (one per line as key: value). | | no |
365
| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
366
| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
367
+| **Functions** | functions.dsn | SQL DSN (required for query functions). | | no |
368
+| | functions.top_queries.disabled | Disable the [top-queries](#top-queries) function. | no | no |
369
+| | functions.top_queries.timeout | Query timeout (seconds). Uses collector timeout if not set. | | no |
370
+| | functions.top_queries.limit | Maximum number of queries to return. | 500 | no |
371
+| | functions.running_queries.disabled | Disable the [running-queries](#running-queries) function. | no | no |
372
+| | functions.running_queries.timeout | Query timeout (seconds). Uses collector timeout if not set. | | no |
373
+| | functions.running_queries.limit | Maximum number of queries to return. | 500 | no |
374
| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
375
376
@@ -434,7 +438,8 @@ Enable SQL query functions.
438
jobs:
439
- name: local
440
url: http://127.0.0.1:8080/_status/vars
437
- dsn: postgres://root@127.0.0.1:26257/defaultdb?sslmode=disable
441
+ functions:
442
+ dsn: postgres://root@127.0.0.1:26257/defaultdb?sslmode=disable
443
444
```
445
</details>
src/go/plugin/go.d/collector/couchbase/integrations/couchbase.md
+3
@@ -216,6 +216,9 @@ The following options can be defined globally: update_every, autodetection_retry
216
| | headers | Additional HTTP headers (one per line as key: value). | | no |
217
| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
218
| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
219
+| **Functions** | functions.top_queries.disabled | Disable the [top-queries](#top-queries) function. | no | no |
220
+| | functions.top_queries.timeout | Query timeout (seconds). Uses collector timeout if not set. | | no |
221
+| | functions.top_queries.limit | Maximum number of queries to return. | 500 | no |
222
| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
223
224
src/go/plugin/go.d/collector/elasticsearch/integrations/elasticsearch.md
+3
@@ -318,6 +318,9 @@ The following options can be defined globally: update_every, autodetection_retry
318
| | headers | Additional HTTP headers (one per line as key: value). | | no |
319
| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
320
| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
321
+| **Functions** | functions.top_queries.disabled | Disable the [top-queries](#top-queries) function. | no | no |
322
+| | functions.top_queries.timeout | Query timeout (seconds). Uses collector timeout if not set. | | no |
323
+| | functions.top_queries.limit | Maximum number of queries to return. | 500 | no |
324
| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
325
326
src/go/plugin/go.d/collector/elasticsearch/integrations/opensearch.md
+3
@@ -318,6 +318,9 @@ The following options can be defined globally: update_every, autodetection_retry
318
| | headers | Additional HTTP headers (one per line as key: value). | | no |
319
| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
320
| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
321
+| **Functions** | functions.top_queries.disabled | Disable the [top-queries](#top-queries) function. | no | no |
322
+| | functions.top_queries.timeout | Query timeout (seconds). Uses collector timeout if not set. | | no |
323
+| | functions.top_queries.limit | Maximum number of queries to return. | 500 | no |
324
| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
325
326
src/go/plugin/go.d/collector/mongodb/integrations/mongodb.md
+3
@@ -389,6 +389,9 @@ The following options can be defined globally: update_every, autodetection_retry
389
| **Target** | uri | MongoDB connection string. See [URI syntax](https://www.mongodb.com/docs/manual/reference/connection-string/). | mongodb://localhost:27017 | yes |
390
| | timeout | Query timeout (seconds). | 1 | no |
391
| **Filters** | databases | Database selector. Defines which databases to collect metrics from. | | no |
392
+| **Functions** | functions.top_queries.disabled | Disable the [top-queries](#top-queries) function. | no | no |
393
+| | functions.top_queries.timeout | Query timeout (seconds). Uses collector timeout if not set. | | no |
394
+| | functions.top_queries.limit | Maximum number of queries to return. | 500 | no |
395
| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
396
397
src/go/plugin/go.d/collector/mssql/integrations/microsoft_sql_server.md
+58
-13
@@ -384,7 +384,7 @@ Aggregated query execution statistics from Query Store runtime views, providing
384
385
### Deadlock Info
386
387
-Retrieves the most recent deadlock event from SQL Server's `system_health` Extended Events ring buffer (`xml_deadlock_report`).
387
+Retrieves the most recent deadlock event from SQL Server's `system_health` Extended Events session (`xml_deadlock_report`).
388
389
The deadlock graph XML is parsed to attribute the deadlock to the participating processes and their query text, lock mode, lock status, and wait resource.
390
@@ -420,7 +420,7 @@ Parsed deadlock participants from the latest detected deadlock event. Each row r
420
|:-------|:-----|:-----|:-----------|:------------|
421
| Row ID | string | | hidden | Unique row identifier composed of deadlock ID and process ID. |
422
| Deadlock ID | string | | | Identifier for the deadlock event, derived from the deadlock timestamp to group participating processes. |
423
-| Timestamp | timestamp | | | Timestamp of the deadlock event from the ring buffer when available; otherwise the function execution time. |
423
+| Timestamp | timestamp | | | Timestamp of the deadlock event from Extended Events when available; otherwise the function execution time. |
424
| Process ID | string | | | Deadlock graph process identifier for the process involved in the deadlock. |
425
| SPID | integer | | | SQL Server session ID (SPID) for the process when available. |
426
| ECID | integer | | | Execution context ID (ECID) for parallel execution contexts when available. |
@@ -436,7 +436,7 @@ Parsed deadlock participants from the latest detected deadlock event. Each row r
436
Retrieves recent SQL errors from a user-managed Extended Events session that captures `sqlserver.error_reported`
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
439
+The session must be created by an administrator and include an `event_file` target. Netdata reads the event file
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
@@ -450,13 +450,43 @@ Use cases:
450
|:-------|:------------|
451
| Name | `Mssql:error-info` |
452
| Require Cloud | yes |
453
-| Performance | Executes on-demand queries against the configured Extended Events ring buffer:<br/>• Not part of regular metric collection<br/>• Overhead is limited to function execution time and XML parsing |
453
+| Performance | Executes on-demand queries against the configured Extended Events event file:<br/>• Not part of regular metric collection<br/>• Overhead is limited to function execution time |
454
| Security | Error messages and query text may include unmasked literal values including sensitive data (PII/secrets):<br/>• Restrict dashboard access to authorized personnel only |
455
-| Availability | Available when:<br/>• The collector has successfully connected to SQL Server<br/>• `error_info_function_enabled` is true<br/>• The Extended Events session exists and has a ring_buffer target<br/>• The account has `VIEW SERVER STATE` permission<br/>• Returns HTTP 200 with empty data when no errors are found<br/>• Returns HTTP 403 when permission is missing<br/>• Returns HTTP 500 if the query fails<br/>• Returns HTTP 503 if the session is not enabled or the function is disabled<br/>• Returns HTTP 504 if the query times out |
455
+| Availability | Available when:<br/>• The collector has successfully connected to SQL Server<br/>• `error_info_function_enabled` is true<br/>• The Extended Events session exists and has an event_file target<br/>• The account has `VIEW SERVER STATE` permission<br/>• Returns HTTP 200 with empty data when no errors are found<br/>• Returns HTTP 403 when permission is missing<br/>• Returns HTTP 500 if the query fails<br/>• Returns HTTP 503 if the session is not enabled or the function is disabled<br/>• Returns HTTP 504 if the query times out |
456
457
#### Prerequisites
458
459
-No additional configuration is required.
459
+##### Create Extended Events session for error capture
460
+
461
+Create an Extended Events session that captures `sqlserver.error_reported` with `sql_text` and `query_hash` actions:
462
+
463
+```sql
464
+-- Create the Extended Events session with event_file target
465
+CREATE EVENT SESSION [netdata_errors] ON SERVER
466
+ADD EVENT sqlserver.error_reported(
467
+ ACTION(sqlserver.sql_text, sqlserver.query_hash)
468
+)
469
+ADD TARGET package0.event_file(SET filename=N'netdata_errors');
470
+GO
471
+
472
+-- Start the session
473
+ALTER EVENT SESSION [netdata_errors] ON SERVER STATE = START;
474
+GO
475
+
476
+-- Grant required permission
477
+GRANT VIEW SERVER STATE TO [netdata_user];
478
+```
479
+
480
+If you use a different session name, set it in the collector config:
481
+
482
+```yaml
483
+jobs:
484
+ - name: local
485
+ dsn: "sqlserver://user:pass@localhost:1433"
486
+ error_info_session_name: your_session_name
487
+```
488
+
489
+
490
491
#### Parameters
492
@@ -554,8 +584,17 @@ The following options can be defined globally: update_every, autodetection_retry
584
| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
585
| **Target** | dsn | SQL Server DSN (Data Source Name). See [DSN syntax](https://github.com/microsoft/go-mssqldb#connection-parameters-and-dsn). | sqlserver://localhost:1433 | yes |
586
| | timeout | Query timeout (seconds). | 5 | no |
557
-| **Query Store** | query_store_function_enabled | Enable the Query Store function to expose top queries via Netdata Functions. **WARNING**: Query Store may contain unmasked literal values (customer names, emails, IDs). Only enable after ensuring proper access controls to the Netdata dashboard. | no | no |
558
-| | query_store_time_window_days | Number of days of Query Store data to analyze. Set to 0 to include all available data. Smaller values improve query performance but show less history. | 7 | no |
587
+| **Functions** | functions.top_queries.disabled | Disable the [top-queries](#top-queries) function. | no | no |
588
+| | functions.top_queries.timeout | Query timeout for top-queries function (seconds). Uses collector timeout if not set. | | no |
589
+| | functions.top_queries.limit | Maximum number of queries to return in the top-queries response. | 500 | no |
590
+| | functions.top_queries.time_window_days | Number of days of Query Store data to analyze. Set to 0 to include all available data. Smaller values improve query performance but show less history. | 7 | no |
591
+| | functions.deadlock_info.disabled | Disable the [deadlock-info](#deadlock-info) function. | no | no |
592
+| | functions.deadlock_info.timeout | Query timeout for deadlock-info function (seconds). Uses collector timeout if not set. | | no |
593
+| | functions.deadlock_info.use_ring_buffer | Use ring_buffer instead of event_file for system_health session.<br/><br/>WARNING: Not recommended for production:<br/>• Data cleared on failover/restart<br/>• 4 MB capacity limit<br/>• High CPU load during queries<br/><br/>Use only for Azure SQL Database without Blob Storage or testing. | no | no |
594
+| | functions.error_info.disabled | Disable the [error-info](#error-info) function. | no | no |
595
+| | functions.error_info.timeout | Query timeout for error-info function (seconds). Uses collector timeout if not set. | | no |
596
+| | functions.error_info.session_name | Extended Events session name capturing error_reported events.<br/>Must be created by administrator with event_file (recommended) or ring_buffer target. | netdata_errors | no |
597
+| | functions.error_info.use_ring_buffer | Use ring_buffer instead of event_file for error events.<br/><br/>WARNING: Not recommended for production:<br/>• Data cleared on failover/restart<br/>• 4 MB capacity limit<br/>• High CPU load during queries<br/><br/>Use only for Azure SQL Database without Blob Storage or testing. | no | no |
598
| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
599
600
@@ -675,12 +714,12 @@ jobs:
714
```
715
</details>
716
678
-###### With Query Store function
717
+###### With custom function settings
718
680
-Enable the Query Store function to view top queries in the Netdata dashboard.
719
+Configure function-specific settings like timeouts and limits.
720
721
> **Warning**: Query Store may contain unmasked literal values (PII).
683
-> Only enable in environments with proper access controls.
722
+> Disable functions if not needed or ensure proper access controls.
723
724
725
<details open><summary>Config</summary>
@@ -689,8 +728,14 @@ Enable the Query Store function to view top queries in the Netdata dashboard.
728
jobs:
729
- name: local
730
dsn: "sqlserver://netdata_user:password@localhost:1433"
692
- query_store_function_enabled: true
693
- query_store_time_window_days: 7
731
+ functions:
732
+ top_queries:
733
+ limit: 100
734
+ time_window_days: 7
735
+ deadlock_info:
736
+ use_ring_buffer: true
737
+ error_info:
738
+ session_name: custom_errors
739
740
```
741
</details>
src/go/plugin/go.d/collector/mysql/integrations/mariadb.md
+7
@@ -547,6 +547,13 @@ The following options can be defined globally: update_every, autodetection_retry
547
| **Target** | dsn | MySQL server DSN (Data Source Name). See [DSN syntax](https://github.com/go-sql-driver/mysql#dsn-data-source-name). | root@tcp(localhost:3306)/ | yes |
548
| | my.cnf | Path to a `my.cnf` file to read connection settings from the `[client]` section. | | no |
549
| | timeout | Query timeout (seconds). | 1 | no |
550
+| **Functions** | functions.top_queries.disabled | Disable the [top-queries](#top-queries) function. | no | no |
551
+| | functions.top_queries.timeout | Query timeout (seconds). Uses collector timeout if not set. | | no |
552
+| | functions.top_queries.limit | Maximum number of queries to return. | 500 | no |
553
+| | functions.deadlock_info.disabled | Disable the [deadlock-info](#deadlock-info) function. | no | no |
554
+| | functions.deadlock_info.timeout | Query timeout (seconds). Uses collector timeout if not set. | | no |
555
+| | functions.error_info.disabled | Disable the [error-info](#error-info) function. | no | no |
556
+| | functions.error_info.timeout | Query timeout (seconds). Uses collector timeout if not set. | | no |
557
| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
558
559
src/go/plugin/go.d/collector/mysql/integrations/mysql.md
+7
@@ -547,6 +547,13 @@ The following options can be defined globally: update_every, autodetection_retry
547
| **Target** | dsn | MySQL server DSN (Data Source Name). See [DSN syntax](https://github.com/go-sql-driver/mysql#dsn-data-source-name). | root@tcp(localhost:3306)/ | yes |
548
| | my.cnf | Path to a `my.cnf` file to read connection settings from the `[client]` section. | | no |
549
| | timeout | Query timeout (seconds). | 1 | no |
550
+| **Functions** | functions.top_queries.disabled | Disable the [top-queries](#top-queries) function. | no | no |
551
+| | functions.top_queries.timeout | Query timeout (seconds). Uses collector timeout if not set. | | no |
552
+| | functions.top_queries.limit | Maximum number of queries to return. | 500 | no |
553
+| | functions.deadlock_info.disabled | Disable the [deadlock-info](#deadlock-info) function. | no | no |
554
+| | functions.deadlock_info.timeout | Query timeout (seconds). Uses collector timeout if not set. | | no |
555
+| | functions.error_info.disabled | Disable the [error-info](#error-info) function. | no | no |
556
+| | functions.error_info.timeout | Query timeout (seconds). Uses collector timeout if not set. | | no |
557
| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
558
559
src/go/plugin/go.d/collector/mysql/integrations/percona_mysql.md
+7
@@ -547,6 +547,13 @@ The following options can be defined globally: update_every, autodetection_retry
547
| **Target** | dsn | MySQL server DSN (Data Source Name). See [DSN syntax](https://github.com/go-sql-driver/mysql#dsn-data-source-name). | root@tcp(localhost:3306)/ | yes |
548
| | my.cnf | Path to a `my.cnf` file to read connection settings from the `[client]` section. | | no |
549
| | timeout | Query timeout (seconds). | 1 | no |
550
+| **Functions** | functions.top_queries.disabled | Disable the [top-queries](#top-queries) function. | no | no |
551
+| | functions.top_queries.timeout | Query timeout (seconds). Uses collector timeout if not set. | | no |
552
+| | functions.top_queries.limit | Maximum number of queries to return. | 500 | no |
553
+| | functions.deadlock_info.disabled | Disable the [deadlock-info](#deadlock-info) function. | no | no |
554
+| | functions.deadlock_info.timeout | Query timeout (seconds). Uses collector timeout if not set. | | no |
555
+| | functions.error_info.disabled | Disable the [error-info](#error-info) function. | no | no |
556
+| | functions.error_info.timeout | Query timeout (seconds). Uses collector timeout if not set. | | no |
557
| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
558
559
src/go/plugin/go.d/collector/oracledb/integrations/oracle_db.md
+6
-1
@@ -362,7 +362,12 @@ The following options can be defined globally: update_every, autodetection_retry
362
| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
363
| **Target** | dsn | Oracle server DSN (Data Source Name). Format: `oracle://username:password@host:port/service?param1=value1&...¶mN=valueN`. | | yes |
364
| | timeout | Query timeout (seconds). | 1 | no |
365
-| **Limits** | top_queries_limit | Maximum number of rows returned by the `top-queries` and `running-queries` functions. | 500 | no |
365
+| **Functions** | functions.top_queries.disabled | Disable the [top-queries](#top-queries) function. | no | no |
366
+| | functions.top_queries.timeout | Query timeout (seconds). Uses collector timeout if not set. | | no |
367
+| | functions.top_queries.limit | Maximum number of queries to return. | 500 | no |
368
+| | functions.running_queries.disabled | Disable the [running-queries](#running-queries) function. | no | no |
369
+| | functions.running_queries.timeout | Query timeout (seconds). Uses collector timeout if not set. | | no |
370
+| | functions.running_queries.limit | Maximum number of queries to return. | 500 | no |
371
| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
372
373
src/go/plugin/go.d/collector/postgres/integrations/postgresql.md
+3
@@ -426,6 +426,9 @@ The following options can be defined globally: update_every, autodetection_retry
426
| **Filters** | collect_databases_matching | Database selector. Controls which databases are included. Uses [simple patterns](https://github.com/netdata/netdata/tree/master/src/go/pkg/matcher#simple-patterns-matcher). | | no |
427
| **Limits** | max_db_tables | Maximum number of tables per database to collect metrics for (0 = no limit). | 50 | no |
428
| | max_db_indexes | Maximum number of indexes per database to collect metrics for (0 = no limit). | 250 | no |
429
+| **Functions** | functions.top_queries.disabled | Disable the [top-queries](#top-queries) function. | no | no |
430
+| | functions.top_queries.timeout | Query timeout (seconds). Uses collector timeout if not set. | | no |
431
+| | functions.top_queries.limit | Maximum number of queries to return. | 500 | no |
432
| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
433
434
src/go/plugin/go.d/collector/proxysql/integrations/proxysql.md
+3
@@ -281,6 +281,9 @@ The following options can be defined globally: update_every, autodetection_retry
281
| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
282
| **Target** | dsn | ProxySQL server DSN (Data Source Name). See [DSN syntax](https://github.com/go-sql-driver/mysql#dsn-data-source-name). | stats:stats@tcp(127.0.0.1:6032)/ | yes |
283
| | timeout | Query timeout (seconds). | 1 | no |
284
+| **Functions** | functions.top_queries.disabled | Disable the [top-queries](#top-queries) function. | no | no |
285
+| | functions.top_queries.timeout | Query timeout (seconds). Uses collector timeout if not set. | | no |
286
+| | functions.top_queries.limit | Maximum number of queries to return. | 500 | no |
287
| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
288
289
src/go/plugin/go.d/collector/redis/integrations/redis.md
+3
@@ -212,6 +212,9 @@ The following options can be defined globally: update_every, autodetection_retry
212
| | tls_ca | Path to CA bundle used to validate the server certificate. | | no |
213
| | tls_cert | Path to client TLS certificate (for mTLS). | | no |
214
| | tls_key | Path to client TLS private key (for mTLS). | | no |
215
+| **Functions** | functions.top_queries.disabled | Disable the [top-queries](#top-queries) function. | no | no |
216
+| | functions.top_queries.timeout | Query timeout (seconds). Uses collector timeout if not set. | | no |
217
+| | functions.top_queries.limit | Maximum number of queries to return. | 500 | no |
218
| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
219
220
src/go/plugin/go.d/collector/rethinkdb/integrations/rethinkdb.md
+3
-1
@@ -214,9 +214,11 @@ The following options can be defined globally: update_every, autodetection_retry
214
| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
215
| **Target** | address | RethinkDB server address (IP:PORT). | 127.0.0.1:28015 | yes |
216
| | timeout | Connection, read, and write timeout duration (seconds). Includes name resolution. | 1 | no |
217
-| **Limits** | top_queries_limit | Maximum number of rows returned by the `running-queries` function. | 500 | no |
217
| **Auth** | username | Username for authentication. | | no |
218
| | password | Password for authentication. | | no |
219
+| **Functions** | functions.running_queries.disabled | Disable the [running-queries](#running-queries) function. | no | no |
220
+| | functions.running_queries.timeout | Timeout for the running-queries function query (seconds). If not set, uses the collector's timeout. | (collector timeout) | no |
221
+| | functions.running_queries.limit | Maximum number of rows returned by the running-queries function. | 500 | no |
222
| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
223
224
src/go/plugin/go.d/collector/yugabytedb/integrations/yugabytedb.md
+9
-4
@@ -523,9 +523,6 @@ The following options can be defined globally: update_every, autodetection_retry
523
| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
524
| **Target** | url | Target endpoint URL. | http://127.0.0.1:7000/prometheus-metrics | yes |
525
| | timeout | HTTP request timeout (seconds). | 1 | no |
526
-| **Query Functions** | dsn | SQL DSN used by `top-queries` and `running-queries` functions. | | no |
527
-| | sql_timeout | SQL query timeout (seconds) for query functions. | 1 | no |
528
-| **Limits** | top_queries_limit | Maximum number of rows returned by the `top-queries` and `running-queries` functions. | 500 | no |
526
| **HTTP Auth** | username | Username for Basic HTTP authentication. | | no |
527
| | password | Password for Basic HTTP authentication. | | no |
528
| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
@@ -541,6 +538,13 @@ The following options can be defined globally: update_every, autodetection_retry
538
| | headers | Additional HTTP headers (one per line as key: value). | | no |
539
| | not_follow_redirects | Do not follow HTTP redirects. | no | no |
540
| | force_http2 | Force HTTP/2 (including h2c over TCP). | no | no |
541
+| **Functions** | functions.dsn | SQL DSN (required for query functions). | | no |
542
+| | functions.top_queries.disabled | Disable the [top-queries](#top-queries) function. | no | no |
543
+| | functions.top_queries.timeout | Query timeout (seconds). Uses collector timeout if not set. | | no |
544
+| | functions.top_queries.limit | Maximum number of queries to return. | 500 | no |
545
+| | functions.running_queries.disabled | Disable the [running-queries](#running-queries) function. | no | no |
546
+| | functions.running_queries.timeout | Query timeout (seconds). Uses collector timeout if not set. | | no |
547
+| | functions.running_queries.limit | Maximum number of queries to return. | 500 | no |
548
| **Virtual Node** | vnode | Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). | | no |
549
550
@@ -607,7 +611,8 @@ Enable SQL query functions (YSQL).
611
jobs:
612
- name: local
613
url: http://127.0.0.1:7000/prometheus-metrics
610
- dsn: postgres://yugabyte@127.0.0.1:5433/yugabyte?sslmode=disable
614
+ functions:
615
+ dsn: postgres://yugabyte@127.0.0.1:5433/yugabyte?sslmode=disable
616
617
```
618
</details>