@cryptotaxi247 / netdata-1 / commits / 1dc4108e3

docs: Add collector function docs metadata (#21618)

Ilya Mashchenko committed Jan 23, 2026 at 07:18 UTC 1dc4108e3e3ed235a3f3894928510a8a00c77c32
18 files changed +1697
integrations/gen_docs_integrations.py
+2
@@ -182,6 +182,8 @@ endmeta-->
182
183 if integration.get("metrics"):
184 md += f"\n{integration['metrics']}\n"
185 + if integration.get("functions"):
186 + md += f"\n{integration['functions']}\n"
187 if integration.get("alerts"):
188 md += f"\n{integration['alerts']}\n"
189 if integration.get("setup"):
integrations/gen_integrations.py
+1
@@ -58,6 +58,7 @@ AUTHENTICATION_SOURCES = [
58 COLLECTOR_RENDER_KEYS = [
59 'alerts',
60 'metrics',
61 + 'functions',
62 'overview',
63 'related_resources',
64 'setup',
integrations/schemas/collector.json
+177
@@ -391,6 +391,183 @@
391 "availability",
392 "scopes"
393 ]
394 + },
395 + "functions": {
396 + "type": "object",
397 + "description": "Real-time function documentation for this collector.",
398 + "properties": {
399 + "description": {
400 + "type": "string",
401 + "description": "High-level description of available functions."
402 + },
403 + "list": {
404 + "type": "array",
405 + "description": "List of functions exposed by the collector.",
406 + "items": {
407 + "type": "object",
408 + "properties": {
409 + "id": {
410 + "type": "string",
411 + "description": "Function method ID."
412 + },
413 + "name": {
414 + "type": "string",
415 + "description": "Function display name."
416 + },
417 + "summary": {
418 + "type": "string",
419 + "description": "Short summary of what the function returns."
420 + },
421 + "parameters": {
422 + "type": "array",
423 + "description": "Function parameters and their descriptions.",
424 + "items": {
425 + "type": "object",
426 + "properties": {
427 + "id": {
428 + "type": "string",
429 + "description": "Parameter ID."
430 + },
431 + "name": {
432 + "type": "string",
433 + "description": "Parameter display name."
434 + },
435 + "description": {
436 + "type": "string",
437 + "description": "Parameter description."
438 + },
439 + "type": {
440 + "type": "string",
441 + "description": "Parameter type (e.g. select, string)."
442 + },
443 + "required": {
444 + "type": "boolean",
445 + "description": "Whether the parameter is required."
446 + },
447 + "default": {
448 + "type": "string",
449 + "description": "Default value, if applicable."
450 + },
451 + "options": {
452 + "type": "array",
453 + "description": "Allowed parameter options (for select parameters).",
454 + "items": {
455 + "type": "object",
456 + "properties": {
457 + "id": {
458 + "type": "string",
459 + "description": "Option ID."
460 + },
461 + "name": {
462 + "type": "string",
463 + "description": "Option display name."
464 + },
465 + "description": {
466 + "type": "string",
467 + "description": "Option description."
468 + },
469 + "default": {
470 + "type": "boolean",
471 + "description": "Whether this option is the default."
472 + }
473 + },
474 + "required": [
475 + "id",
476 + "name"
477 + ]
478 + }
479 + }
480 + },
481 + "required": [
482 + "id",
483 + "name",
484 + "description",
485 + "type",
486 + "required",
487 + "default",
488 + "options"
489 + ]
490 + }
491 + },
492 + "returns": {
493 + "type": "object",
494 + "description": "Return shape and columns for the function response.",
495 + "properties": {
496 + "description": {
497 + "type": "string",
498 + "description": "Return description."
499 + },
500 + "columns": {
501 + "type": "array",
502 + "description": "List of returned columns.",
503 + "items": {
504 + "type": "object",
505 + "properties": {
506 + "name": {
507 + "type": "string",
508 + "description": "Column name."
509 + },
510 + "type": {
511 + "type": "string",
512 + "description": "Column type."
513 + },
514 + "description": {
515 + "type": "string",
516 + "description": "Column description."
517 + }
518 + },
519 + "required": [
520 + "name",
521 + "type"
522 + ]
523 + }
524 + }
525 + },
526 + "required": [
527 + "description",
528 + "columns"
529 + ]
530 + },
531 + "behavior": {
532 + "type": "string",
533 + "description": "How the function works internally."
534 + },
535 + "performance": {
536 + "type": "string",
537 + "description": "Performance considerations."
538 + },
539 + "security": {
540 + "type": "string",
541 + "description": "Security/PII considerations."
542 + },
543 + "requirements": {
544 + "type": "string",
545 + "description": "Prerequisites and required permissions."
546 + },
547 + "availability": {
548 + "type": "string",
549 + "description": "Availability and enablement notes."
550 + }
551 + },
552 + "required": [
553 + "id",
554 + "name",
555 + "summary",
556 + "parameters",
557 + "returns",
558 + "behavior",
559 + "performance",
560 + "security",
561 + "requirements",
562 + "availability"
563 + ]
564 + }
565 + }
566 + },
567 + "required": [
568 + "description",
569 + "list"
570 + ]
571 }
572 },
573 "required": [
integrations/templates/functions.md new
+42
@@ -0,0 +1,42 @@
1 +[% if entry.functions and entry.functions.list %]
2 +## Functions
3 +
4 +[[ entry.functions.description ]]
5 +
6 +[% for func in entry.functions.list %]
7 +### [[ func.name ]]
8 +
9 +| Aspect | Description |
10 +|:-------|:------------|
11 +| Name | `[[ entry.meta.module_name|capitalize ]]:[[ func.id ]]` |
12 +| Summary | [[ strfy(func.summary) ]] |
13 +| Behavior | [[ strfy(func.behavior) ]] |
14 +| Performance | [[ strfy(func.performance) ]] |
15 +| Security | [[ strfy(func.security) ]] |
16 +| Requirements | [[ strfy(func.requirements) ]] |
17 +| Availability | [[ strfy(func.availability) ]] |
18 +
19 +#### Parameters
20 +
21 +[% if func.parameters %]
22 +| Parameter | Type | Description | Required | Default | Options |
23 +|:---------|:-----|:------------|:--------:|:--------|:--------|
24 +[% for param in func.parameters %]
25 +| [[ strfy(param.name) ]] | [[ strfy(param.type) ]] | [[ strfy(param.description) ]] | [[ strfy(param.required) ]] | [[ strfy(param.default) ]] | [% if param.options %][% for opt in param.options %][[ strfy(opt.name) ]][% if opt.default %] (default)[% endif %][% if not loop.last %], [% endif %][% endfor %][% endif %] |
26 +[% endfor %]
27 +[% else %]
28 +This function has no parameters.
29 +[% endif %]
30 +
31 +#### Returns
32 +
33 +[[ func.returns.description ]]
34 +
35 +| Column | Type | Description |
36 +|:-------|:-----|:------------|
37 +[% for col in func.returns.columns %]
38 +| [[ strfy(col.name) ]] | [[ strfy(col.type) ]] | [[ strfy(col.description) ]] |
39 +[% endfor %]
40 +
41 +[% endfor %]
42 +[% endif %]
src/go/plugin/go.d/collector/clickhouse/metadata.yaml
+76
@@ -252,6 +252,82 @@ modules:
252 metric: clickhouse.distributed_files_to_insert
253 info: ClickHouse high number of pending files to process for asynchronous insertion into Distributed tables
254 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/clickhouse.conf
255 + functions:
256 + description: |
257 + This collector exposes real-time functions for interactive troubleshooting in the Top tab.
258 + list:
259 + - id: top-queries
260 + name: Top Queries
261 + summary: Top SQL queries from ClickHouse system.query_log.
262 + parameters:
263 + - id: __sort
264 + name: Filter By
265 + description: Select the primary sort column (options are derived from sortable columns in the response).
266 + type: select
267 + required: true
268 + default: totalTime
269 + options: []
270 + returns:
271 + description: Aggregated query statistics from system.query_log.
272 + columns:
273 + - name: Query ID
274 + type: string
275 + description: ""
276 + - name: Query
277 + type: string
278 + description: ""
279 + - name: Database
280 + type: string
281 + description: ""
282 + - name: User
283 + type: string
284 + description: ""
285 + - name: Calls
286 + type: integer
287 + description: ""
288 + - name: Total Time
289 + type: duration
290 + description: ""
291 + - name: Avg Time
292 + type: duration
293 + description: ""
294 + - name: Min Time
295 + type: duration
296 + description: ""
297 + - name: Max Time
298 + type: duration
299 + description: ""
300 + - name: Read Rows
301 + type: integer
302 + description: ""
303 + - name: Read Bytes
304 + type: integer
305 + description: ""
306 + - name: Written Rows
307 + type: integer
308 + description: ""
309 + - name: Written Bytes
310 + type: integer
311 + description: ""
312 + - name: Result Rows
313 + type: integer
314 + description: ""
315 + - name: Result Bytes
316 + type: integer
317 + description: ""
318 + - name: Max Memory
319 + type: float
320 + description: ""
321 + behavior: |
322 + Queries system.query_log, aggregates by query, and returns the top entries sorted by the selected column.
323 + performance: |
324 + Uses system.query_log and can be expensive on busy systems. Use limits to control response size.
325 + security: |
326 + Query text may include sensitive literals depending on server settings.
327 + requirements: |
328 + Requires access to system.query_log on the target ClickHouse instance.
329 + availability: |
330 + Available when the collector can query system tables; returns 503 if system.query_log is not available.
331 metrics:
332 folding:
333 title: Metrics
src/go/plugin/go.d/collector/cockroachdb/metadata.yaml
+145
@@ -247,6 +247,151 @@ modules:
247 metric: cockroachdb.process_file_descriptors
248 info: "open file descriptors utilization (against softlimit)"
249 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/cockroachdb.conf
250 + functions:
251 + description: |
252 + This collector exposes real-time functions for interactive troubleshooting in the Top tab.
253 + list:
254 + - id: top-queries
255 + name: Top Queries
256 + summary: Top SQL statements from crdb_internal.cluster_statement_statistics.
257 + parameters:
258 + - id: __sort
259 + name: Filter By
260 + description: Select the primary sort column (options are derived from sortable columns in the response).
261 + type: select
262 + required: true
263 + default: totalTime
264 + options: []
265 + returns:
266 + description: Aggregated SQL statement statistics.
267 + columns:
268 + - name: Fingerprint ID
269 + type: string
270 + description: ""
271 + - name: Query
272 + type: string
273 + description: ""
274 + - name: Database
275 + type: string
276 + description: ""
277 + - name: Application
278 + type: string
279 + description: ""
280 + - name: Statement Type
281 + type: string
282 + description: ""
283 + - name: Distributed
284 + type: string
285 + description: ""
286 + - name: Full Scan
287 + type: string
288 + description: ""
289 + - name: Implicit Txn
290 + type: string
291 + description: ""
292 + - name: Vectorized
293 + type: string
294 + description: ""
295 + - name: Executions
296 + type: integer
297 + description: ""
298 + - name: Total Time
299 + type: duration
300 + description: ""
301 + - name: Mean Time
302 + type: duration
303 + description: ""
304 + - name: Run Time
305 + type: duration
306 + description: ""
307 + - name: Plan Time
308 + type: duration
309 + description: ""
310 + - name: Parse Time
311 + type: duration
312 + description: ""
313 + - name: Rows Read
314 + type: integer
315 + description: ""
316 + - name: Rows Written
317 + type: integer
318 + description: ""
319 + - name: Rows Returned
320 + type: integer
321 + description: ""
322 + - name: Bytes Read
323 + type: integer
324 + description: ""
325 + - name: Max Retries
326 + type: integer
327 + description: ""
328 + behavior: |
329 + Queries crdb_internal.cluster_statement_statistics and returns the top entries sorted by the selected column.
330 + performance: |
331 + Executes SQL queries against system tables and may be expensive on busy clusters.
332 + security: |
333 + Query text may contain unmasked literals (potential PII).
334 + requirements: |
335 + Requires a SQL user with VIEWACTIVITY (or VIEWACTIVITYREDACTED) and access to crdb_internal.cluster_statement_statistics.
336 + availability: |
337 + Requires SQL DSN configuration and access to system tables; returns errors if DSN is missing or SQL is unavailable.
338 + - id: running-queries
339 + name: Running Queries
340 + summary: Currently running SQL statements from SHOW CLUSTER STATEMENTS.
341 + parameters:
342 + - id: __sort
343 + name: Filter By
344 + description: Select the primary sort column (options are derived from sortable columns in the response).
345 + type: select
346 + required: true
347 + default: elapsedMs
348 + options: []
349 + returns:
350 + description: Snapshot of currently running SQL statements.
351 + columns:
352 + - name: Query ID
353 + type: string
354 + description: ""
355 + - name: Query
356 + type: string
357 + description: ""
358 + - name: User
359 + type: string
360 + description: ""
361 + - name: Application
362 + type: string
363 + description: ""
364 + - name: Client Address
365 + type: string
366 + description: ""
367 + - name: Node ID
368 + type: string
369 + description: ""
370 + - name: Session ID
371 + type: string
372 + description: ""
373 + - name: Phase
374 + type: string
375 + description: ""
376 + - name: Distributed
377 + type: string
378 + description: ""
379 + - name: Start Time
380 + type: string
381 + description: ""
382 + - name: Elapsed
383 + type: duration
384 + description: ""
385 + behavior: |
386 + Queries SHOW CLUSTER STATEMENTS and returns running statements sorted by the selected column.
387 + performance: |
388 + Executes SQL queries against system tables and may be expensive on busy clusters.
389 + security: |
390 + Query text may contain unmasked literals (potential PII).
391 + requirements: |
392 + Requires a SQL user with VIEWACTIVITY (or VIEWACTIVITYREDACTED) and access to system tables.
393 + availability: |
394 + Requires SQL DSN configuration and access to system tables; returns errors if DSN is missing or SQL is unavailable.
395 metrics:
396 folding:
397 title: Metrics
src/go/plugin/go.d/collector/couchbase/metadata.yaml
+61
@@ -191,6 +191,67 @@ modules:
191 problems:
192 list: []
193 alerts: []
194 + functions:
195 + description: |
196 + This collector exposes real-time functions for interactive troubleshooting in the Top tab.
197 + list:
198 + - id: top-queries
199 + name: Top Queries
200 + summary: Top N1QL requests from system:completed_requests.
201 + parameters:
202 + - id: __sort
203 + name: Filter By
204 + description: Select the primary sort column (options are derived from sortable columns in the response).
205 + type: select
206 + required: true
207 + default: elapsedTime
208 + options: []
209 + returns:
210 + description: Completed N1QL request statistics.
211 + columns:
212 + - name: Request ID
213 + type: string
214 + description: ""
215 + - name: Request Time
216 + type: timestamp
217 + description: ""
218 + - name: Statement
219 + type: string
220 + description: ""
221 + - name: Elapsed Time
222 + type: duration
223 + description: ""
224 + - name: Service Time
225 + type: duration
226 + description: ""
227 + - name: Result Count
228 + type: integer
229 + description: ""
230 + - name: Result Size
231 + type: integer
232 + description: ""
233 + - name: Error Count
234 + type: integer
235 + description: ""
236 + - name: Warning Count
237 + type: integer
238 + description: ""
239 + - name: User
240 + type: string
241 + description: ""
242 + - name: Client Context ID
243 + type: string
244 + description: ""
245 + behavior: |
246 + Queries the system:completed_requests keyspace and returns the top entries sorted by the selected column.
247 + performance: |
248 + Runs N1QL queries against system keyspaces; use top_queries_limit to control response size.
249 + security: |
250 + Query text may include sensitive literals depending on workload.
251 + requirements: |
252 + Requires access to the system:completed_requests keyspace and N1QL service.
253 + availability: |
254 + Available when the collector can query system keyspaces; returns 503 until the collector is initialized.
255 metrics:
256 folding:
257 title: Metrics
src/go/plugin/go.d/collector/elasticsearch/metadata.yaml
+58
@@ -276,6 +276,64 @@ modules:
276 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/elasticsearch.conf
277 metric: elasticsearch.node_index_health
278 info: node index $label:index health status is red.
279 + functions:
280 + description: |
281 + This collector exposes real-time functions for interactive troubleshooting in the Top tab.
282 + list:
283 + - id: top-queries
284 + name: Top Queries
285 + summary: Running queries from the Elasticsearch Tasks API.
286 + parameters:
287 + - id: __sort
288 + name: Filter By
289 + description: Select the primary sort column (options are derived from sortable columns in the response).
290 + type: select
291 + required: true
292 + default: runningTime
293 + options: []
294 + returns:
295 + description: Snapshot of running tasks from the Tasks API.
296 + columns:
297 + - name: Task ID
298 + type: string
299 + description: ""
300 + - name: Node ID
301 + type: string
302 + description: ""
303 + - name: Node Name
304 + type: string
305 + description: ""
306 + - name: Action
307 + type: string
308 + description: ""
309 + - name: Type
310 + type: string
311 + description: ""
312 + - name: Description
313 + type: string
314 + description: ""
315 + - name: Start Time
316 + type: timestamp
317 + description: ""
318 + - name: Running Time
319 + type: duration
320 + description: ""
321 + - name: Cancellable
322 + type: boolean
323 + description: ""
324 + - name: Cancelled
325 + type: boolean
326 + description: ""
327 + behavior: |
328 + Calls the Tasks API and returns running task details sorted by the selected column.
329 + performance: |
330 + Queries the Tasks API; on large clusters this may return many rows.
331 + security: |
332 + Task descriptions may include query details.
333 + requirements: |
334 + Requires access to the Tasks API on the target Elasticsearch node.
335 + availability: |
336 + Available when the collector can query the Tasks API; returns 503 until the collector is initialized.
337 metrics:
338 folding:
339 title: Metrics
src/go/plugin/go.d/collector/mongodb/metadata.yaml
+112
@@ -165,6 +165,118 @@ modules:
165 problems:
166 list: []
167 alerts: []
168 + functions:
169 + description: |
170 + This collector exposes real-time functions for interactive troubleshooting in the Top tab.
171 + list:
172 + - id: top-queries
173 + name: Top Queries
174 + summary: "Top queries from MongoDB Profiler (system.profile). WARNING: Query text may contain unmasked literals (potential PII)."
175 + parameters:
176 + - id: __sort
177 + name: Filter By
178 + description: Select the primary sort column (options are derived from sortable columns in the response).
179 + type: select
180 + required: true
181 + default: execution_time
182 + options: []
183 + returns:
184 + description: Profiled query statistics from system.profile.
185 + columns:
186 + - name: Timestamp
187 + type: timestamp
188 + description: ""
189 + - name: Namespace
190 + type: string
191 + description: ""
192 + - name: Operation
193 + type: string
194 + description: ""
195 + - name: Query
196 + type: string
197 + description: ""
198 + - name: Execution Time
199 + type: duration
200 + description: ""
201 + - name: Docs Examined
202 + type: integer
203 + description: ""
204 + - name: Keys Examined
205 + type: integer
206 + description: ""
207 + - name: Docs Returned
208 + type: integer
209 + description: ""
210 + - name: Plan Summary
211 + type: string
212 + description: ""
213 + - name: Client
214 + type: string
215 + description: ""
216 + - name: User
217 + type: string
218 + description: ""
219 + - name: Docs Deleted
220 + type: integer
221 + description: ""
222 + - name: Docs Inserted
223 + type: integer
224 + description: ""
225 + - name: Docs Modified
226 + type: integer
227 + description: ""
228 + - name: Response Length
229 + type: integer
230 + description: ""
231 + - name: Num Yield
232 + type: integer
233 + description: ""
234 + - name: App Name
235 + type: string
236 + description: ""
237 + - name: Cursor Exhausted
238 + type: string
239 + description: ""
240 + - name: Has Sort Stage
241 + type: string
242 + description: ""
243 + - name: Uses Disk
244 + type: string
245 + description: ""
246 + - name: From Multi Planner
247 + type: string
248 + description: ""
249 + - name: Replanned
250 + type: string
251 + description: ""
252 + - name: Query Hash
253 + type: string
254 + description: ""
255 + - name: Plan Cache Key
256 + type: string
257 + description: ""
258 + - name: Planning Time
259 + type: duration
260 + description: ""
261 + - name: CPU Time
262 + type: duration
263 + description: ""
264 + - name: Query Framework
265 + type: string
266 + description: ""
267 + - name: Query Shape Hash
268 + type: string
269 + description: ""
270 + behavior: |
271 + Reads from system.profile and returns the top profiled queries sorted by the selected column.
272 + performance: |
273 + Requires profiling and reads from system.profile; may add load on busy systems.
274 + security: |
275 + Query text may contain unmasked literals (potential PII).
276 + requirements: |
277 + Requires MongoDB profiling enabled on target databases and top_queries_function_enabled set to true.
278 + availability: |
279 + Available when profiling is enabled and the collector is initialized; returns 403 if disabled in config.
280 metrics:
281 folding:
282 title: Metrics
src/go/plugin/go.d/collector/mssql/metadata.yaml
+208
@@ -226,6 +226,214 @@ modules:
226 The monitoring user needs VIEW SERVER STATE permission.
227 Grant it with: `GRANT VIEW SERVER STATE TO netdata_user;`
228 alerts: []
229 + functions:
230 + description: |
231 + This collector exposes real-time functions for interactive troubleshooting in the Top tab.
232 + list:
233 + - id: top-queries
234 + name: Top Queries
235 + summary: Top SQL queries from Query Store.
236 + parameters:
237 + - id: __sort
238 + name: Filter By
239 + description: Select the primary sort column (options are derived from sortable columns in the response).
240 + type: select
241 + required: true
242 + default: totalTime
243 + options: []
244 + returns:
245 + description: Query Store statistics for top queries.
246 + columns:
247 + - name: Query Hash
248 + type: string
249 + description: ""
250 + - name: Query
251 + type: string
252 + description: ""
253 + - name: Database
254 + type: string
255 + description: ""
256 + - name: Calls
257 + type: integer
258 + description: ""
259 + - name: Total Time
260 + type: duration
261 + description: ""
262 + - name: Avg Time
263 + type: duration
264 + description: ""
265 + - name: Last Time
266 + type: duration
267 + description: ""
268 + - name: Min Time
269 + type: duration
270 + description: ""
271 + - name: Max Time
272 + type: duration
273 + description: ""
274 + - name: StdDev Time
275 + type: duration
276 + description: ""
277 + - name: Avg CPU
278 + type: duration
279 + description: ""
280 + - name: Last CPU
281 + type: duration
282 + description: ""
283 + - name: Min CPU
284 + type: duration
285 + description: ""
286 + - name: Max CPU
287 + type: duration
288 + description: ""
289 + - name: StdDev CPU
290 + type: duration
291 + description: ""
292 + - name: Avg Logical Reads
293 + type: float
294 + description: ""
295 + - name: Last Logical Reads
296 + type: integer
297 + description: ""
298 + - name: Min Logical Reads
299 + type: integer
300 + description: ""
301 + - name: Max Logical Reads
302 + type: integer
303 + description: ""
304 + - name: StdDev Logical Reads
305 + type: float
306 + description: ""
307 + - name: Avg Logical Writes
308 + type: float
309 + description: ""
310 + - name: Last Logical Writes
311 + type: integer
312 + description: ""
313 + - name: Min Logical Writes
314 + type: integer
315 + description: ""
316 + - name: Max Logical Writes
317 + type: integer
318 + description: ""
319 + - name: StdDev Logical Writes
320 + type: float
321 + description: ""
322 + - name: Avg Physical Reads
323 + type: float
324 + description: ""
325 + - name: Last Physical Reads
326 + type: integer
327 + description: ""
328 + - name: Min Physical Reads
329 + type: integer
330 + description: ""
331 + - name: Max Physical Reads
332 + type: integer
333 + description: ""
334 + - name: StdDev Physical Reads
335 + type: float
336 + description: ""
337 + - name: Avg CLR Time
338 + type: duration
339 + description: ""
340 + - name: Last CLR Time
341 + type: duration
342 + description: ""
343 + - name: Min CLR Time
344 + type: duration
345 + description: ""
346 + - name: Max CLR Time
347 + type: duration
348 + description: ""
349 + - name: StdDev CLR Time
350 + type: duration
351 + description: ""
352 + - name: Avg DOP
353 + type: float
354 + description: ""
355 + - name: Last DOP
356 + type: integer
357 + description: ""
358 + - name: Min DOP
359 + type: integer
360 + description: ""
361 + - name: Max DOP
362 + type: integer
363 + description: ""
364 + - name: StdDev DOP
365 + type: float
366 + description: ""
367 + - name: Avg Memory (8KB pages)
368 + type: float
369 + description: ""
370 + - name: Last Memory (8KB pages)
371 + type: integer
372 + description: ""
373 + - name: Min Memory (8KB pages)
374 + type: integer
375 + description: ""
376 + - name: Max Memory (8KB pages)
377 + type: integer
378 + description: ""
379 + - name: StdDev Memory
380 + type: float
381 + description: ""
382 + - name: Avg Rows
383 + type: float
384 + description: ""
385 + - name: Last Rows
386 + type: integer
387 + description: ""
388 + - name: Min Rows
389 + type: integer
390 + description: ""
391 + - name: Max Rows
392 + type: integer
393 + description: ""
394 + - name: StdDev Rows
395 + type: float
396 + description: ""
397 + - name: Avg Log Bytes
398 + type: float
399 + description: ""
400 + - name: Last Log Bytes
401 + type: integer
402 + description: ""
403 + - name: Min Log Bytes
404 + type: integer
405 + description: ""
406 + - name: Max Log Bytes
407 + type: integer
408 + description: ""
409 + - name: StdDev Log Bytes
410 + type: float
411 + description: ""
412 + - name: Avg TempDB (8KB pages)
413 + type: float
414 + description: ""
415 + - name: Last TempDB (8KB pages)
416 + type: integer
417 + description: ""
418 + - name: Min TempDB (8KB pages)
419 + type: integer
420 + description: ""
421 + - name: Max TempDB (8KB pages)
422 + type: integer
423 + description: ""
424 + - name: StdDev TempDB
425 + type: float
426 + description: ""
427 + behavior: |
428 + Queries Query Store runtime statistics and returns the top entries sorted by the selected column.
429 + performance: |
430 + Uses Query Store and can be expensive on busy instances.
431 + security: |
432 + Query Store may contain unmasked literals (potential PII).
433 + requirements: |
434 + Requires Query Store enabled and query_store_function_enabled set to true.
435 + availability: |
436 + Available when Query Store is enabled and the collector is initialized; returns 403 if disabled in config.
437 metrics:
438 folding:
439 title: Metrics
src/go/plugin/go.d/collector/mysql/metadata.yaml
+142
@@ -229,6 +229,148 @@ modules:
229 metric: mysql.galera_cluster_status
230 info: galera node is part of a nonoperational component. This occurs in cases of multiple membership changes that result in a loss of Quorum or in cases of split-brain situations.
231 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/mysql.conf
232 + functions:
233 + description: |
234 + This collector exposes real-time functions for interactive troubleshooting in the Top tab.
235 + list:
236 + - id: top-queries
237 + name: Top Queries
238 + summary: Top SQL queries from performance_schema.
239 + parameters:
240 + - id: __sort
241 + name: Filter By
242 + description: Select the primary sort column (options are derived from sortable columns in the response).
243 + type: select
244 + required: true
245 + default: totalTime
246 + options: []
247 + returns:
248 + description: Aggregated statement statistics from performance_schema.
249 + columns:
250 + - name: Digest
251 + type: string
252 + description: ""
253 + - name: Query
254 + type: string
255 + description: ""
256 + - name: Schema
257 + type: string
258 + description: ""
259 + - name: Calls
260 + type: integer
261 + description: ""
262 + - name: Total Time
263 + type: duration
264 + description: ""
265 + - name: Min Time
266 + type: duration
267 + description: ""
268 + - name: Avg Time
269 + type: duration
270 + description: ""
271 + - name: Max Time
272 + type: duration
273 + description: ""
274 + - name: Lock Time
275 + type: duration
276 + description: ""
277 + - name: Errors
278 + type: integer
279 + description: ""
280 + - name: Warnings
281 + type: integer
282 + description: ""
283 + - name: Rows Affected
284 + type: integer
285 + description: ""
286 + - name: Rows Sent
287 + type: integer
288 + description: ""
289 + - name: Rows Examined
290 + type: integer
291 + description: ""
292 + - name: Temp Disk Tables
293 + type: integer
294 + description: ""
295 + - name: Temp Tables
296 + type: integer
297 + description: ""
298 + - name: Full Joins
299 + type: integer
300 + description: ""
301 + - name: Full Range Joins
302 + type: integer
303 + description: ""
304 + - name: Select Range
305 + type: integer
306 + description: ""
307 + - name: Select Range Check
308 + type: integer
309 + description: ""
310 + - name: Select Scan
311 + type: integer
312 + description: ""
313 + - name: Sort Merge Passes
314 + type: integer
315 + description: ""
316 + - name: Sort Range
317 + type: integer
318 + description: ""
319 + - name: Sort Rows
320 + type: integer
321 + description: ""
322 + - name: Sort Scan
323 + type: integer
324 + description: ""
325 + - name: No Index Used
326 + type: integer
327 + description: ""
328 + - name: No Good Index Used
329 + type: integer
330 + description: ""
331 + - name: First Seen
332 + type: string
333 + description: ""
334 + - name: Last Seen
335 + type: string
336 + description: ""
337 + - name: P95 Time
338 + type: duration
339 + description: ""
340 + - name: P99 Time
341 + type: duration
342 + description: ""
343 + - name: P99.9 Time
344 + type: duration
345 + description: ""
346 + - name: Sample Query
347 + type: string
348 + description: ""
349 + - name: Sample Seen
350 + type: string
351 + description: ""
352 + - name: Sample Time
353 + type: duration
354 + description: ""
355 + - name: CPU Time
356 + type: duration
357 + description: ""
358 + - name: Max Controlled Memory
359 + type: integer
360 + description: ""
361 + - name: Max Total Memory
362 + type: integer
363 + description: ""
364 + behavior: |
365 + Reads performance_schema statement digest tables and returns the top entries sorted by the selected column.
366 + performance: |
367 + Requires performance_schema and can be expensive on busy servers.
368 + security: |
369 + Query text may contain unmasked literals (potential PII).
370 + requirements: |
371 + Requires performance_schema enabled and access to events_statements_summary_by_digest.
372 + availability: |
373 + Available when performance_schema tables are accessible and the collector is initialized.
374 metrics:
375 folding:
376 title: Metrics
src/go/plugin/go.d/collector/oracledb/metadata.yaml
+130
@@ -150,6 +150,136 @@ modules:
150 problems:
151 list: []
152 alerts: []
153 + functions:
154 + description: |
155 + This collector exposes real-time functions for interactive troubleshooting in the Top tab.
156 + list:
157 + - id: top-queries
158 + name: Top Queries
159 + summary: "Top SQL statements from V$SQLSTATS. WARNING: Query text may contain unmasked literals (potential PII)."
160 + parameters:
161 + - id: __sort
162 + name: Filter By
163 + description: Select the primary sort column (options are derived from sortable columns in the response).
164 + type: select
165 + required: true
166 + default: totalTime
167 + options: []
168 + returns:
169 + description: Aggregated SQL statistics from V$SQLSTATS.
170 + columns:
171 + - name: SQL ID
172 + type: string
173 + description: ""
174 + - name: Query
175 + type: string
176 + description: ""
177 + - name: Schema
178 + type: string
179 + description: ""
180 + - name: Executions
181 + type: integer
182 + description: ""
183 + - name: Total Time
184 + type: duration
185 + description: ""
186 + - name: Avg Time
187 + type: duration
188 + description: ""
189 + - name: CPU Time
190 + type: duration
191 + description: ""
192 + - name: Buffer Gets
193 + type: integer
194 + description: ""
195 + - name: Disk Reads
196 + type: integer
197 + description: ""
198 + - name: Rows Processed
199 + type: integer
200 + description: ""
201 + - name: Parse Calls
202 + type: integer
203 + description: ""
204 + - name: Module
205 + type: string
206 + description: ""
207 + - name: Action
208 + type: string
209 + description: ""
210 + - name: Last Active
211 + type: string
212 + description: ""
213 + behavior: |
214 + Queries V$SQLSTATS and returns the top entries sorted by the selected column.
215 + performance: |
216 + Queries system views and may be expensive on busy databases.
217 + security: |
218 + Query text may contain unmasked literals (potential PII).
219 + requirements: |
220 + Requires access to V$SQLSTATS and a working SQL connection.
221 + availability: |
222 + Available when the collector can query Oracle system views; returns errors if SQL is unavailable.
223 + - id: running-queries
224 + name: Running Queries
225 + summary: "Currently running SQL statements from V$SESSION. WARNING: Query text may contain unmasked literals (potential PII)."
226 + parameters:
227 + - id: __sort
228 + name: Filter By
229 + description: Select the primary sort column (options are derived from sortable columns in the response).
230 + type: select
231 + required: true
232 + default: lastCallMs
233 + options: []
234 + returns:
235 + description: Snapshot of currently running SQL sessions.
236 + columns:
237 + - name: Session
238 + type: string
239 + description: ""
240 + - name: User
241 + type: string
242 + description: ""
243 + - name: Status
244 + type: string
245 + description: ""
246 + - name: Type
247 + type: string
248 + description: ""
249 + - name: SQL ID
250 + type: string
251 + description: ""
252 + - name: Query
253 + type: string
254 + description: ""
255 + - name: Elapsed
256 + type: duration
257 + description: ""
258 + - name: SQL Exec Start
259 + type: string
260 + description: ""
261 + - name: Module
262 + type: string
263 + description: ""
264 + - name: Action
265 + type: string
266 + description: ""
267 + - name: Program
268 + type: string
269 + description: ""
270 + - name: Machine
271 + type: string
272 + description: ""
273 + behavior: |
274 + Queries V$SESSION and returns running statements sorted by the selected column.
275 + performance: |
276 + Queries system views and may be expensive on busy databases.
277 + security: |
278 + Query text may contain unmasked literals (potential PII).
279 + requirements: |
280 + Requires access to V$SESSION and a working SQL connection.
281 + availability: |
282 + Available when the collector can query Oracle system views; returns errors if SQL is unavailable.
283 metrics:
284 folding:
285 title: Metrics
src/go/plugin/go.d/collector/postgres/metadata.yaml
+154
@@ -222,6 +222,160 @@ modules:
222 metric: postgres.index_bloat_size_perc
223 info: bloat size percentage in db ${label:database} table ${label:table} index ${label:index}
224 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/postgres.conf
225 + functions:
226 + description: |
227 + This collector exposes real-time functions for interactive troubleshooting in the Top tab.
228 + list:
229 + - id: top-queries
230 + name: Top Queries
231 + summary: Top SQL queries from pg_stat_statements.
232 + parameters:
233 + - id: __sort
234 + name: Filter By
235 + description: Select the primary sort column (options are derived from sortable columns in the response).
236 + type: select
237 + required: true
238 + default: totalTime
239 + options: []
240 + returns:
241 + description: Aggregated query statistics from pg_stat_statements.
242 + columns:
243 + - name: Query ID
244 + type: string
245 + description: ""
246 + - name: Query
247 + type: string
248 + description: ""
249 + - name: Database
250 + type: string
251 + description: ""
252 + - name: User
253 + type: string
254 + description: ""
255 + - name: Calls
256 + type: integer
257 + description: ""
258 + - name: Total Time
259 + type: duration
260 + description: ""
261 + - name: Mean Time
262 + type: duration
263 + description: ""
264 + - name: Min Time
265 + type: duration
266 + description: ""
267 + - name: Max Time
268 + type: duration
269 + description: ""
270 + - name: Stddev Time
271 + type: duration
272 + description: ""
273 + - name: Plans
274 + type: integer
275 + description: ""
276 + - name: Total Plan Time
277 + type: duration
278 + description: ""
279 + - name: Mean Plan Time
280 + type: duration
281 + description: ""
282 + - name: Min Plan Time
283 + type: duration
284 + description: ""
285 + - name: Max Plan Time
286 + type: duration
287 + description: ""
288 + - name: Stddev Plan Time
289 + type: duration
290 + description: ""
291 + - name: Rows
292 + type: integer
293 + description: ""
294 + - name: Shared Blocks Hit
295 + type: integer
296 + description: ""
297 + - name: Shared Blocks Read
298 + type: integer
299 + description: ""
300 + - name: Shared Blocks Dirtied
301 + type: integer
302 + description: ""
303 + - name: Shared Blocks Written
304 + type: integer
305 + description: ""
306 + - name: Local Blocks Hit
307 + type: integer
308 + description: ""
309 + - name: Local Blocks Read
310 + type: integer
311 + description: ""
312 + - name: Local Blocks Dirtied
313 + type: integer
314 + description: ""
315 + - name: Local Blocks Written
316 + type: integer
317 + description: ""
318 + - name: Temp Blocks Read
319 + type: integer
320 + description: ""
321 + - name: Temp Blocks Written
322 + type: integer
323 + description: ""
324 + - name: Block Read Time
325 + type: duration
326 + description: ""
327 + - name: Block Write Time
328 + type: duration
329 + description: ""
330 + - name: WAL Records
331 + type: integer
332 + description: ""
333 + - name: WAL Full Page Images
334 + type: integer
335 + description: ""
336 + - name: WAL Bytes
337 + type: integer
338 + description: ""
339 + - name: JIT Functions
340 + type: integer
341 + description: ""
342 + - name: JIT Generation Time
343 + type: duration
344 + description: ""
345 + - name: JIT Inlining Count
346 + type: integer
347 + description: ""
348 + - name: JIT Inlining Time
349 + type: duration
350 + description: ""
351 + - name: JIT Optimization Count
352 + type: integer
353 + description: ""
354 + - name: JIT Optimization Time
355 + type: duration
356 + description: ""
357 + - name: JIT Emission Count
358 + type: integer
359 + description: ""
360 + - name: JIT Emission Time
361 + type: duration
362 + description: ""
363 + - name: Temp Block Read Time
364 + type: duration
365 + description: ""
366 + - name: Temp Block Write Time
367 + type: duration
368 + description: ""
369 + behavior: |
370 + Reads pg_stat_statements and returns the top entries sorted by the selected column.
371 + performance: |
372 + Requires pg_stat_statements and can be expensive on busy servers.
373 + security: |
374 + Query text may contain unmasked literals (potential PII).
375 + requirements: |
376 + Requires the pg_stat_statements extension installed and enabled.
377 + availability: |
378 + Available when pg_stat_statements is available and the collector is initialized.
379 metrics:
380 folding:
381 title: Metrics
src/go/plugin/go.d/collector/proxysql/metadata.yaml
+76
@@ -123,6 +123,82 @@ modules:
123 metric: proxysql.backend_status
124 info: ProxySQL backend OFFLINE_HARD (${label:host}:${label:port} hostgroup ${label:hostgroup})
125 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/proxysql.conf
126 + functions:
127 + description: |
128 + This collector exposes real-time functions for interactive troubleshooting in the Top tab.
129 + list:
130 + - id: top-queries
131 + name: Top Queries
132 + summary: Top SQL queries from ProxySQL query digest stats.
133 + parameters:
134 + - id: __sort
135 + name: Filter By
136 + description: Select the primary sort column (options are derived from sortable columns in the response).
137 + type: select
138 + required: true
139 + default: totalTime
140 + options: []
141 + returns:
142 + description: Query digest statistics from ProxySQL.
143 + columns:
144 + - name: Digest
145 + type: string
146 + description: ""
147 + - name: Query
148 + type: string
149 + description: ""
150 + - name: Schema
151 + type: string
152 + description: ""
153 + - name: User
154 + type: string
155 + description: ""
156 + - name: Hostgroup
157 + type: integer
158 + description: ""
159 + - name: Calls
160 + type: integer
161 + description: ""
162 + - name: Total Time
163 + type: duration
164 + description: ""
165 + - name: Avg Time
166 + type: duration
167 + description: ""
168 + - name: Min Time
169 + type: duration
170 + description: ""
171 + - name: Max Time
172 + type: duration
173 + description: ""
174 + - name: Rows Affected
175 + type: integer
176 + description: ""
177 + - name: Rows Sent
178 + type: integer
179 + description: ""
180 + - name: Errors
181 + type: integer
182 + description: ""
183 + - name: Warnings
184 + type: integer
185 + description: ""
186 + - name: First Seen
187 + type: string
188 + description: ""
189 + - name: Last Seen
190 + type: string
191 + description: ""
192 + behavior: |
193 + Queries stats_mysql_query_digest and returns the top entries sorted by the selected column.
194 + performance: |
195 + Uses ProxySQL stats tables and can be expensive on busy systems.
196 + security: |
197 + Query text may contain unmasked literals (potential PII).
198 + requirements: |
199 + Requires access to stats_mysql_query_digest in ProxySQL.
200 + availability: |
201 + Available when the collector can query ProxySQL stats; returns errors if the SQL connection is unavailable.
202 metrics:
203 folding:
204 title: Metrics
src/go/plugin/go.d/collector/redis/metadata.yaml
+49
@@ -184,6 +184,55 @@ modules:
184 link: https://github.com/netdata/netdata/blob/master/src/health/health.d/redis.conf
185 metric: redis.master_link_down_since_time
186 info: time elapsed since the link between master and slave is down
187 + functions:
188 + description: |
189 + This collector exposes real-time functions for interactive troubleshooting in the Top tab.
190 + list:
191 + - id: top-queries
192 + name: Top Queries
193 + summary: "Slow commands from Redis SLOWLOG. WARNING: Command arguments may contain unmasked literals (potential PII)."
194 + parameters:
195 + - id: __sort
196 + name: Filter By
197 + description: Select the primary sort column (options are derived from sortable columns in the response).
198 + type: select
199 + required: true
200 + default: duration
201 + options: []
202 + returns:
203 + description: Slowlog entries with command timing and metadata.
204 + columns:
205 + - name: ID
206 + type: integer
207 + description: ""
208 + - name: Timestamp
209 + type: timestamp
210 + description: ""
211 + - name: Command
212 + type: string
213 + description: ""
214 + - name: Command Name
215 + type: string
216 + description: ""
217 + - name: Duration
218 + type: duration
219 + description: ""
220 + - name: Client Address
221 + type: string
222 + description: ""
223 + - name: Client Name
224 + type: string
225 + description: ""
226 + behavior: |
227 + Reads Redis SLOWLOG and returns the top entries sorted by the selected column.
228 + performance: |
229 + Uses SLOWLOG GET and may return many entries; use top_queries_limit to control size.
230 + security: |
231 + Command arguments may contain unmasked literals (potential PII).
232 + requirements: |
233 + Requires access to the Redis SLOWLOG and a working connection.
234 + availability: |
235 + Available when the collector is initialized; returns 503 if the collector is still connecting.
236 metrics:
237 folding:
238 title: Metrics
src/go/plugin/go.d/collector/rethinkdb/metadata.yaml
+52
@@ -133,6 +133,58 @@ modules:
133 problems:
134 list: []
135 alerts: []
136 + functions:
137 + description: |
138 + This collector exposes real-time functions for interactive troubleshooting in the Top tab.
139 + list:
140 + - id: running-queries
141 + name: Running Queries
142 + summary: "Currently running queries from rethinkdb.jobs. WARNING: Query text may contain unmasked literals (potential PII)."
143 + parameters:
144 + - id: __sort
145 + name: Filter By
146 + description: Select the primary sort column (options are derived from sortable columns in the response).
147 + type: select
148 + required: true
149 + default: durationMs
150 + options: []
151 + returns:
152 + description: Snapshot of running queries from rethinkdb.jobs.
153 + columns:
154 + - name: Job ID
155 + type: string
156 + description: ""
157 + - name: Query
158 + type: string
159 + description: ""
160 + - name: Duration
161 + type: duration
162 + description: ""
163 + - name: Type
164 + type: string
165 + description: ""
166 + - name: User
167 + type: string
168 + description: ""
169 + - name: Client Address
170 + type: string
171 + description: ""
172 + - name: Client Port
173 + type: integer
174 + description: ""
175 + - name: Servers
176 + type: string
177 + description: ""
178 + behavior: |
179 + Queries rethinkdb.jobs and returns running queries sorted by the selected column.
180 + performance: |
181 + Uses system tables and may be expensive on busy clusters.
182 + security: |
183 + Query text may contain unmasked literals (potential PII).
184 + requirements: |
185 + Requires admin access to rethinkdb.jobs and a working connection.
186 + availability: |
187 + Available when the collector is initialized; returns 503 if the collector is still connecting.
188 metrics:
189 folding:
190 title: Metrics
src/go/plugin/go.d/collector/snmp/metadata.yaml
+94
@@ -483,6 +483,100 @@ modules:
483 priv_proto: aes256
484 priv_key: priv_protocol_passphrase
485 alerts: []
486 + functions:
487 + description: |
488 + This collector exposes real-time functions for interactive troubleshooting in the Top tab.
489 + list:
490 + - id: interfaces
491 + name: Network Interfaces
492 + summary: Network interface traffic and status metrics.
493 + parameters:
494 + - id: if_type_group
495 + name: Type Group
496 + description: Filter by interface type group.
497 + type: select
498 + required: true
499 + default: ethernet
500 + options:
501 + - id: ethernet
502 + name: Ethernet
503 + default: true
504 + - id: aggregation
505 + name: Aggregation
506 + - id: virtual
507 + name: Virtual
508 + - id: other
509 + name: Other
510 + returns:
511 + description: Table of interface traffic and status from cached SNMP data.
512 + columns:
513 + - name: Interface
514 + type: string
515 + description: ""
516 + - name: Type
517 + type: string
518 + description: ""
519 + - name: Type Group
520 + type: string
521 + description: ""
522 + - name: Admin Status
523 + type: string
524 + description: ""
525 + - name: Oper Status
526 + type: string
527 + description: ""
528 + - name: Traffic In
529 + type: float
530 + description: ""
531 + - name: Traffic Out
532 + type: float
533 + description: ""
534 + - name: Unicast In
535 + type: float
536 + description: ""
537 + - name: Unicast Out
538 + type: float
539 + description: ""
540 + - name: Broadcast In
541 + type: float
542 + description: ""
543 + - name: Broadcast Out
544 + type: float
545 + description: ""
546 + - name: Packets In
547 + type: float
548 + description: ""
549 + - name: Packets Out
550 + type: float
551 + description: ""
552 + - name: Errors In
553 + type: float
554 + description: ""
555 + - name: Errors Out
556 + type: float
557 + description: ""
558 + - name: Discards In
559 + type: float
560 + description: ""
561 + - name: Discards Out
562 + type: float
563 + description: ""
564 + - name: Multicast In
565 + type: float
566 + description: ""
567 + - name: Multicast Out
568 + type: float
569 + description: ""
570 + behavior: |
571 + Uses the latest cached SNMP interface data, filters by the selected type group, and sorts by the default column.
572 + performance: |
573 + Uses cached data only and does not trigger additional SNMP requests. Large devices may return many rows.
574 + security: |
575 + Exposes interface names and counters only.
576 + requirements: |
577 + Requires successful SNMP collection so interface data is cached.
578 + availability: |
579 + Available after the collector has completed at least one data collection; returns 503 until cache is ready.
580 metrics:
581 folding:
582 title: Metrics
src/go/plugin/go.d/collector/yugabytedb/metadata.yaml
+118
@@ -241,6 +241,124 @@ modules:
241 problems:
242 list: []
243 alerts: []
244 + functions:
245 + description: |
246 + This collector exposes real-time functions for interactive troubleshooting in the Top tab.
247 + list:
248 + - id: top-queries
249 + name: Top Queries
250 + summary: "Top SQL queries from pg_stat_statements. WARNING: Query text may contain unmasked literals (potential PII)."
251 + parameters:
252 + - id: __sort
253 + name: Filter By
254 + description: Select the primary sort column (options are derived from sortable columns in the response).
255 + type: select
256 + required: true
257 + default: totalTime
258 + options: []
259 + returns:
260 + description: Aggregated query statistics from pg_stat_statements.
261 + columns:
262 + - name: Query ID
263 + type: string
264 + description: ""
265 + - name: Query
266 + type: string
267 + description: ""
268 + - name: Database
269 + type: string
270 + description: ""
271 + - name: User
272 + type: string
273 + description: ""
274 + - name: Calls
275 + type: integer
276 + description: ""
277 + - name: Total Time
278 + type: duration
279 + description: ""
280 + - name: Mean Time
281 + type: duration
282 + description: ""
283 + - name: Min Time
284 + type: duration
285 + description: ""
286 + - name: Max Time
287 + type: duration
288 + description: ""
289 + - name: Rows
290 + type: integer
291 + description: ""
292 + - name: Stddev Time
293 + type: duration
294 + description: ""
295 + behavior: |
296 + Reads pg_stat_statements and returns the top entries sorted by the selected column.
297 + performance: |
298 + Executes SQL queries and may be expensive on busy clusters; use top_queries_limit and sql_timeout.
299 + security: |
300 + Query text may contain unmasked literals (potential PII).
301 + requirements: |
302 + Requires pg_stat_statements installed and a SQL DSN configured for YSQL.
303 + availability: |
304 + Available when YSQL is accessible; returns errors if the SQL connection is unavailable.
305 + - id: running-queries
306 + name: Running Queries
307 + summary: "Currently running SQL statements from pg_stat_activity. WARNING: Query text may contain unmasked literals (potential PII)."
308 + parameters:
309 + - id: __sort
310 + name: Filter By
311 + description: Select the primary sort column (options are derived from sortable columns in the response).
312 + type: select
313 + required: true
314 + default: elapsedMs
315 + options: []
316 + returns:
317 + description: Snapshot of currently running SQL statements.
318 + columns:
319 + - name: PID
320 + type: string
321 + description: ""
322 + - name: Query
323 + type: string
324 + description: ""
325 + - name: Database
326 + type: string
327 + description: ""
328 + - name: User
329 + type: string
330 + description: ""
331 + - name: State
332 + type: string
333 + description: ""
334 + - name: Wait Event Type
335 + type: string
336 + description: ""
337 + - name: Wait Event
338 + type: string
339 + description: ""
340 + - name: Application
341 + type: string
342 + description: ""
343 + - name: Client Address
344 + type: string
345 + description: ""
346 + - name: Query Start
347 + type: string
348 + description: ""
349 + - name: Elapsed
350 + type: duration
351 + description: ""
352 + behavior: |
353 + Reads pg_stat_activity and returns running statements sorted by the selected column.
354 + performance: |
355 + Executes SQL queries and may be expensive on busy clusters; use top_queries_limit and sql_timeout.
356 + security: |
357 + Query text may contain unmasked literals (potential PII).
358 + requirements: |
359 + Requires a SQL DSN configured for YSQL and access to pg_stat_activity.
360 + availability: |
361 + Available when YSQL is accessible; returns errors if the SQL connection is unavailable.
362 metrics:
363 folding:
364 title: Metrics