Regenerate integrations docs (#21620)
Co-authored-by: ilyam8 <22274335+ilyam8@users.noreply.github.com>
Netdata bot committed
Jan 23, 2026 at 07:25 UTC
c4a36fe365ff7cf4e5dc4ecf938d042643146243
17 files changed
+1039
src/go/plugin/go.d/collector/clickhouse/integrations/clickhouse.md
+48
@@ -171,6 +171,54 @@ Metrics:
171
172
173
174
+## Functions
175
+
176
+This collector exposes real-time functions for interactive troubleshooting in the Top tab.
177
+
178
+
179
+### Top Queries
180
+
181
+| Aspect | Description |
182
+|:-------|:------------|
183
+| Name | `Clickhouse:top-queries` |
184
+| Summary | Top SQL queries from ClickHouse system.query_log. |
185
+| Behavior | Queries system.query_log, aggregates by query, and returns the top entries sorted by the selected column. |
186
+| Performance | Uses system.query_log and can be expensive on busy systems. Use limits to control response size. |
187
+| Security | Query text may include sensitive literals depending on server settings. |
188
+| Requirements | Requires access to system.query_log on the target ClickHouse instance. |
189
+| Availability | Available when the collector can query system tables; returns 503 if system.query_log is not available. |
190
+
191
+#### Parameters
192
+
193
+| Parameter | Type | Description | Required | Default | Options |
194
+|:---------|:-----|:------------|:--------:|:--------|:--------|
195
+| Filter By | select | Select the primary sort column (options are derived from sortable columns in the response). | yes | totalTime | |
196
+
197
+#### Returns
198
+
199
+Aggregated query statistics from system.query_log.
200
+
201
+| Column | Type | Description |
202
+|:-------|:-----|:------------|
203
+| Query ID | string | |
204
+| Query | string | |
205
+| Database | string | |
206
+| User | string | |
207
+| Calls | integer | |
208
+| Total Time | duration | |
209
+| Avg Time | duration | |
210
+| Min Time | duration | |
211
+| Max Time | duration | |
212
+| Read Rows | integer | |
213
+| Read Bytes | integer | |
214
+| Written Rows | integer | |
215
+| Written Bytes | integer | |
216
+| Result Rows | integer | |
217
+| Result Bytes | integer | |
218
+| Max Memory | float | |
219
+
220
+
221
+
222
## Alerts
223
224
src/go/plugin/go.d/collector/cockroachdb/integrations/cockroachdb.md
+88
@@ -135,6 +135,94 @@ Metrics:
135
136
137
138
+## Functions
139
+
140
+This collector exposes real-time functions for interactive troubleshooting in the Top tab.
141
+
142
+
143
+### Top Queries
144
+
145
+| Aspect | Description |
146
+|:-------|:------------|
147
+| Name | `Cockroachdb:top-queries` |
148
+| Summary | Top SQL statements from crdb_internal.cluster_statement_statistics. |
149
+| Behavior | Queries crdb_internal.cluster_statement_statistics and returns the top entries sorted by the selected column. |
150
+| Performance | Executes SQL queries against system tables and may be expensive on busy clusters. |
151
+| Security | Query text may contain unmasked literals (potential PII). |
152
+| Requirements | Requires a SQL user with VIEWACTIVITY (or VIEWACTIVITYREDACTED) and access to crdb_internal.cluster_statement_statistics. |
153
+| Availability | Requires SQL DSN configuration and access to system tables; returns errors if DSN is missing or SQL is unavailable. |
154
+
155
+#### Parameters
156
+
157
+| Parameter | Type | Description | Required | Default | Options |
158
+|:---------|:-----|:------------|:--------:|:--------|:--------|
159
+| Filter By | select | Select the primary sort column (options are derived from sortable columns in the response). | yes | totalTime | |
160
+
161
+#### Returns
162
+
163
+Aggregated SQL statement statistics.
164
+
165
+| Column | Type | Description |
166
+|:-------|:-----|:------------|
167
+| Fingerprint ID | string | |
168
+| Query | string | |
169
+| Database | string | |
170
+| Application | string | |
171
+| Statement Type | string | |
172
+| Distributed | string | |
173
+| Full Scan | string | |
174
+| Implicit Txn | string | |
175
+| Vectorized | string | |
176
+| Executions | integer | |
177
+| Total Time | duration | |
178
+| Mean Time | duration | |
179
+| Run Time | duration | |
180
+| Plan Time | duration | |
181
+| Parse Time | duration | |
182
+| Rows Read | integer | |
183
+| Rows Written | integer | |
184
+| Rows Returned | integer | |
185
+| Bytes Read | integer | |
186
+| Max Retries | integer | |
187
+
188
+### Running Queries
189
+
190
+| Aspect | Description |
191
+|:-------|:------------|
192
+| Name | `Cockroachdb:running-queries` |
193
+| Summary | Currently running SQL statements from SHOW CLUSTER STATEMENTS. |
194
+| Behavior | Queries SHOW CLUSTER STATEMENTS and returns running statements sorted by the selected column. |
195
+| Performance | Executes SQL queries against system tables and may be expensive on busy clusters. |
196
+| Security | Query text may contain unmasked literals (potential PII). |
197
+| Requirements | Requires a SQL user with VIEWACTIVITY (or VIEWACTIVITYREDACTED) and access to system tables. |
198
+| Availability | Requires SQL DSN configuration and access to system tables; returns errors if DSN is missing or SQL is unavailable. |
199
+
200
+#### Parameters
201
+
202
+| Parameter | Type | Description | Required | Default | Options |
203
+|:---------|:-----|:------------|:--------:|:--------|:--------|
204
+| Filter By | select | Select the primary sort column (options are derived from sortable columns in the response). | yes | elapsedMs | |
205
+
206
+#### Returns
207
+
208
+Snapshot of currently running SQL statements.
209
+
210
+| Column | Type | Description |
211
+|:-------|:-----|:------------|
212
+| Query ID | string | |
213
+| Query | string | |
214
+| User | string | |
215
+| Application | string | |
216
+| Client Address | string | |
217
+| Node ID | string | |
218
+| Session ID | string | |
219
+| Phase | string | |
220
+| Distributed | string | |
221
+| Start Time | string | |
222
+| Elapsed | duration | |
223
+
224
+
225
+
226
## Alerts
227
228
src/go/plugin/go.d/collector/couchbase/integrations/couchbase.md
+43
@@ -75,6 +75,49 @@ Metrics:
75
76
77
78
+## Functions
79
+
80
+This collector exposes real-time functions for interactive troubleshooting in the Top tab.
81
+
82
+
83
+### Top Queries
84
+
85
+| Aspect | Description |
86
+|:-------|:------------|
87
+| Name | `Couchbase:top-queries` |
88
+| Summary | Top N1QL requests from system:completed_requests. |
89
+| Behavior | Queries the system:completed_requests keyspace and returns the top entries sorted by the selected column. |
90
+| Performance | Runs N1QL queries against system keyspaces; use top_queries_limit to control response size. |
91
+| Security | Query text may include sensitive literals depending on workload. |
92
+| Requirements | Requires access to the system:completed_requests keyspace and N1QL service. |
93
+| Availability | Available when the collector can query system keyspaces; returns 503 until the collector is initialized. |
94
+
95
+#### Parameters
96
+
97
+| Parameter | Type | Description | Required | Default | Options |
98
+|:---------|:-----|:------------|:--------:|:--------|:--------|
99
+| Filter By | select | Select the primary sort column (options are derived from sortable columns in the response). | yes | elapsedTime | |
100
+
101
+#### Returns
102
+
103
+Completed N1QL request statistics.
104
+
105
+| Column | Type | Description |
106
+|:-------|:-----|:------------|
107
+| Request ID | string | |
108
+| Request Time | timestamp | |
109
+| Statement | string | |
110
+| Elapsed Time | duration | |
111
+| Service Time | duration | |
112
+| Result Count | integer | |
113
+| Result Size | integer | |
114
+| Error Count | integer | |
115
+| Warning Count | integer | |
116
+| User | string | |
117
+| Client Context ID | string | |
118
+
119
+
120
+
121
## Alerts
122
123
There are no alerts configured by default for this integration.
src/go/plugin/go.d/collector/elasticsearch/integrations/elasticsearch.md
+42
@@ -166,6 +166,48 @@ Metrics:
166
167
168
169
+## Functions
170
+
171
+This collector exposes real-time functions for interactive troubleshooting in the Top tab.
172
+
173
+
174
+### Top Queries
175
+
176
+| Aspect | Description |
177
+|:-------|:------------|
178
+| Name | `Elasticsearch:top-queries` |
179
+| Summary | Running queries from the Elasticsearch Tasks API. |
180
+| Behavior | Calls the Tasks API and returns running task details sorted by the selected column. |
181
+| Performance | Queries the Tasks API; on large clusters this may return many rows. |
182
+| Security | Task descriptions may include query details. |
183
+| Requirements | Requires access to the Tasks API on the target Elasticsearch node. |
184
+| Availability | Available when the collector can query the Tasks API; returns 503 until the collector is initialized. |
185
+
186
+#### Parameters
187
+
188
+| Parameter | Type | Description | Required | Default | Options |
189
+|:---------|:-----|:------------|:--------:|:--------|:--------|
190
+| Filter By | select | Select the primary sort column (options are derived from sortable columns in the response). | yes | runningTime | |
191
+
192
+#### Returns
193
+
194
+Snapshot of running tasks from the Tasks API.
195
+
196
+| Column | Type | Description |
197
+|:-------|:-----|:------------|
198
+| Task ID | string | |
199
+| Node ID | string | |
200
+| Node Name | string | |
201
+| Action | string | |
202
+| Type | string | |
203
+| Description | string | |
204
+| Start Time | timestamp | |
205
+| Running Time | duration | |
206
+| Cancellable | boolean | |
207
+| Cancelled | boolean | |
208
+
209
+
210
+
211
## Alerts
212
213
src/go/plugin/go.d/collector/elasticsearch/integrations/opensearch.md
+42
@@ -166,6 +166,48 @@ Metrics:
166
167
168
169
+## Functions
170
+
171
+This collector exposes real-time functions for interactive troubleshooting in the Top tab.
172
+
173
+
174
+### Top Queries
175
+
176
+| Aspect | Description |
177
+|:-------|:------------|
178
+| Name | `Elasticsearch:top-queries` |
179
+| Summary | Running queries from the Elasticsearch Tasks API. |
180
+| Behavior | Calls the Tasks API and returns running task details sorted by the selected column. |
181
+| Performance | Queries the Tasks API; on large clusters this may return many rows. |
182
+| Security | Task descriptions may include query details. |
183
+| Requirements | Requires access to the Tasks API on the target Elasticsearch node. |
184
+| Availability | Available when the collector can query the Tasks API; returns 503 until the collector is initialized. |
185
+
186
+#### Parameters
187
+
188
+| Parameter | Type | Description | Required | Default | Options |
189
+|:---------|:-----|:------------|:--------:|:--------|:--------|
190
+| Filter By | select | Select the primary sort column (options are derived from sortable columns in the response). | yes | runningTime | |
191
+
192
+#### Returns
193
+
194
+Snapshot of running tasks from the Tasks API.
195
+
196
+| Column | Type | Description |
197
+|:-------|:-----|:------------|
198
+| Task ID | string | |
199
+| Node ID | string | |
200
+| Node Name | string | |
201
+| Action | string | |
202
+| Type | string | |
203
+| Description | string | |
204
+| Start Time | timestamp | |
205
+| Running Time | duration | |
206
+| Cancellable | boolean | |
207
+| Cancelled | boolean | |
208
+
209
+
210
+
211
## Alerts
212
213
src/go/plugin/go.d/collector/mongodb/integrations/mongodb.md
+60
@@ -205,6 +205,66 @@ Metrics:
205
206
207
208
+## Functions
209
+
210
+This collector exposes real-time functions for interactive troubleshooting in the Top tab.
211
+
212
+
213
+### Top Queries
214
+
215
+| Aspect | Description |
216
+|:-------|:------------|
217
+| Name | `Mongodb:top-queries` |
218
+| Summary | Top queries from MongoDB Profiler (system.profile). WARNING: Query text may contain unmasked literals (potential PII). |
219
+| Behavior | Reads from system.profile and returns the top profiled queries sorted by the selected column. |
220
+| Performance | Requires profiling and reads from system.profile; may add load on busy systems. |
221
+| Security | Query text may contain unmasked literals (potential PII). |
222
+| Requirements | Requires MongoDB profiling enabled on target databases and top_queries_function_enabled set to true. |
223
+| Availability | Available when profiling is enabled and the collector is initialized; returns 403 if disabled in config. |
224
+
225
+#### Parameters
226
+
227
+| Parameter | Type | Description | Required | Default | Options |
228
+|:---------|:-----|:------------|:--------:|:--------|:--------|
229
+| Filter By | select | Select the primary sort column (options are derived from sortable columns in the response). | yes | execution_time | |
230
+
231
+#### Returns
232
+
233
+Profiled query statistics from system.profile.
234
+
235
+| Column | Type | Description |
236
+|:-------|:-----|:------------|
237
+| Timestamp | timestamp | |
238
+| Namespace | string | |
239
+| Operation | string | |
240
+| Query | string | |
241
+| Execution Time | duration | |
242
+| Docs Examined | integer | |
243
+| Keys Examined | integer | |
244
+| Docs Returned | integer | |
245
+| Plan Summary | string | |
246
+| Client | string | |
247
+| User | string | |
248
+| Docs Deleted | integer | |
249
+| Docs Inserted | integer | |
250
+| Docs Modified | integer | |
251
+| Response Length | integer | |
252
+| Num Yield | integer | |
253
+| App Name | string | |
254
+| Cursor Exhausted | string | |
255
+| Has Sort Stage | string | |
256
+| Uses Disk | string | |
257
+| From Multi Planner | string | |
258
+| Replanned | string | |
259
+| Query Hash | string | |
260
+| Plan Cache Key | string | |
261
+| Planning Time | duration | |
262
+| CPU Time | duration | |
263
+| Query Framework | string | |
264
+| Query Shape Hash | string | |
265
+
266
+
267
+
268
## Alerts
269
270
There are no alerts configured by default for this integration.
src/go/plugin/go.d/collector/mssql/integrations/microsoft_sql_server.md
+92
@@ -234,6 +234,98 @@ Metrics:
234
235
236
237
+## Functions
238
+
239
+This collector exposes real-time functions for interactive troubleshooting in the Top tab.
240
+
241
+
242
+### Top Queries
243
+
244
+| Aspect | Description |
245
+|:-------|:------------|
246
+| Name | `Mssql:top-queries` |
247
+| Summary | Top SQL queries from Query Store. |
248
+| Behavior | Queries Query Store runtime statistics and returns the top entries sorted by the selected column. |
249
+| Performance | Uses Query Store and can be expensive on busy instances. |
250
+| Security | Query Store may contain unmasked literals (potential PII). |
251
+| Requirements | Requires Query Store enabled and query_store_function_enabled set to true. |
252
+| Availability | Available when Query Store is enabled and the collector is initialized; returns 403 if disabled in config. |
253
+
254
+#### Parameters
255
+
256
+| Parameter | Type | Description | Required | Default | Options |
257
+|:---------|:-----|:------------|:--------:|:--------|:--------|
258
+| Filter By | select | Select the primary sort column (options are derived from sortable columns in the response). | yes | totalTime | |
259
+
260
+#### Returns
261
+
262
+Query Store statistics for top queries.
263
+
264
+| Column | Type | Description |
265
+|:-------|:-----|:------------|
266
+| Query Hash | string | |
267
+| Query | string | |
268
+| Database | string | |
269
+| Calls | integer | |
270
+| Total Time | duration | |
271
+| Avg Time | duration | |
272
+| Last Time | duration | |
273
+| Min Time | duration | |
274
+| Max Time | duration | |
275
+| StdDev Time | duration | |
276
+| Avg CPU | duration | |
277
+| Last CPU | duration | |
278
+| Min CPU | duration | |
279
+| Max CPU | duration | |
280
+| StdDev CPU | duration | |
281
+| Avg Logical Reads | float | |
282
+| Last Logical Reads | integer | |
283
+| Min Logical Reads | integer | |
284
+| Max Logical Reads | integer | |
285
+| StdDev Logical Reads | float | |
286
+| Avg Logical Writes | float | |
287
+| Last Logical Writes | integer | |
288
+| Min Logical Writes | integer | |
289
+| Max Logical Writes | integer | |
290
+| StdDev Logical Writes | float | |
291
+| Avg Physical Reads | float | |
292
+| Last Physical Reads | integer | |
293
+| Min Physical Reads | integer | |
294
+| Max Physical Reads | integer | |
295
+| StdDev Physical Reads | float | |
296
+| Avg CLR Time | duration | |
297
+| Last CLR Time | duration | |
298
+| Min CLR Time | duration | |
299
+| Max CLR Time | duration | |
300
+| StdDev CLR Time | duration | |
301
+| Avg DOP | float | |
302
+| Last DOP | integer | |
303
+| Min DOP | integer | |
304
+| Max DOP | integer | |
305
+| StdDev DOP | float | |
306
+| Avg Memory (8KB pages) | float | |
307
+| Last Memory (8KB pages) | integer | |
308
+| Min Memory (8KB pages) | integer | |
309
+| Max Memory (8KB pages) | integer | |
310
+| StdDev Memory | float | |
311
+| Avg Rows | float | |
312
+| Last Rows | integer | |
313
+| Min Rows | integer | |
314
+| Max Rows | integer | |
315
+| StdDev Rows | float | |
316
+| Avg Log Bytes | float | |
317
+| Last Log Bytes | integer | |
318
+| Min Log Bytes | integer | |
319
+| Max Log Bytes | integer | |
320
+| StdDev Log Bytes | float | |
321
+| Avg TempDB (8KB pages) | float | |
322
+| Last TempDB (8KB pages) | integer | |
323
+| Min TempDB (8KB pages) | integer | |
324
+| Max TempDB (8KB pages) | integer | |
325
+| StdDev TempDB | float | |
326
+
327
+
328
+
329
## Alerts
330
331
There are no alerts configured by default for this integration.
src/go/plugin/go.d/collector/mysql/integrations/mariadb.md
+70
@@ -183,6 +183,76 @@ Metrics:
183
184
185
186
+## Functions
187
+
188
+This collector exposes real-time functions for interactive troubleshooting in the Top tab.
189
+
190
+
191
+### Top Queries
192
+
193
+| Aspect | Description |
194
+|:-------|:------------|
195
+| Name | `Mysql:top-queries` |
196
+| Summary | Top SQL queries from performance_schema. |
197
+| Behavior | Reads performance_schema statement digest tables and returns the top entries sorted by the selected column. |
198
+| Performance | Requires performance_schema and can be expensive on busy servers. |
199
+| Security | Query text may contain unmasked literals (potential PII). |
200
+| Requirements | Requires performance_schema enabled and access to events_statements_summary_by_digest. |
201
+| Availability | Available when performance_schema tables are accessible and the collector is initialized. |
202
+
203
+#### Parameters
204
+
205
+| Parameter | Type | Description | Required | Default | Options |
206
+|:---------|:-----|:------------|:--------:|:--------|:--------|
207
+| Filter By | select | Select the primary sort column (options are derived from sortable columns in the response). | yes | totalTime | |
208
+
209
+#### Returns
210
+
211
+Aggregated statement statistics from performance_schema.
212
+
213
+| Column | Type | Description |
214
+|:-------|:-----|:------------|
215
+| Digest | string | |
216
+| Query | string | |
217
+| Schema | string | |
218
+| Calls | integer | |
219
+| Total Time | duration | |
220
+| Min Time | duration | |
221
+| Avg Time | duration | |
222
+| Max Time | duration | |
223
+| Lock Time | duration | |
224
+| Errors | integer | |
225
+| Warnings | integer | |
226
+| Rows Affected | integer | |
227
+| Rows Sent | integer | |
228
+| Rows Examined | integer | |
229
+| Temp Disk Tables | integer | |
230
+| Temp Tables | integer | |
231
+| Full Joins | integer | |
232
+| Full Range Joins | integer | |
233
+| Select Range | integer | |
234
+| Select Range Check | integer | |
235
+| Select Scan | integer | |
236
+| Sort Merge Passes | integer | |
237
+| Sort Range | integer | |
238
+| Sort Rows | integer | |
239
+| Sort Scan | integer | |
240
+| No Index Used | integer | |
241
+| No Good Index Used | integer | |
242
+| First Seen | string | |
243
+| Last Seen | string | |
244
+| P95 Time | duration | |
245
+| P99 Time | duration | |
246
+| P99.9 Time | duration | |
247
+| Sample Query | string | |
248
+| Sample Seen | string | |
249
+| Sample Time | duration | |
250
+| CPU Time | duration | |
251
+| Max Controlled Memory | integer | |
252
+| Max Total Memory | integer | |
253
+
254
+
255
+
256
## Alerts
257
258
src/go/plugin/go.d/collector/mysql/integrations/mysql.md
+70
@@ -183,6 +183,76 @@ Metrics:
183
184
185
186
+## Functions
187
+
188
+This collector exposes real-time functions for interactive troubleshooting in the Top tab.
189
+
190
+
191
+### Top Queries
192
+
193
+| Aspect | Description |
194
+|:-------|:------------|
195
+| Name | `Mysql:top-queries` |
196
+| Summary | Top SQL queries from performance_schema. |
197
+| Behavior | Reads performance_schema statement digest tables and returns the top entries sorted by the selected column. |
198
+| Performance | Requires performance_schema and can be expensive on busy servers. |
199
+| Security | Query text may contain unmasked literals (potential PII). |
200
+| Requirements | Requires performance_schema enabled and access to events_statements_summary_by_digest. |
201
+| Availability | Available when performance_schema tables are accessible and the collector is initialized. |
202
+
203
+#### Parameters
204
+
205
+| Parameter | Type | Description | Required | Default | Options |
206
+|:---------|:-----|:------------|:--------:|:--------|:--------|
207
+| Filter By | select | Select the primary sort column (options are derived from sortable columns in the response). | yes | totalTime | |
208
+
209
+#### Returns
210
+
211
+Aggregated statement statistics from performance_schema.
212
+
213
+| Column | Type | Description |
214
+|:-------|:-----|:------------|
215
+| Digest | string | |
216
+| Query | string | |
217
+| Schema | string | |
218
+| Calls | integer | |
219
+| Total Time | duration | |
220
+| Min Time | duration | |
221
+| Avg Time | duration | |
222
+| Max Time | duration | |
223
+| Lock Time | duration | |
224
+| Errors | integer | |
225
+| Warnings | integer | |
226
+| Rows Affected | integer | |
227
+| Rows Sent | integer | |
228
+| Rows Examined | integer | |
229
+| Temp Disk Tables | integer | |
230
+| Temp Tables | integer | |
231
+| Full Joins | integer | |
232
+| Full Range Joins | integer | |
233
+| Select Range | integer | |
234
+| Select Range Check | integer | |
235
+| Select Scan | integer | |
236
+| Sort Merge Passes | integer | |
237
+| Sort Range | integer | |
238
+| Sort Rows | integer | |
239
+| Sort Scan | integer | |
240
+| No Index Used | integer | |
241
+| No Good Index Used | integer | |
242
+| First Seen | string | |
243
+| Last Seen | string | |
244
+| P95 Time | duration | |
245
+| P99 Time | duration | |
246
+| P99.9 Time | duration | |
247
+| Sample Query | string | |
248
+| Sample Seen | string | |
249
+| Sample Time | duration | |
250
+| CPU Time | duration | |
251
+| Max Controlled Memory | integer | |
252
+| Max Total Memory | integer | |
253
+
254
+
255
+
256
## Alerts
257
258
src/go/plugin/go.d/collector/mysql/integrations/percona_mysql.md
+70
@@ -183,6 +183,76 @@ Metrics:
183
184
185
186
+## Functions
187
+
188
+This collector exposes real-time functions for interactive troubleshooting in the Top tab.
189
+
190
+
191
+### Top Queries
192
+
193
+| Aspect | Description |
194
+|:-------|:------------|
195
+| Name | `Mysql:top-queries` |
196
+| Summary | Top SQL queries from performance_schema. |
197
+| Behavior | Reads performance_schema statement digest tables and returns the top entries sorted by the selected column. |
198
+| Performance | Requires performance_schema and can be expensive on busy servers. |
199
+| Security | Query text may contain unmasked literals (potential PII). |
200
+| Requirements | Requires performance_schema enabled and access to events_statements_summary_by_digest. |
201
+| Availability | Available when performance_schema tables are accessible and the collector is initialized. |
202
+
203
+#### Parameters
204
+
205
+| Parameter | Type | Description | Required | Default | Options |
206
+|:---------|:-----|:------------|:--------:|:--------|:--------|
207
+| Filter By | select | Select the primary sort column (options are derived from sortable columns in the response). | yes | totalTime | |
208
+
209
+#### Returns
210
+
211
+Aggregated statement statistics from performance_schema.
212
+
213
+| Column | Type | Description |
214
+|:-------|:-----|:------------|
215
+| Digest | string | |
216
+| Query | string | |
217
+| Schema | string | |
218
+| Calls | integer | |
219
+| Total Time | duration | |
220
+| Min Time | duration | |
221
+| Avg Time | duration | |
222
+| Max Time | duration | |
223
+| Lock Time | duration | |
224
+| Errors | integer | |
225
+| Warnings | integer | |
226
+| Rows Affected | integer | |
227
+| Rows Sent | integer | |
228
+| Rows Examined | integer | |
229
+| Temp Disk Tables | integer | |
230
+| Temp Tables | integer | |
231
+| Full Joins | integer | |
232
+| Full Range Joins | integer | |
233
+| Select Range | integer | |
234
+| Select Range Check | integer | |
235
+| Select Scan | integer | |
236
+| Sort Merge Passes | integer | |
237
+| Sort Range | integer | |
238
+| Sort Rows | integer | |
239
+| Sort Scan | integer | |
240
+| No Index Used | integer | |
241
+| No Good Index Used | integer | |
242
+| First Seen | string | |
243
+| Last Seen | string | |
244
+| P95 Time | duration | |
245
+| P99 Time | duration | |
246
+| P99.9 Time | duration | |
247
+| Sample Query | string | |
248
+| Sample Seen | string | |
249
+| Sample Time | duration | |
250
+| CPU Time | duration | |
251
+| Max Controlled Memory | integer | |
252
+| Max Total Memory | integer | |
253
+
254
+
255
+
256
## Alerts
257
258
src/go/plugin/go.d/collector/oracledb/integrations/oracle_db.md
+83
@@ -136,6 +136,89 @@ Metrics:
136
137
138
139
+## Functions
140
+
141
+This collector exposes real-time functions for interactive troubleshooting in the Top tab.
142
+
143
+
144
+### Top Queries
145
+
146
+| Aspect | Description |
147
+|:-------|:------------|
148
+| Name | `Oracledb:top-queries` |
149
+| Summary | Top SQL statements from V$SQLSTATS. WARNING: Query text may contain unmasked literals (potential PII). |
150
+| Behavior | Queries V$SQLSTATS and returns the top entries sorted by the selected column. |
151
+| Performance | Queries system views and may be expensive on busy databases. |
152
+| Security | Query text may contain unmasked literals (potential PII). |
153
+| Requirements | Requires access to V$SQLSTATS and a working SQL connection. |
154
+| Availability | Available when the collector can query Oracle system views; returns errors if SQL is unavailable. |
155
+
156
+#### Parameters
157
+
158
+| Parameter | Type | Description | Required | Default | Options |
159
+|:---------|:-----|:------------|:--------:|:--------|:--------|
160
+| Filter By | select | Select the primary sort column (options are derived from sortable columns in the response). | yes | totalTime | |
161
+
162
+#### Returns
163
+
164
+Aggregated SQL statistics from V$SQLSTATS.
165
+
166
+| Column | Type | Description |
167
+|:-------|:-----|:------------|
168
+| SQL ID | string | |
169
+| Query | string | |
170
+| Schema | string | |
171
+| Executions | integer | |
172
+| Total Time | duration | |
173
+| Avg Time | duration | |
174
+| CPU Time | duration | |
175
+| Buffer Gets | integer | |
176
+| Disk Reads | integer | |
177
+| Rows Processed | integer | |
178
+| Parse Calls | integer | |
179
+| Module | string | |
180
+| Action | string | |
181
+| Last Active | string | |
182
+
183
+### Running Queries
184
+
185
+| Aspect | Description |
186
+|:-------|:------------|
187
+| Name | `Oracledb:running-queries` |
188
+| Summary | Currently running SQL statements from V$SESSION. WARNING: Query text may contain unmasked literals (potential PII). |
189
+| Behavior | Queries V$SESSION and returns running statements sorted by the selected column. |
190
+| Performance | Queries system views and may be expensive on busy databases. |
191
+| Security | Query text may contain unmasked literals (potential PII). |
192
+| Requirements | Requires access to V$SESSION and a working SQL connection. |
193
+| Availability | Available when the collector can query Oracle system views; returns errors if SQL is unavailable. |
194
+
195
+#### Parameters
196
+
197
+| Parameter | Type | Description | Required | Default | Options |
198
+|:---------|:-----|:------------|:--------:|:--------|:--------|
199
+| Filter By | select | Select the primary sort column (options are derived from sortable columns in the response). | yes | lastCallMs | |
200
+
201
+#### Returns
202
+
203
+Snapshot of currently running SQL sessions.
204
+
205
+| Column | Type | Description |
206
+|:-------|:-----|:------------|
207
+| Session | string | |
208
+| User | string | |
209
+| Status | string | |
210
+| Type | string | |
211
+| SQL ID | string | |
212
+| Query | string | |
213
+| Elapsed | duration | |
214
+| SQL Exec Start | string | |
215
+| Module | string | |
216
+| Action | string | |
217
+| Program | string | |
218
+| Machine | string | |
219
+
220
+
221
+
222
## Alerts
223
224
There are no alerts configured by default for this integration.
src/go/plugin/go.d/collector/postgres/integrations/postgresql.md
+74
@@ -227,6 +227,80 @@ Metrics:
227
228
229
230
+## Functions
231
+
232
+This collector exposes real-time functions for interactive troubleshooting in the Top tab.
233
+
234
+
235
+### Top Queries
236
+
237
+| Aspect | Description |
238
+|:-------|:------------|
239
+| Name | `Postgres:top-queries` |
240
+| Summary | Top SQL queries from pg_stat_statements. |
241
+| Behavior | Reads pg_stat_statements and returns the top entries sorted by the selected column. |
242
+| Performance | Requires pg_stat_statements and can be expensive on busy servers. |
243
+| Security | Query text may contain unmasked literals (potential PII). |
244
+| Requirements | Requires the pg_stat_statements extension installed and enabled. |
245
+| Availability | Available when pg_stat_statements is available and the collector is initialized. |
246
+
247
+#### Parameters
248
+
249
+| Parameter | Type | Description | Required | Default | Options |
250
+|:---------|:-----|:------------|:--------:|:--------|:--------|
251
+| Filter By | select | Select the primary sort column (options are derived from sortable columns in the response). | yes | totalTime | |
252
+
253
+#### Returns
254
+
255
+Aggregated query statistics from pg_stat_statements.
256
+
257
+| Column | Type | Description |
258
+|:-------|:-----|:------------|
259
+| Query ID | string | |
260
+| Query | string | |
261
+| Database | string | |
262
+| User | string | |
263
+| Calls | integer | |
264
+| Total Time | duration | |
265
+| Mean Time | duration | |
266
+| Min Time | duration | |
267
+| Max Time | duration | |
268
+| Stddev Time | duration | |
269
+| Plans | integer | |
270
+| Total Plan Time | duration | |
271
+| Mean Plan Time | duration | |
272
+| Min Plan Time | duration | |
273
+| Max Plan Time | duration | |
274
+| Stddev Plan Time | duration | |
275
+| Rows | integer | |
276
+| Shared Blocks Hit | integer | |
277
+| Shared Blocks Read | integer | |
278
+| Shared Blocks Dirtied | integer | |
279
+| Shared Blocks Written | integer | |
280
+| Local Blocks Hit | integer | |
281
+| Local Blocks Read | integer | |
282
+| Local Blocks Dirtied | integer | |
283
+| Local Blocks Written | integer | |
284
+| Temp Blocks Read | integer | |
285
+| Temp Blocks Written | integer | |
286
+| Block Read Time | duration | |
287
+| Block Write Time | duration | |
288
+| WAL Records | integer | |
289
+| WAL Full Page Images | integer | |
290
+| WAL Bytes | integer | |
291
+| JIT Functions | integer | |
292
+| JIT Generation Time | duration | |
293
+| JIT Inlining Count | integer | |
294
+| JIT Inlining Time | duration | |
295
+| JIT Optimization Count | integer | |
296
+| JIT Optimization Time | duration | |
297
+| JIT Emission Count | integer | |
298
+| JIT Emission Time | duration | |
299
+| Temp Block Read Time | duration | |
300
+| Temp Block Write Time | duration | |
301
+
302
+
303
+
304
## Alerts
305
306
src/go/plugin/go.d/collector/proxysql/integrations/proxysql.md
+48
@@ -169,6 +169,54 @@ Metrics:
169
170
171
172
+## Functions
173
+
174
+This collector exposes real-time functions for interactive troubleshooting in the Top tab.
175
+
176
+
177
+### Top Queries
178
+
179
+| Aspect | Description |
180
+|:-------|:------------|
181
+| Name | `Proxysql:top-queries` |
182
+| Summary | Top SQL queries from ProxySQL query digest stats. |
183
+| Behavior | Queries stats_mysql_query_digest and returns the top entries sorted by the selected column. |
184
+| Performance | Uses ProxySQL stats tables and can be expensive on busy systems. |
185
+| Security | Query text may contain unmasked literals (potential PII). |
186
+| Requirements | Requires access to stats_mysql_query_digest in ProxySQL. |
187
+| Availability | Available when the collector can query ProxySQL stats; returns errors if the SQL connection is unavailable. |
188
+
189
+#### Parameters
190
+
191
+| Parameter | Type | Description | Required | Default | Options |
192
+|:---------|:-----|:------------|:--------:|:--------|:--------|
193
+| Filter By | select | Select the primary sort column (options are derived from sortable columns in the response). | yes | totalTime | |
194
+
195
+#### Returns
196
+
197
+Query digest statistics from ProxySQL.
198
+
199
+| Column | Type | Description |
200
+|:-------|:-----|:------------|
201
+| Digest | string | |
202
+| Query | string | |
203
+| Schema | string | |
204
+| User | string | |
205
+| Hostgroup | integer | |
206
+| Calls | integer | |
207
+| Total Time | duration | |
208
+| Avg Time | duration | |
209
+| Min Time | duration | |
210
+| Max Time | duration | |
211
+| Rows Affected | integer | |
212
+| Rows Sent | integer | |
213
+| Errors | integer | |
214
+| Warnings | integer | |
215
+| First Seen | string | |
216
+| Last Seen | string | |
217
+
218
+
219
+
220
## Alerts
221
222
src/go/plugin/go.d/collector/redis/integrations/redis.md
+39
@@ -102,6 +102,45 @@ Metrics:
102
103
104
105
+## Functions
106
+
107
+This collector exposes real-time functions for interactive troubleshooting in the Top tab.
108
+
109
+
110
+### Top Queries
111
+
112
+| Aspect | Description |
113
+|:-------|:------------|
114
+| Name | `Redis:top-queries` |
115
+| Summary | Slow commands from Redis SLOWLOG. WARNING: Command arguments may contain unmasked literals (potential PII). |
116
+| Behavior | Reads Redis SLOWLOG and returns the top entries sorted by the selected column. |
117
+| Performance | Uses SLOWLOG GET and may return many entries; use top_queries_limit to control size. |
118
+| Security | Command arguments may contain unmasked literals (potential PII). |
119
+| Requirements | Requires access to the Redis SLOWLOG and a working connection. |
120
+| Availability | Available when the collector is initialized; returns 503 if the collector is still connecting. |
121
+
122
+#### Parameters
123
+
124
+| Parameter | Type | Description | Required | Default | Options |
125
+|:---------|:-----|:------------|:--------:|:--------|:--------|
126
+| Filter By | select | Select the primary sort column (options are derived from sortable columns in the response). | yes | duration | |
127
+
128
+#### Returns
129
+
130
+Slowlog entries with command timing and metadata.
131
+
132
+| Column | Type | Description |
133
+|:-------|:-----|:------------|
134
+| ID | integer | |
135
+| Timestamp | timestamp | |
136
+| Command | string | |
137
+| Command Name | string | |
138
+| Duration | duration | |
139
+| Client Address | string | |
140
+| Client Name | string | |
141
+
142
+
143
+
144
## Alerts
145
146
src/go/plugin/go.d/collector/rethinkdb/integrations/rethinkdb.md
+40
@@ -97,6 +97,46 @@ Metrics:
97
98
99
100
+## Functions
101
+
102
+This collector exposes real-time functions for interactive troubleshooting in the Top tab.
103
+
104
+
105
+### Running Queries
106
+
107
+| Aspect | Description |
108
+|:-------|:------------|
109
+| Name | `Rethinkdb:running-queries` |
110
+| Summary | Currently running queries from rethinkdb.jobs. WARNING: Query text may contain unmasked literals (potential PII). |
111
+| Behavior | Queries rethinkdb.jobs and returns running queries sorted by the selected column. |
112
+| Performance | Uses system tables and may be expensive on busy clusters. |
113
+| Security | Query text may contain unmasked literals (potential PII). |
114
+| Requirements | Requires admin access to rethinkdb.jobs and a working connection. |
115
+| Availability | Available when the collector is initialized; returns 503 if the collector is still connecting. |
116
+
117
+#### Parameters
118
+
119
+| Parameter | Type | Description | Required | Default | Options |
120
+|:---------|:-----|:------------|:--------:|:--------|:--------|
121
+| Filter By | select | Select the primary sort column (options are derived from sortable columns in the response). | yes | durationMs | |
122
+
123
+#### Returns
124
+
125
+Snapshot of running queries from rethinkdb.jobs.
126
+
127
+| Column | Type | Description |
128
+|:-------|:-----|:------------|
129
+| Job ID | string | |
130
+| Query | string | |
131
+| Duration | duration | |
132
+| Type | string | |
133
+| User | string | |
134
+| Client Address | string | |
135
+| Client Port | integer | |
136
+| Servers | string | |
137
+
138
+
139
+
140
## Alerts
141
142
There are no alerts configured by default for this integration.
src/go/plugin/go.d/collector/snmp/integrations/snmp_devices.md
+51
@@ -125,6 +125,57 @@ If `ping.enabled` is true, ICMP latency/packet-loss charts are also provided (or
125
126
127
128
+## Functions
129
+
130
+This collector exposes real-time functions for interactive troubleshooting in the Top tab.
131
+
132
+
133
+### Network Interfaces
134
+
135
+| Aspect | Description |
136
+|:-------|:------------|
137
+| Name | `Snmp:interfaces` |
138
+| Summary | Network interface traffic and status metrics. |
139
+| Behavior | Uses the latest cached SNMP interface data, filters by the selected type group, and sorts by the default column. |
140
+| Performance | Uses cached data only and does not trigger additional SNMP requests. Large devices may return many rows. |
141
+| Security | Exposes interface names and counters only. |
142
+| Requirements | Requires successful SNMP collection so interface data is cached. |
143
+| Availability | Available after the collector has completed at least one data collection; returns 503 until cache is ready. |
144
+
145
+#### Parameters
146
+
147
+| Parameter | Type | Description | Required | Default | Options |
148
+|:---------|:-----|:------------|:--------:|:--------|:--------|
149
+| Type Group | select | Filter by interface type group. | yes | ethernet | Ethernet (default), Aggregation, Virtual, Other |
150
+
151
+#### Returns
152
+
153
+Table of interface traffic and status from cached SNMP data.
154
+
155
+| Column | Type | Description |
156
+|:-------|:-----|:------------|
157
+| Interface | string | |
158
+| Type | string | |
159
+| Type Group | string | |
160
+| Admin Status | string | |
161
+| Oper Status | string | |
162
+| Traffic In | float | |
163
+| Traffic Out | float | |
164
+| Unicast In | float | |
165
+| Unicast Out | float | |
166
+| Broadcast In | float | |
167
+| Broadcast Out | float | |
168
+| Packets In | float | |
169
+| Packets Out | float | |
170
+| Errors In | float | |
171
+| Errors Out | float | |
172
+| Discards In | float | |
173
+| Discards Out | float | |
174
+| Multicast In | float | |
175
+| Multicast Out | float | |
176
+
177
+
178
+
179
## Alerts
180
181
There are no alerts configured by default for this integration.
src/go/plugin/go.d/collector/yugabytedb/integrations/yugabytedb.md
+79
@@ -333,6 +333,85 @@ Metrics:
333
334
335
336
+## Functions
337
+
338
+This collector exposes real-time functions for interactive troubleshooting in the Top tab.
339
+
340
+
341
+### Top Queries
342
+
343
+| Aspect | Description |
344
+|:-------|:------------|
345
+| Name | `Yugabytedb:top-queries` |
346
+| Summary | Top SQL queries from pg_stat_statements. WARNING: Query text may contain unmasked literals (potential PII). |
347
+| Behavior | Reads pg_stat_statements and returns the top entries sorted by the selected column. |
348
+| Performance | Executes SQL queries and may be expensive on busy clusters; use top_queries_limit and sql_timeout. |
349
+| Security | Query text may contain unmasked literals (potential PII). |
350
+| Requirements | Requires pg_stat_statements installed and a SQL DSN configured for YSQL. |
351
+| Availability | Available when YSQL is accessible; returns errors if the SQL connection is unavailable. |
352
+
353
+#### Parameters
354
+
355
+| Parameter | Type | Description | Required | Default | Options |
356
+|:---------|:-----|:------------|:--------:|:--------|:--------|
357
+| Filter By | select | Select the primary sort column (options are derived from sortable columns in the response). | yes | totalTime | |
358
+
359
+#### Returns
360
+
361
+Aggregated query statistics from pg_stat_statements.
362
+
363
+| Column | Type | Description |
364
+|:-------|:-----|:------------|
365
+| Query ID | string | |
366
+| Query | string | |
367
+| Database | string | |
368
+| User | string | |
369
+| Calls | integer | |
370
+| Total Time | duration | |
371
+| Mean Time | duration | |
372
+| Min Time | duration | |
373
+| Max Time | duration | |
374
+| Rows | integer | |
375
+| Stddev Time | duration | |
376
+
377
+### Running Queries
378
+
379
+| Aspect | Description |
380
+|:-------|:------------|
381
+| Name | `Yugabytedb:running-queries` |
382
+| Summary | Currently running SQL statements from pg_stat_activity. WARNING: Query text may contain unmasked literals (potential PII). |
383
+| Behavior | Reads pg_stat_activity and returns running statements sorted by the selected column. |
384
+| Performance | Executes SQL queries and may be expensive on busy clusters; use top_queries_limit and sql_timeout. |
385
+| Security | Query text may contain unmasked literals (potential PII). |
386
+| Requirements | Requires a SQL DSN configured for YSQL and access to pg_stat_activity. |
387
+| Availability | Available when YSQL is accessible; returns errors if the SQL connection is unavailable. |
388
+
389
+#### Parameters
390
+
391
+| Parameter | Type | Description | Required | Default | Options |
392
+|:---------|:-----|:------------|:--------:|:--------|:--------|
393
+| Filter By | select | Select the primary sort column (options are derived from sortable columns in the response). | yes | elapsedMs | |
394
+
395
+#### Returns
396
+
397
+Snapshot of currently running SQL statements.
398
+
399
+| Column | Type | Description |
400
+|:-------|:-----|:------------|
401
+| PID | string | |
402
+| Query | string | |
403
+| Database | string | |
404
+| User | string | |
405
+| State | string | |
406
+| Wait Event Type | string | |
407
+| Wait Event | string | |
408
+| Application | string | |
409
+| Client Address | string | |
410
+| Query Start | string | |
411
+| Elapsed | duration | |
412
+
413
+
414
+
415
## Alerts
416
417
There are no alerts configured by default for this integration.