@cryptotaxi247 / netdata-1 / commits / 68953068b

Regenerate integrations docs (#21611)

Co-authored-by: ilyam8 <22274335+ilyam8@users.noreply.github.com>

Netdata bot committed Jan 22, 2026 at 14:10 UTC 68953068b3987b75c15bceda70833ed8dea94f16

4 files changed +58 -15

src/go/plugin/go.d/collector/cockroachdb/integrations/cockroachdb.md

+26

@@ -25,12 +25,20 @@ Module: cockroachdb

25 This collector monitors CockroachDB servers.

28 +It scrapes Prometheus metrics from the CockroachDB `/_status/vars` endpoint.

29 +

30 +It also provides `top-queries` and `running-queries` functions using SQL statement statistics (`crdb_internal.cluster_statement_statistics`) and `SHOW CLUSTER STATEMENTS`.

33 This collector is supported on all platforms.

35 This collector supports collecting metrics from multiple instances of this integration, including remote instances.

37 +The `top-queries` and `running-queries` functions require:

38 +

39 +- A SQL user with `VIEWACTIVITY` (or `VIEWACTIVITYREDACTED`) privileges.

40 +- Access to `crdb_internal.cluster_statement_statistics` (may require `SET allow_unsafe_internals = on` on newer versions).

41 +

43 ### Default Behavior

@@ -179,6 +187,9 @@ The following options can be defined globally: update_every, autodetection_retry

187 | | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |

188 | **Target** | url | Target endpoint URL. | http://127.0.0.1:8080/_status/vars | yes |

189 | | timeout | HTTP request timeout (seconds). | 1 | no |

190 +| **Query Functions** | dsn | SQL DSN used by `top-queries` and `running-queries` functions. | | no |

191 +| | sql_timeout | SQL query timeout (seconds) for query functions. | 1 | no |

192 +| **Limits** | top_queries_limit | Maximum number of rows returned by the `top-queries` and `running-queries` functions. | 500 | no |

194 | | password | Password for Basic HTTP authentication. | | no |

195 | | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |

@@ -251,6 +262,21 @@ jobs:

262 ```

263 </details>

264

265 +###### Top queries

266 +

267 +Enable SQL query functions.

268 +

269 +<details open><summary>Config</summary>

270 +

271 +```yaml

272 +jobs:

273 + - name: local

274 + url: http://127.0.0.1:8080/_status/vars

275 + dsn: postgres://root@127.0.0.1:26257/defaultdb?sslmode=disable

276 +

277 +```

278 +</details>

279 +

280 ###### HTTP authentication

281

282 Local server with basic HTTP authentication.

src/go/plugin/go.d/collector/oracledb/integrations/oracle_db.md

+6 -15

@@ -24,21 +24,6 @@ Module: oracledb

25 This collector monitors the health and performance of Oracle DB servers and collects general statistics, replication and user metrics.

27 -## Functions

28 -

29 -This collector provides the following function methods (useful in the Netdata Functions UI):

30 -

31 -- `top-queries`: Top SQL statements from `V$SQLSTATS` (sorted by a selected metric).

32 -- `running-queries`: Currently running SQL statements from `V$SESSION`.

33 -

34 -**Note:** Query text may contain unmasked literals (potential PII).

35 -Ensure access controls on the Netdata dashboard are appropriate.

36 -

37 -### Required privileges for functions

38 -

39 -The database user must be able to read `V$SQLSTATS` and `V$SESSION`.

40 -Grant `SELECT_CATALOG_ROLE` or explicit `SELECT` on these views.

41 -

28 It establishes a connection to the Oracle DB instance via a TCP or UNIX socket and extracts metrics from the following database tables:

@@ -53,6 +38,8 @@ It establishes a connection to the Oracle DB instance via a TCP or UNIX socket a

38 - `dba_tablespaces`

39 - `v$temp_space_header`

41 +It also provides `top-queries` and `running-queries` functions using `V$SQLSTATS` and `V$SESSION`.

42 +

44 This collector is supported on all platforms.

@@ -186,6 +173,8 @@ GRANT CONNECT TO netdata;

173 GRANT SELECT_CATALOG_ROLE TO netdata;

174 ```

175

176 +The `top-queries` and `running-queries` functions require access to `V$SQLSTATS` and `V$SESSION`.

177 +

178

179

180 ### Configuration

@@ -205,6 +194,7 @@ The following options can be defined globally: update_every, autodetection_retry

194 | | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |

195 | **Target** | dsn | Oracle server DSN (Data Source Name). Format: `oracle://username:password@host:port/service?param1=value1&...&paramN=valueN`. | | yes |

196 | | timeout | Query timeout (seconds). | 1 | no |

197 +| **Limits** | top_queries_limit | Maximum number of rows returned by the `top-queries` and `running-queries` functions. | 500 | no |

199

200

@@ -365,3 +355,4 @@ If your Netdata runs in a Docker container named "netdata" (replace if different

355 docker logs netdata 2>&1 | grep oracledb

356 ```

357

358 +

src/go/plugin/go.d/collector/rethinkdb/integrations/rethinkdb.md

@@ -27,6 +27,7 @@ For each server, it offers similar metrics.

29 The data is gathered by querying the stats table in RethinkDB, which stores real-time statistics related to the cluster and its individual servers.

30 +It also provides a `running-queries` function using the `rethinkdb.jobs` system table (admin-only).

33 This collector is supported on all platforms.

@@ -139,6 +140,7 @@ The following options can be defined globally: update_every, autodetection_retry

140 | | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |

141 | **Target** | address | RethinkDB server address (IP:PORT). | 127.0.0.1:28015 | yes |

142 | | timeout | Connection, read, and write timeout duration (seconds). Includes name resolution. | 1 | no |

143 +| **Limits** | top_queries_limit | Maximum number of rows returned by the `running-queries` function. | 500 | no |

145 | | password | Password for authentication. | | no |

src/go/plugin/go.d/collector/yugabytedb/integrations/yugabytedb.md

+24

@@ -27,11 +27,17 @@ This collector monitors the activity and performance of YugabyteDB servers.

28 It sends HTTP requests to the YugabyteDB [metric endpoints](https://docs.yugabyte.com/preview/launch-and-manage/monitor-and-alert/metrics/#metric-endpoints).

30 +It also provides `top-queries` and `running-queries` functions using `pg_stat_statements` and `pg_stat_activity` from YSQL.

31 +

33 This collector is supported on all platforms.

35 This collector supports collecting metrics from multiple instances of this integration, including remote instances.

37 +The `top-queries` function requires the `pg_stat_statements` extension to be installed in the target database.

38 +

39 +Viewing all running queries via `pg_stat_activity` may require elevated privileges (e.g., `pg_read_all_stats`).

40 +

42 ### Default Behavior

@@ -370,6 +376,9 @@ The following options can be defined globally: update_every, autodetection_retry

376 | | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |

377 | **Target** | url | Target endpoint URL. | http://127.0.0.1:7000/prometheus-metrics | yes |

378 | | timeout | HTTP request timeout (seconds). | 1 | no |

379 +| **Query Functions** | dsn | SQL DSN used by `top-queries` and `running-queries` functions. | | no |

380 +| | sql_timeout | SQL query timeout (seconds) for query functions. | 1 | no |

381 +| **Limits** | top_queries_limit | Maximum number of rows returned by the `top-queries` and `running-queries` functions. | 500 | no |

383 | | password | Password for Basic HTTP authentication. | | no |

384 | | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |

@@ -441,6 +450,21 @@ jobs:

450 # url: http://127.0.0.1:13000/prometheus-metrics # YSQL

451

452 ```

453 +###### Top queries

454 +

455 +Enable SQL query functions (YSQL).

456 +

457 +<details open><summary>Config</summary>

458 +

459 +```yaml

460 +jobs:

461 + - name: local

462 + url: http://127.0.0.1:7000/prometheus-metrics

463 + dsn: postgres://yugabyte@127.0.0.1:5433/yugabyte?sslmode=disable

464 +

465 +```

466 +</details>

467 +

468 ###### HTTP authentication

469

470 Basic HTTP authentication.