@cryptotaxi247 / netdata-1 / commits / ac68a2f06

docs: update collector function docs schema and templates (#21622)

Ilya Mashchenko committed Jan 23, 2026 at 12:14 UTC ac68a2f06a2adeb3e78bf8e0a8916554a1355138
16 files changed +767 -152
integrations/schemas/collector.json
+45 -13
@@ -414,9 +414,9 @@
414 "type": "string",
415 "description": "Function display name."
416 },
417 - "summary": {
417 + "description": {
418 "type": "string",
419 - "description": "Short summary of what the function returns."
419 + "description": "Detailed description of what the function does and returns."
420 },
421 "parameters": {
422 "type": "array",
@@ -514,11 +514,23 @@
514 "description": {
515 "type": "string",
516 "description": "Column description."
517 + },
518 + "unit": {
519 + "type": "string",
520 + "description": "Column unit, if applicable."
521 + },
522 + "visibility": {
523 + "type": "string",
524 + "description": "Whether the column is shown by default.",
525 + "enum": [
526 + "hidden"
527 + ]
528 }
529 },
530 "required": [
531 "name",
521 - "type"
532 + "type",
533 + "unit"
534 ]
535 }
536 }
@@ -528,10 +540,6 @@
540 "columns"
541 ]
542 },
531 - "behavior": {
532 - "type": "string",
533 - "description": "How the function works internally."
534 - },
543 "performance": {
544 "type": "string",
545 "description": "Performance considerations."
@@ -540,9 +548,35 @@
548 "type": "string",
549 "description": "Security/PII considerations."
550 },
543 - "requirements": {
544 - "type": "string",
545 - "description": "Prerequisites and required permissions."
551 + "prerequisites": {
552 + "type": "object",
553 + "description": "Prerequisites and required permissions.",
554 + "properties": {
555 + "list": {
556 + "type": "array",
557 + "description": "List of prerequisites.",
558 + "items": {
559 + "type": "object",
560 + "properties": {
561 + "title": {
562 + "type": "string",
563 + "description": "Short prerequisite title."
564 + },
565 + "description": {
566 + "type": "string",
567 + "description": "Prerequisite description."
568 + }
569 + },
570 + "required": [
571 + "title",
572 + "description"
573 + ]
574 + }
575 + }
576 + },
577 + "required": [
578 + "list"
579 + ]
580 },
581 "availability": {
582 "type": "string",
@@ -552,13 +586,11 @@
586 "required": [
587 "id",
588 "name",
555 - "summary",
589 + "description",
590 "parameters",
591 "returns",
558 - "behavior",
592 "performance",
593 "security",
561 - "requirements",
594 "availability"
595 ]
596 }
integrations/templates/functions.md
+19 -7
@@ -6,16 +6,28 @@
6 [% for func in entry.functions.list %]
7 ### [[ func.name ]]
8
9 +[[ func.description ]]
10 +
11 | Aspect | Description |
12 |:-------|:------------|
11 -| Name | `[[ entry.meta.module_name|capitalize ]]:[[ func.id ]]` |
12 -| Summary | [[ strfy(func.summary) ]] |
13 -| Behavior | [[ strfy(func.behavior) ]] |
13 +| Name | `[[ strfy(entry.meta.module_name)|capitalize ]]:[[ strfy(func.id) ]]` |
14 | Performance | [[ strfy(func.performance) ]] |
15 | Security | [[ strfy(func.security) ]] |
16 -| Requirements | [[ strfy(func.requirements) ]] |
16 | Availability | [[ strfy(func.availability) ]] |
17
18 +#### Prerequisites
19 +
20 +[% if func.prerequisites and func.prerequisites.list %]
21 +[% for req in func.prerequisites.list %]
22 +##### [[ req.title ]]
23 +
24 +[[ req.description ]]
25 +
26 +[% endfor %]
27 +[% else %]
28 +No additional configuration is required.
29 +[% endif %]
30 +
31 #### Parameters
32
33 [% if func.parameters %]
@@ -32,10 +44,10 @@ This function has no parameters.
44
45 [[ func.returns.description ]]
46
35 -| Column | Type | Description |
36 -|:-------|:-----|:------------|
47 +| Column | Type | Unit | Visibility | Description |
48 +|:-------|:-----|:-----|:-----------|:------------|
49 [% for col in func.returns.columns %]
38 -| [[ strfy(col.name) ]] | [[ strfy(col.type) ]] | [[ strfy(col.description) ]] |
50 +| [[ strfy(col.name) ]] | [[ strfy(col.type) ]] | [[ strfy(col.unit) ]] | [[ strfy(col.visibility) ]] | [[ strfy(col.description) ]] |
51 [% endfor %]
52
53 [% endfor %]
src/go/plugin/go.d/collector/clickhouse/metadata.yaml
+32 -5
@@ -258,7 +258,10 @@ modules:
258 list:
259 - id: top-queries
260 name: Top Queries
261 - summary: Top SQL queries from ClickHouse system.query_log.
261 + description: |
262 + Top SQL queries from ClickHouse system.query_log.
263 +
264 + Queries system.query_log, aggregates by query, and returns the top entries sorted by the selected column.
265 parameters:
266 - id: __sort
267 name: Filter By
@@ -272,60 +275,84 @@ modules:
275 columns:
276 - name: Query ID
277 type: string
278 + unit: ""
279 + visibility: hidden
280 description: ""
281 - name: Query
282 type: string
283 + unit: ""
284 description: ""
285 - name: Database
286 type: string
287 + unit: ""
288 description: ""
289 - name: User
290 type: string
291 + unit: ""
292 description: ""
293 - name: Calls
294 type: integer
295 + unit: ""
296 description: ""
297 - name: Total Time
298 type: duration
299 + unit: "milliseconds"
300 description: ""
301 - name: Avg Time
302 type: duration
303 + unit: "milliseconds"
304 description: ""
305 - name: Min Time
306 type: duration
307 + unit: "milliseconds"
308 + visibility: hidden
309 description: ""
310 - name: Max Time
311 type: duration
312 + unit: "milliseconds"
313 + visibility: hidden
314 description: ""
315 - name: Read Rows
316 type: integer
317 + unit: ""
318 description: ""
319 - name: Read Bytes
320 type: integer
321 + unit: ""
322 description: ""
323 - name: Written Rows
324 type: integer
325 + unit: ""
326 + visibility: hidden
327 description: ""
328 - name: Written Bytes
329 type: integer
330 + unit: ""
331 + visibility: hidden
332 description: ""
333 - name: Result Rows
334 type: integer
335 + unit: ""
336 description: ""
337 - name: Result Bytes
338 type: integer
339 + unit: ""
340 + visibility: hidden
341 description: ""
342 - name: Max Memory
343 type: float
344 + unit: ""
345 + visibility: hidden
346 description: ""
321 - behavior: |
322 - Queries system.query_log, aggregates by query, and returns the top entries sorted by the selected column.
347 performance: |
348 Uses system.query_log and can be expensive on busy systems. Use limits to control response size.
349 security: |
350 Query text may include sensitive literals depending on server settings.
327 - requirements: |
328 - Requires access to system.query_log on the target ClickHouse instance.
351 + prerequisites:
352 + list:
353 + - title: Grant access to system.query_log
354 + description: |
355 + Ensure the Netdata user can read system.query_log on the target ClickHouse instance.
356 availability: |
357 Available when the collector can query system tables; returns 503 if system.query_log is not available.
358 metrics:
src/go/plugin/go.d/collector/cockroachdb/metadata.yaml
+67 -11
@@ -214,7 +214,7 @@ modules:
214 - name: Multi-instance
215 description: |
216 > **Note**: When you define multiple jobs, their names must be unique.
217 -
217 +
218 Collecting metrics from local and remote instances.
219 config: |
220 jobs:
@@ -253,7 +253,10 @@ modules:
253 list:
254 - id: top-queries
255 name: Top Queries
256 - summary: Top SQL statements from crdb_internal.cluster_statement_statistics.
256 + description: |
257 + Top SQL statements from crdb_internal.cluster_statement_statistics.
258 +
259 + Queries crdb_internal.cluster_statement_statistics and returns the top entries sorted by the selected column.
260 parameters:
261 - id: __sort
262 name: Filter By
@@ -267,77 +270,112 @@ modules:
270 columns:
271 - name: Fingerprint ID
272 type: string
273 + unit: ""
274 + visibility: hidden
275 description: ""
276 - name: Query
277 type: string
278 + unit: ""
279 description: ""
280 - name: Database
281 type: string
282 + unit: ""
283 description: ""
284 - name: Application
285 type: string
286 + unit: ""
287 description: ""
288 - name: Statement Type
289 type: string
290 + unit: ""
291 + visibility: hidden
292 description: ""
293 - name: Distributed
294 type: string
295 + unit: ""
296 + visibility: hidden
297 description: ""
298 - name: Full Scan
299 type: string
300 + unit: ""
301 + visibility: hidden
302 description: ""
303 - name: Implicit Txn
304 type: string
305 + unit: ""
306 + visibility: hidden
307 description: ""
308 - name: Vectorized
309 type: string
310 + unit: ""
311 + visibility: hidden
312 description: ""
313 - name: Executions
314 type: integer
315 + unit: ""
316 description: ""
317 - name: Total Time
318 type: duration
319 + unit: "milliseconds"
320 description: ""
321 - name: Mean Time
322 type: duration
323 + unit: "milliseconds"
324 description: ""
325 - name: Run Time
326 type: duration
327 + unit: "milliseconds"
328 + visibility: hidden
329 description: ""
330 - name: Plan Time
331 type: duration
332 + unit: "milliseconds"
333 + visibility: hidden
334 description: ""
335 - name: Parse Time
336 type: duration
337 + unit: "milliseconds"
338 + visibility: hidden
339 description: ""
340 - name: Rows Read
341 type: integer
342 + unit: ""
343 description: ""
344 - name: Rows Written
345 type: integer
346 + unit: ""
347 description: ""
348 - name: Rows Returned
349 type: integer
350 + unit: ""
351 description: ""
352 - name: Bytes Read
353 type: integer
354 + unit: ""
355 + visibility: hidden
356 description: ""
357 - name: Max Retries
358 type: integer
359 + unit: ""
360 + visibility: hidden
361 description: ""
328 - behavior: |
329 - Queries crdb_internal.cluster_statement_statistics and returns the top entries sorted by the selected column.
362 performance: |
363 Executes SQL queries against system tables and may be expensive on busy clusters.
364 security: |
365 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.
366 + prerequisites:
367 + list:
368 + - title: Grant VIEWACTIVITY access to cluster statement stats
369 + description: |
370 + Use a SQL user with VIEWACTIVITY (or VIEWACTIVITYREDACTED) and access to crdb_internal.cluster_statement_statistics.
371 availability: |
372 Requires SQL DSN configuration and access to system tables; returns errors if DSN is missing or SQL is unavailable.
373 - id: running-queries
374 name: Running Queries
340 - summary: Currently running SQL statements from SHOW CLUSTER STATEMENTS.
375 + description: |
376 + Currently running SQL statements from SHOW CLUSTER STATEMENTS.
377 +
378 + Queries SHOW CLUSTER STATEMENTS and returns running statements sorted by the selected column.
379 parameters:
380 - id: __sort
381 name: Filter By
@@ -351,45 +389,63 @@ modules:
389 columns:
390 - name: Query ID
391 type: string
392 + unit: ""
393 + visibility: hidden
394 description: ""
395 - name: Query
396 type: string
397 + unit: ""
398 description: ""
399 - name: User
400 type: string
401 + unit: ""
402 description: ""
403 - name: Application
404 type: string
405 + unit: ""
406 description: ""
407 - name: Client Address
408 type: string
409 + unit: ""
410 + visibility: hidden
411 description: ""
412 - name: Node ID
413 type: string
414 + unit: ""
415 + visibility: hidden
416 description: ""
417 - name: Session ID
418 type: string
419 + unit: ""
420 + visibility: hidden
421 description: ""
422 - name: Phase
423 type: string
424 + unit: ""
425 description: ""
426 - name: Distributed
427 type: string
428 + unit: ""
429 + visibility: hidden
430 description: ""
431 - name: Start Time
432 type: string
433 + unit: ""
434 + visibility: hidden
435 description: ""
436 - name: Elapsed
437 type: duration
438 + unit: "milliseconds"
439 description: ""
385 - behavior: |
386 - Queries SHOW CLUSTER STATEMENTS and returns running statements sorted by the selected column.
440 performance: |
441 Executes SQL queries against system tables and may be expensive on busy clusters.
442 security: |
443 Query text may contain unmasked literals (potential PII).
391 - requirements: |
392 - Requires a SQL user with VIEWACTIVITY (or VIEWACTIVITYREDACTED) and access to system tables.
444 + prerequisites:
445 + list:
446 + - title: Grant VIEWACTIVITY access to system tables
447 + description: |
448 + Use a SQL user with VIEWACTIVITY (or VIEWACTIVITYREDACTED) and access to system tables.
449 availability: |
450 Requires SQL DSN configuration and access to system tables; returns errors if DSN is missing or SQL is unavailable.
451 metrics:
src/go/plugin/go.d/collector/couchbase/metadata.yaml
+26 -6
@@ -178,7 +178,7 @@ modules:
178 - name: Multi-instance
179 description: |
180 > **Note**: When you define multiple jobs, their names must be unique.
181 -
181 +
182 Collecting metrics from local and remote instances.
183 config: |
184 jobs:
@@ -197,7 +197,10 @@ modules:
197 list:
198 - id: top-queries
199 name: Top Queries
200 - summary: Top N1QL requests from system:completed_requests.
200 + description: |
201 + Top N1QL requests from system:completed_requests.
202 +
203 + Queries the system:completed_requests keyspace and returns the top entries sorted by the selected column.
204 parameters:
205 - id: __sort
206 name: Filter By
@@ -211,45 +214,62 @@ modules:
214 columns:
215 - name: Request ID
216 type: string
217 + unit: ""
218 + visibility: hidden
219 description: ""
220 - name: Request Time
221 type: timestamp
222 + unit: ""
223 description: ""
224 - name: Statement
225 type: string
226 + unit: ""
227 description: ""
228 - name: Elapsed Time
229 type: duration
230 + unit: "milliseconds"
231 description: ""
232 - name: Service Time
233 type: duration
234 + unit: "milliseconds"
235 description: ""
236 - name: Result Count
237 type: integer
238 + unit: ""
239 description: ""
240 - name: Result Size
241 type: integer
242 + unit: ""
243 + visibility: hidden
244 description: ""
245 - name: Error Count
246 type: integer
247 + unit: ""
248 + visibility: hidden
249 description: ""
250 - name: Warning Count
251 type: integer
252 + unit: ""
253 + visibility: hidden
254 description: ""
255 - name: User
256 type: string
257 + unit: ""
258 description: ""
259 - name: Client Context ID
260 type: string
261 + unit: ""
262 + visibility: hidden
263 description: ""
245 - behavior: |
246 - Queries the system:completed_requests keyspace and returns the top entries sorted by the selected column.
264 performance: |
265 Runs N1QL queries against system keyspaces; use top_queries_limit to control response size.
266 security: |
267 Query text may include sensitive literals depending on workload.
251 - requirements: |
252 - Requires access to the system:completed_requests keyspace and N1QL service.
268 + prerequisites:
269 + list:
270 + - title: Grant access to system:completed_requests
271 + description: |
272 + Ensure the user can query system:completed_requests and the N1QL service is available.
273 availability: |
274 Available when the collector can query system keyspaces; returns 503 until the collector is initialized.
275 metrics:
src/go/plugin/go.d/collector/elasticsearch/metadata.yaml
+20 -7
@@ -52,7 +52,7 @@ modules:
52 auto_detection:
53 description: |
54 By default, it detects instances running on localhost by attempting to connect to port 9200:
55 -
55 +
56 - http://127.0.0.1:9200
57 - https://127.0.0.1:9200
58 limits:
@@ -243,7 +243,7 @@ modules:
243 - name: Multi-instance
244 description: |
245 > **Note**: When you define multiple jobs, their names must be unique.
246 -
246 +
247 Collecting metrics from local and remote instances.
248 config: |
249 jobs:
@@ -282,7 +282,10 @@ modules:
282 list:
283 - id: top-queries
284 name: Top Queries
285 - summary: Running queries from the Elasticsearch Tasks API.
285 + description: |
286 + Running queries from the Elasticsearch Tasks API.
287 +
288 + Calls the Tasks API and returns running task details sorted by the selected column.
289 parameters:
290 - id: __sort
291 name: Filter By
@@ -296,42 +299,52 @@ modules:
299 columns:
300 - name: Task ID
301 type: string
302 + unit: ""
303 + visibility: hidden
304 description: ""
305 - name: Node ID
306 type: string
307 + unit: ""
308 description: ""
309 - name: Node Name
310 type: string
311 + unit: ""
312 description: ""
313 - name: Action
314 type: string
315 + unit: ""
316 description: ""
317 - name: Type
318 type: string
319 + unit: ""
320 + visibility: hidden
321 description: ""
322 - name: Description
323 type: string
324 + unit: ""
325 description: ""
326 - name: Start Time
327 type: timestamp
328 + unit: ""
329 description: ""
330 - name: Running Time
331 type: duration
332 + unit: "milliseconds"
333 description: ""
334 - name: Cancellable
335 type: boolean
336 + unit: ""
337 + visibility: hidden
338 description: ""
339 - name: Cancelled
340 type: boolean
341 + unit: ""
342 + visibility: hidden
343 description: ""
327 - behavior: |
328 - Calls the Tasks API and returns running task details sorted by the selected column.
344 performance: |
345 Queries the Tasks API; on large clusters this may return many rows.
346 security: |
347 Task descriptions may include query details.
333 - requirements: |
334 - Requires access to the Tasks API on the target Elasticsearch node.
348 availability: |
349 Available when the collector can query the Tasks API; returns 503 until the collector is initialized.
350 metrics:
src/go/plugin/go.d/collector/mongodb/metadata.yaml
+69 -21
@@ -23,9 +23,9 @@ modules:
23 data_collection:
24 metrics_description: |
25 This collector monitors MongoDB servers.
26 -
26 +
27 Executed queries:
28 -
28 +
29 - [serverStatus](https://docs.mongodb.com/manual/reference/command/serverStatus/)
30 - [dbStats](https://docs.mongodb.com/manual/reference/command/dbStats/)
31 - [replSetGetStatus](https://www.mongodb.com/docs/manual/reference/command/replSetGetStatus/)
@@ -49,25 +49,25 @@ modules:
49 - title: Create a read-only user
50 description: |
51 Create a read-only user for Netdata in the admin database.
52 -
52 +
53 - Authenticate as the admin user:
54 -
54 +
55 ```bash
56 use admin
57 db.auth("admin", "<MONGODB_ADMIN_PASSWORD>")
58 ```
59 -
59 +
60 - Create a user:
61 -
61 +
62 ```bash
63 db.createUser({
64 - "user":"netdata",
65 - "pwd": "<UNIQUE_PASSWORD>",
66 - "roles" : [
67 - {role: 'read', db: 'admin' },
68 - {role: 'clusterMonitor', db: 'admin'},
69 - {role: 'read', db: 'local' }
70 - ]
64 + "user":"netdata",
65 + "pwd": "<UNIQUE_PASSWORD>",
66 + "roles" : [
67 + {role: 'read', db: 'admin' },
68 + {role: 'clusterMonitor', db: 'admin'},
69 + {role: 'read', db: 'local' }
70 + ]
71 })
72 ```
73 configuration:
@@ -152,7 +152,7 @@ modules:
152 - name: Multi-instance
153 description: |
154 > **Note**: When you define multiple jobs, their names must be unique.
155 -
155 +
156 Local and remote instances.
157 config: |
158 jobs:
@@ -171,7 +171,10 @@ modules:
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)."
174 + description: |
175 + Top queries from MongoDB Profiler (system.profile). WARNING: Query text may contain unmasked literals (potential PII).
176 +
177 + Reads from system.profile and returns the top profiled queries sorted by the selected column.
178 parameters:
179 - id: __sort
180 name: Filter By
@@ -185,96 +188,141 @@ modules:
188 columns:
189 - name: Timestamp
190 type: timestamp
191 + unit: ""
192 description: ""
193 - name: Namespace
194 type: string
195 + unit: ""
196 description: ""
197 - name: Operation
198 type: string
199 + unit: ""
200 description: ""
201 - name: Query
202 type: string
203 + unit: ""
204 description: ""
205 - name: Execution Time
206 type: duration
207 + unit: "seconds"
208 description: ""
209 - name: Docs Examined
210 type: integer
211 + unit: ""
212 description: ""
213 - name: Keys Examined
214 type: integer
215 + unit: ""
216 description: ""
217 - name: Docs Returned
218 type: integer
219 + unit: ""
220 description: ""
221 - name: Plan Summary
222 type: string
223 + unit: ""
224 description: ""
225 - name: Client
226 type: string
227 + unit: ""
228 description: ""
229 - name: User
230 type: string
231 + unit: ""
232 description: ""
233 - name: Docs Deleted
234 type: integer
235 + unit: ""
236 + visibility: hidden
237 description: ""
238 - name: Docs Inserted
239 type: integer
240 + unit: ""
241 + visibility: hidden
242 description: ""
243 - name: Docs Modified
244 type: integer
245 + unit: ""
246 + visibility: hidden
247 description: ""
248 - name: Response Length
249 type: integer
250 + unit: ""
251 + visibility: hidden
252 description: ""
253 - name: Num Yield
254 type: integer
255 + unit: ""
256 + visibility: hidden
257 description: ""
258 - name: App Name
259 type: string
260 + unit: ""
261 description: ""
262 - name: Cursor Exhausted
263 type: string
264 + unit: ""
265 + visibility: hidden
266 description: ""
267 - name: Has Sort Stage
268 type: string
269 + unit: ""
270 + visibility: hidden
271 description: ""
272 - name: Uses Disk
273 type: string
274 + unit: ""
275 + visibility: hidden
276 description: ""
277 - name: From Multi Planner
278 type: string
279 + unit: ""
280 + visibility: hidden
281 description: ""
282 - name: Replanned
283 type: string
284 + unit: ""
285 + visibility: hidden
286 description: ""
287 - name: Query Hash
288 type: string
289 + unit: ""
290 + visibility: hidden
291 description: ""
292 - name: Plan Cache Key
293 type: string
294 + unit: ""
295 + visibility: hidden
296 description: ""
297 - name: Planning Time
298 type: duration
299 + unit: "seconds"
300 + visibility: hidden
301 description: ""
302 - name: CPU Time
303 type: duration
304 + unit: "seconds"
305 + visibility: hidden
306 description: ""
307 - name: Query Framework
308 type: string
309 + unit: ""
310 + visibility: hidden
311 description: ""
312 - name: Query Shape Hash
313 type: string
314 + unit: ""
315 + visibility: hidden
316 description: ""
270 - behavior: |
271 - Reads from system.profile and returns the top profiled queries sorted by the selected column.
317 performance: |
318 Requires profiling and reads from system.profile; may add load on busy systems.
319 security: |
320 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.
321 + prerequisites:
322 + list:
323 + - title: Enable MongoDB profiling
324 + description: |
325 + Enable profiling on the target databases and set top_queries_function_enabled to true.
326 availability: |
327 Available when profiling is enabled and the collector is initialized; returns 403 if disabled in config.
328 metrics:
@@ -284,9 +332,9 @@ modules:
332 availability: []
333 description: |
334 - WireTiger metrics are available only if [WiredTiger](https://docs.mongodb.com/v6.0/core/wiredtiger/) is used as the
287 - storage engine.
335 + storage engine.
336 - Sharding metrics are available on shards only
289 - for [mongos](https://www.mongodb.com/docs/manual/reference/program/mongos/).
337 + for [mongos](https://www.mongodb.com/docs/manual/reference/program/mongos/).
338 scopes:
339 - name: global
340 description: These metrics refer to the entire monitored application.
src/go/plugin/go.d/collector/mssql/metadata.yaml
+115 -5
@@ -232,7 +232,10 @@ modules:
232 list:
233 - id: top-queries
234 name: Top Queries
235 - summary: Top SQL queries from Query Store.
235 + description: |
236 + Top SQL queries from Query Store.
237 +
238 + Queries Query Store runtime statistics and returns the top entries sorted by the selected column.
239 parameters:
240 - id: __sort
241 name: Filter By
@@ -246,192 +249,299 @@ modules:
249 columns:
250 - name: Query Hash
251 type: string
252 + unit: ""
253 + visibility: hidden
254 description: ""
255 - name: Query
256 type: string
257 + unit: ""
258 description: ""
259 - name: Database
260 type: string
261 + unit: ""
262 description: ""
263 - name: Calls
264 type: integer
265 + unit: ""
266 description: ""
267 - name: Total Time
268 type: duration
269 + unit: "milliseconds"
270 description: ""
271 - name: Avg Time
272 type: duration
273 + unit: "milliseconds"
274 description: ""
275 - name: Last Time
276 type: duration
277 + unit: "milliseconds"
278 + visibility: hidden
279 description: ""
280 - name: Min Time
281 type: duration
282 + unit: "milliseconds"
283 + visibility: hidden
284 description: ""
285 - name: Max Time
286 type: duration
287 + unit: "milliseconds"
288 + visibility: hidden
289 description: ""
290 - name: StdDev Time
291 type: duration
292 + unit: "milliseconds"
293 + visibility: hidden
294 description: ""
295 - name: Avg CPU
296 type: duration
297 + unit: "milliseconds"
298 description: ""
299 - name: Last CPU
300 type: duration
301 + unit: "milliseconds"
302 + visibility: hidden
303 description: ""
304 - name: Min CPU
305 type: duration
306 + unit: "milliseconds"
307 + visibility: hidden
308 description: ""
309 - name: Max CPU
310 type: duration
311 + unit: "milliseconds"
312 + visibility: hidden
313 description: ""
314 - name: StdDev CPU
315 type: duration
316 + unit: "milliseconds"
317 + visibility: hidden
318 description: ""
319 - name: Avg Logical Reads
320 type: float
321 + unit: ""
322 description: ""
323 - name: Last Logical Reads
324 type: integer
325 + unit: ""
326 + visibility: hidden
327 description: ""
328 - name: Min Logical Reads
329 type: integer
330 + unit: ""
331 + visibility: hidden
332 description: ""
333 - name: Max Logical Reads
334 type: integer
335 + unit: ""
336 + visibility: hidden
337 description: ""
338 - name: StdDev Logical Reads
339 type: float
340 + unit: ""
341 + visibility: hidden
342 description: ""
343 - name: Avg Logical Writes
344 type: float
345 + unit: ""
346 description: ""
347 - name: Last Logical Writes
348 type: integer
349 + unit: ""
350 + visibility: hidden
351 description: ""
352 - name: Min Logical Writes
353 type: integer
354 + unit: ""
355 + visibility: hidden
356 description: ""
357 - name: Max Logical Writes
358 type: integer
359 + unit: ""
360 + visibility: hidden
361 description: ""
362 - name: StdDev Logical Writes
363 type: float
364 + unit: ""
365 + visibility: hidden
366 description: ""
367 - name: Avg Physical Reads
368 type: float
369 + unit: ""
370 description: ""
371 - name: Last Physical Reads
372 type: integer
373 + unit: ""
374 + visibility: hidden
375 description: ""
376 - name: Min Physical Reads
377 type: integer
378 + unit: ""
379 + visibility: hidden
380 description: ""
381 - name: Max Physical Reads
382 type: integer
383 + unit: ""
384 + visibility: hidden
385 description: ""
386 - name: StdDev Physical Reads
387 type: float
388 + unit: ""
389 + visibility: hidden
390 description: ""
391 - name: Avg CLR Time
392 type: duration
393 + unit: "milliseconds"
394 + visibility: hidden
395 description: ""
396 - name: Last CLR Time
397 type: duration
398 + unit: "milliseconds"
399 + visibility: hidden
400 description: ""
401 - name: Min CLR Time
402 type: duration
403 + unit: "milliseconds"
404 + visibility: hidden
405 description: ""
406 - name: Max CLR Time
407 type: duration
408 + unit: "milliseconds"
409 + visibility: hidden
410 description: ""
411 - name: StdDev CLR Time
412 type: duration
413 + unit: "milliseconds"
414 + visibility: hidden
415 description: ""
416 - name: Avg DOP
417 type: float
418 + unit: ""
419 description: ""
420 - name: Last DOP
421 type: integer
422 + unit: ""
423 + visibility: hidden
424 description: ""
425 - name: Min DOP
426 type: integer
427 + unit: ""
428 + visibility: hidden
429 description: ""
430 - name: Max DOP
431 type: integer
432 + unit: ""
433 + visibility: hidden
434 description: ""
435 - name: StdDev DOP
436 type: float
437 + unit: ""
438 + visibility: hidden
439 description: ""
440 - name: Avg Memory (8KB pages)
441 type: float
442 + unit: ""
443 description: ""
444 - name: Last Memory (8KB pages)
445 type: integer
446 + unit: ""
447 + visibility: hidden
448 description: ""
449 - name: Min Memory (8KB pages)
450 type: integer
451 + unit: ""
452 + visibility: hidden
453 description: ""
454 - name: Max Memory (8KB pages)
455 type: integer
456 + unit: ""
457 + visibility: hidden
458 description: ""
459 - name: StdDev Memory
460 type: float
461 + unit: ""
462 + visibility: hidden
463 description: ""
464 - name: Avg Rows
465 type: float
466 + unit: ""
467 description: ""
468 - name: Last Rows
469 type: integer
470 + unit: ""
471 + visibility: hidden
472 description: ""
473 - name: Min Rows
474 type: integer
475 + unit: ""
476 + visibility: hidden
477 description: ""
478 - name: Max Rows
479 type: integer
480 + unit: ""
481 + visibility: hidden
482 description: ""
483 - name: StdDev Rows
484 type: float
485 + unit: ""
486 + visibility: hidden
487 description: ""
488 - name: Avg Log Bytes
489 type: float
490 + unit: ""
491 description: ""
492 - name: Last Log Bytes
493 type: integer
494 + unit: ""
495 + visibility: hidden
496 description: ""
497 - name: Min Log Bytes
498 type: integer
499 + unit: ""
500 + visibility: hidden
501 description: ""
502 - name: Max Log Bytes
503 type: integer
504 + unit: ""
505 + visibility: hidden
506 description: ""
507 - name: StdDev Log Bytes
508 type: float
509 + unit: ""
510 + visibility: hidden
511 description: ""
512 - name: Avg TempDB (8KB pages)
513 type: float
514 + unit: ""
515 description: ""
516 - name: Last TempDB (8KB pages)
517 type: integer
518 + unit: ""
519 + visibility: hidden
520 description: ""
521 - name: Min TempDB (8KB pages)
522 type: integer
523 + unit: ""
524 + visibility: hidden
525 description: ""
526 - name: Max TempDB (8KB pages)
527 type: integer
528 + unit: ""
529 + visibility: hidden
530 description: ""
531 - name: StdDev TempDB
532 type: float
533 + unit: ""
534 + visibility: hidden
535 description: ""
427 - behavior: |
428 - Queries Query Store runtime statistics and returns the top entries sorted by the selected column.
536 performance: |
537 Uses Query Store and can be expensive on busy instances.
538 security: |
539 Query Store may contain unmasked literals (potential PII).
433 - requirements: |
434 - Requires Query Store enabled and query_store_function_enabled set to true.
540 + prerequisites:
541 + list:
542 + - title: Enable Query Store functions
543 + description: |
544 + Enable Query Store and set query_store_function_enabled to true.
545 availability: |
546 Available when Query Store is enabled and the collector is initialized; returns 403 if disabled in config.
547 metrics:
src/go/plugin/go.d/collector/mysql/metadata.yaml
+76 -18
@@ -67,7 +67,7 @@ modules:
67 - title: Create netdata user
68 description: |
69 A user account should have the following [permissions](https://dev.mysql.com/doc/refman/8.0/en/privileges-provided.html):
70 -
70 +
71 - [`USAGE`](https://dev.mysql.com/doc/refman/8.0/en/privileges-provided.html#priv_usage)
72 - [`REPLICATION CLIENT`](https://dev.mysql.com/doc/refman/8.0/en/privileges-provided.html#priv_replication-client)
73 - [`PROCESS`](https://dev.mysql.com/doc/refman/8.0/en/privileges-provided.html#priv_process)
@@ -76,21 +76,21 @@ modules:
76
77 - **MySQL and MariaDB < 10.5.9**
78
79 - ```mysql
80 - CREATE USER 'netdata'@'localhost';
81 - GRANT USAGE, REPLICATION CLIENT, PROCESS ON *.* TO 'netdata'@'localhost';
82 - FLUSH PRIVILEGES;
83 - ```
79 + ```mysql
80 + CREATE USER 'netdata'@'localhost';
81 + GRANT USAGE, REPLICATION CLIENT, PROCESS ON *.* TO 'netdata'@'localhost';
82 + FLUSH PRIVILEGES;
83 + ```
84
85 - **MariaDB >= 10.5.9**
86
87 - For MariaDB 10.5.9 and later, use the `SLAVE MONITOR` privilege instead of `REPLICATION CLIENT`:
87 + For MariaDB 10.5.9 and later, use the `SLAVE MONITOR` privilege instead of `REPLICATION CLIENT`:
88
89 - ```mysql
90 - CREATE USER 'netdata'@'localhost';
91 - GRANT USAGE, SLAVE MONITOR, PROCESS ON *.* TO 'netdata'@'localhost';
92 - FLUSH PRIVILEGES;
93 - ```
89 + ```mysql
90 + CREATE USER 'netdata'@'localhost';
91 + GRANT USAGE, SLAVE MONITOR, PROCESS ON *.* TO 'netdata'@'localhost';
92 + FLUSH PRIVILEGES;
93 + ```
94
95 The `netdata` user will have the ability to connect to the MySQL server on localhost without a password.
96 It will only be able to gather statistics without being able to alter or affect operations in any way.
@@ -168,7 +168,7 @@ modules:
168 - name: Multi-instance
169 description: |
170 > **Note**: When you define multiple jobs, their names must be unique.
171 -
171 +
172 Local and remote instances.
173 config: |
174 jobs:
@@ -235,7 +235,10 @@ modules:
235 list:
236 - id: top-queries
237 name: Top Queries
238 - summary: Top SQL queries from performance_schema.
238 + description: |
239 + Top SQL queries from performance_schema.
240 +
241 + Reads performance_schema statement digest tables and returns the top entries sorted by the selected column.
242 parameters:
243 - id: __sort
244 name: Filter By
@@ -249,126 +252,181 @@ modules:
252 columns:
253 - name: Digest
254 type: string
255 + unit: ""
256 + visibility: hidden
257 description: ""
258 - name: Query
259 type: string
260 + unit: ""
261 description: ""
262 - name: Schema
263 type: string
264 + unit: ""
265 description: ""
266 - name: Calls
267 type: integer
268 + unit: ""
269 description: ""
270 - name: Total Time
271 type: duration
272 + unit: "milliseconds"
273 description: ""
274 - name: Min Time
275 type: duration
276 + unit: "milliseconds"
277 + visibility: hidden
278 description: ""
279 - name: Avg Time
280 type: duration
281 + unit: "milliseconds"
282 description: ""
283 - name: Max Time
284 type: duration
285 + unit: "milliseconds"
286 + visibility: hidden
287 description: ""
288 - name: Lock Time
289 type: duration
290 + unit: "milliseconds"
291 description: ""
292 - name: Errors
293 type: integer
294 + unit: ""
295 description: ""
296 - name: Warnings
297 type: integer
298 + unit: ""
299 description: ""
300 - name: Rows Affected
301 type: integer
302 + unit: ""
303 description: ""
304 - name: Rows Sent
305 type: integer
306 + unit: ""
307 description: ""
308 - name: Rows Examined
309 type: integer
310 + unit: ""
311 description: ""
312 - name: Temp Disk Tables
313 type: integer
314 + unit: ""
315 description: ""
316 - name: Temp Tables
317 type: integer
318 + unit: ""
319 description: ""
320 - name: Full Joins
321 type: integer
322 + unit: ""
323 description: ""
324 - name: Full Range Joins
325 type: integer
326 + unit: ""
327 + visibility: hidden
328 description: ""
329 - name: Select Range
330 type: integer
331 + unit: ""
332 + visibility: hidden
333 description: ""
334 - name: Select Range Check
335 type: integer
336 + unit: ""
337 + visibility: hidden
338 description: ""
339 - name: Select Scan
340 type: integer
341 + unit: ""
342 description: ""
343 - name: Sort Merge Passes
344 type: integer
345 + unit: ""
346 + visibility: hidden
347 description: ""
348 - name: Sort Range
349 type: integer
350 + unit: ""
351 + visibility: hidden
352 description: ""
353 - name: Sort Rows
354 type: integer
355 + unit: ""
356 description: ""
357 - name: Sort Scan
358 type: integer
359 + unit: ""
360 + visibility: hidden
361 description: ""
362 - name: No Index Used
363 type: integer
364 + unit: ""
365 description: ""
366 - name: No Good Index Used
367 type: integer
368 + unit: ""
369 + visibility: hidden
370 description: ""
371 - name: First Seen
372 type: string
373 + unit: ""
374 + visibility: hidden
375 description: ""
376 - name: Last Seen
377 type: string
378 + unit: ""
379 + visibility: hidden
380 description: ""
381 - name: P95 Time
382 type: duration
383 + unit: "milliseconds"
384 description: ""
385 - name: P99 Time
386 type: duration
387 + unit: "milliseconds"
388 description: ""
389 - name: P99.9 Time
390 type: duration
391 + unit: "milliseconds"
392 + visibility: hidden
393 description: ""
394 - name: Sample Query
395 type: string
396 + unit: ""
397 + visibility: hidden
398 description: ""
399 - name: Sample Seen
400 type: string
401 + unit: ""
402 + visibility: hidden
403 description: ""
404 - name: Sample Time
405 type: duration
406 + unit: "milliseconds"
407 + visibility: hidden
408 description: ""
409 - name: CPU Time
410 type: duration
411 + unit: "milliseconds"
412 description: ""
413 - name: Max Controlled Memory
414 type: integer
415 + unit: ""
416 description: ""
417 - name: Max Total Memory
418 type: integer
419 + unit: ""
420 description: ""
364 - behavior: |
365 - Reads performance_schema statement digest tables and returns the top entries sorted by the selected column.
421 performance: |
422 Requires performance_schema and can be expensive on busy servers.
423 security: |
424 Query text may contain unmasked literals (potential PII).
370 - requirements: |
371 - Requires performance_schema enabled and access to events_statements_summary_by_digest.
425 + prerequisites:
426 + list:
427 + - title: Enable performance_schema digest tables
428 + description: |
429 + Enable performance_schema and grant access to events_statements_summary_by_digest.
430 availability: |
431 Available when performance_schema tables are accessible and the collector is initialized.
432 metrics:
src/go/plugin/go.d/collector/oracledb/metadata.yaml
+56 -10
@@ -156,7 +156,10 @@ modules:
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)."
159 + description: |
160 + Top SQL statements from V$SQLSTATS. WARNING: Query text may contain unmasked literals (potential PII).
161 +
162 + Queries V$SQLSTATS and returns the top entries sorted by the selected column.
163 parameters:
164 - id: __sort
165 name: Filter By
@@ -170,59 +173,82 @@ modules:
173 columns:
174 - name: SQL ID
175 type: string
176 + unit: ""
177 + visibility: hidden
178 description: ""
179 - name: Query
180 type: string
181 + unit: ""
182 description: ""
183 - name: Schema
184 type: string
185 + unit: ""
186 description: ""
187 - name: Executions
188 type: integer
189 + unit: ""
190 description: ""
191 - name: Total Time
192 type: duration
193 + unit: "milliseconds"
194 description: ""
195 - name: Avg Time
196 type: duration
197 + unit: "milliseconds"
198 description: ""
199 - name: CPU Time
200 type: duration
201 + unit: "milliseconds"
202 description: ""
203 - name: Buffer Gets
204 type: integer
205 + unit: ""
206 description: ""
207 - name: Disk Reads
208 type: integer
209 + unit: ""
210 description: ""
211 - name: Rows Processed
212 type: integer
213 + unit: ""
214 description: ""
215 - name: Parse Calls
216 type: integer
217 + unit: ""
218 + visibility: hidden
219 description: ""
220 - name: Module
221 type: string
222 + unit: ""
223 + visibility: hidden
224 description: ""
225 - name: Action
226 type: string
227 + unit: ""
228 + visibility: hidden
229 description: ""
230 - name: Last Active
231 type: string
232 + unit: ""
233 + visibility: hidden
234 description: ""
213 - behavior: |
214 - Queries V$SQLSTATS and returns the top entries sorted by the selected column.
235 performance: |
236 Queries system views and may be expensive on busy databases.
237 security: |
238 Query text may contain unmasked literals (potential PII).
219 - requirements: |
220 - Requires access to V$SQLSTATS and a working SQL connection.
239 + prerequisites:
240 + list:
241 + - title: Grant access to V$SQLSTATS
242 + description: |
243 + Use a SQL user with access to V$SQLSTATS and a working SQL connection.
244 availability: |
245 Available when the collector can query Oracle system views; returns errors if SQL is unavailable.
246 - id: running-queries
247 name: Running Queries
225 - summary: "Currently running SQL statements from V$SESSION. WARNING: Query text may contain unmasked literals (potential PII)."
248 + description: |
249 + Currently running SQL statements from V$SESSION. WARNING: Query text may contain unmasked literals (potential PII).
250 +
251 + Queries V$SESSION and returns running statements sorted by the selected column.
252 parameters:
253 - id: __sort
254 name: Filter By
@@ -236,48 +262,68 @@ modules:
262 columns:
263 - name: Session
264 type: string
265 + unit: ""
266 description: ""
267 - name: User
268 type: string
269 + unit: ""
270 description: ""
271 - name: Status
272 type: string
273 + unit: ""
274 description: ""
275 - name: Type
276 type: string
277 + unit: ""
278 + visibility: hidden
279 description: ""
280 - name: SQL ID
281 type: string
282 + unit: ""
283 + visibility: hidden
284 description: ""
285 - name: Query
286 type: string
287 + unit: ""
288 description: ""
289 - name: Elapsed
290 type: duration
291 + unit: "milliseconds"
292 description: ""
293 - name: SQL Exec Start
294 type: string
295 + unit: ""
296 + visibility: hidden
297 description: ""
298 - name: Module
299 type: string
300 + unit: ""
301 + visibility: hidden
302 description: ""
303 - name: Action
304 type: string
305 + unit: ""
306 + visibility: hidden
307 description: ""
308 - name: Program
309 type: string
310 + unit: ""
311 + visibility: hidden
312 description: ""
313 - name: Machine
314 type: string
315 + unit: ""
316 + visibility: hidden
317 description: ""
273 - behavior: |
274 - Queries V$SESSION and returns running statements sorted by the selected column.
318 performance: |
319 Queries system views and may be expensive on busy databases.
320 security: |
321 Query text may contain unmasked literals (potential PII).
279 - requirements: |
280 - Requires access to V$SESSION and a working SQL connection.
322 + prerequisites:
323 + list:
324 + - title: Grant access to V$SESSION
325 + description: |
326 + Use a SQL user with access to V$SESSION and a working SQL connection.
327 availability: |
328 Available when the collector can query Oracle system views; returns errors if SQL is unavailable.
329 metrics:
src/go/plugin/go.d/collector/postgres/metadata.yaml
+85 -10
@@ -39,7 +39,7 @@ modules:
39 auto_detection:
40 description: |
41 By default, it detects instances running on localhost by trying to connect as root and netdata using known PostgreSQL TCP and UNIX sockets:
42 -
42 +
43 - 127.0.0.1:5432
44 - /var/run/postgresql/
45 limits:
@@ -60,14 +60,14 @@ modules:
60 description: |
61 Create a user with granted `pg_monitor`
62 or `pg_read_all_stat` [built-in role](https://www.postgresql.org/docs/current/predefined-roles.html).
63 -
63 +
64 To create the `netdata` user with these permissions, execute the following in the psql session, as a user with CREATEROLE privileges:
65 -
65 +
66 ```postgresql
67 CREATE USER netdata;
68 GRANT pg_monitor TO netdata;
69 ```
70 -
70 +
71 After creating the new user, restart the Netdata Agent with `sudo systemctl restart netdata`, or
72 the [appropriate method](/docs/netdata-agent/start-stop-restart.md) for your
73 system.
@@ -153,7 +153,7 @@ modules:
153 - name: Multi-instance
154 description: |
155 > **Note**: When you define multiple jobs, their names must be unique.
156 -
156 +
157 Local and remote instances.
158 config: |
159 jobs:
@@ -228,7 +228,10 @@ modules:
228 list:
229 - id: top-queries
230 name: Top Queries
231 - summary: Top SQL queries from pg_stat_statements.
231 + description: |
232 + Top SQL queries from pg_stat_statements.
233 +
234 + Reads pg_stat_statements and returns the top entries sorted by the selected column.
235 parameters:
236 - id: __sort
237 name: Filter By
@@ -242,138 +245,210 @@ modules:
245 columns:
246 - name: Query ID
247 type: string
248 + unit: ""
249 + visibility: hidden
250 description: ""
251 - name: Query
252 type: string
253 + unit: ""
254 description: ""
255 - name: Database
256 type: string
257 + unit: ""
258 description: ""
259 - name: User
260 type: string
261 + unit: ""
262 description: ""
263 - name: Calls
264 type: integer
265 + unit: ""
266 description: ""
267 - name: Total Time
268 type: duration
269 + unit: "milliseconds"
270 description: ""
271 - name: Mean Time
272 type: duration
273 + unit: "milliseconds"
274 description: ""
275 - name: Min Time
276 type: duration
277 + unit: "milliseconds"
278 + visibility: hidden
279 description: ""
280 - name: Max Time
281 type: duration
282 + unit: "milliseconds"
283 + visibility: hidden
284 description: ""
285 - name: Stddev Time
286 type: duration
287 + unit: "milliseconds"
288 + visibility: hidden
289 description: ""
290 - name: Plans
291 type: integer
292 + unit: ""
293 + visibility: hidden
294 description: ""
295 - name: Total Plan Time
296 type: duration
297 + unit: "milliseconds"
298 + visibility: hidden
299 description: ""
300 - name: Mean Plan Time
301 type: duration
302 + unit: "milliseconds"
303 + visibility: hidden
304 description: ""
305 - name: Min Plan Time
306 type: duration
307 + unit: "milliseconds"
308 + visibility: hidden
309 description: ""
310 - name: Max Plan Time
311 type: duration
312 + unit: "milliseconds"
313 + visibility: hidden
314 description: ""
315 - name: Stddev Plan Time
316 type: duration
317 + unit: "milliseconds"
318 + visibility: hidden
319 description: ""
320 - name: Rows
321 type: integer
322 + unit: ""
323 description: ""
324 - name: Shared Blocks Hit
325 type: integer
326 + unit: ""
327 description: ""
328 - name: Shared Blocks Read
329 type: integer
330 + unit: ""
331 description: ""
332 - name: Shared Blocks Dirtied
333 type: integer
334 + unit: ""
335 + visibility: hidden
336 description: ""
337 - name: Shared Blocks Written
338 type: integer
339 + unit: ""
340 + visibility: hidden
341 description: ""
342 - name: Local Blocks Hit
343 type: integer
344 + unit: ""
345 + visibility: hidden
346 description: ""
347 - name: Local Blocks Read
348 type: integer
349 + unit: ""
350 + visibility: hidden
351 description: ""
352 - name: Local Blocks Dirtied
353 type: integer
354 + unit: ""
355 + visibility: hidden
356 description: ""
357 - name: Local Blocks Written
358 type: integer
359 + unit: ""
360 + visibility: hidden
361 description: ""
362 - name: Temp Blocks Read
363 type: integer
364 + unit: ""
365 description: ""
366 - name: Temp Blocks Written
367 type: integer
368 + unit: ""
369 description: ""
370 - name: Block Read Time
371 type: duration
372 + unit: "milliseconds"
373 description: ""
374 - name: Block Write Time
375 type: duration
376 + unit: "milliseconds"
377 description: ""
378 - name: WAL Records
379 type: integer
380 + unit: ""
381 + visibility: hidden
382 description: ""
383 - name: WAL Full Page Images
384 type: integer
385 + unit: ""
386 + visibility: hidden
387 description: ""
388 - name: WAL Bytes
389 type: integer
390 + unit: ""
391 + visibility: hidden
392 description: ""
393 - name: JIT Functions
394 type: integer
395 + unit: ""
396 + visibility: hidden
397 description: ""
398 - name: JIT Generation Time
399 type: duration
400 + unit: "milliseconds"
401 + visibility: hidden
402 description: ""
403 - name: JIT Inlining Count
404 type: integer
405 + unit: ""
406 + visibility: hidden
407 description: ""
408 - name: JIT Inlining Time
409 type: duration
410 + unit: "milliseconds"
411 + visibility: hidden
412 description: ""
413 - name: JIT Optimization Count
414 type: integer
415 + unit: ""
416 + visibility: hidden
417 description: ""
418 - name: JIT Optimization Time
419 type: duration
420 + unit: "milliseconds"
421 + visibility: hidden
422 description: ""
423 - name: JIT Emission Count
424 type: integer
425 + unit: ""
426 + visibility: hidden
427 description: ""
428 - name: JIT Emission Time
429 type: duration
430 + unit: "milliseconds"
431 + visibility: hidden
432 description: ""
433 - name: Temp Block Read Time
434 type: duration
435 + unit: "milliseconds"
436 + visibility: hidden
437 description: ""
438 - name: Temp Block Write Time
439 type: duration
440 + unit: "milliseconds"
441 + visibility: hidden
442 description: ""
369 - behavior: |
370 - Reads pg_stat_statements and returns the top entries sorted by the selected column.
443 performance: |
444 Requires pg_stat_statements and can be expensive on busy servers.
445 security: |
446 Query text may contain unmasked literals (potential PII).
375 - requirements: |
376 - Requires the pg_stat_statements extension installed and enabled.
447 + prerequisites:
448 + list:
449 + - title: Enable pg_stat_statements
450 + description: |
451 + Install and enable the pg_stat_statements extension.
452 availability: |
453 Available when pg_stat_statements is available and the collector is initialized.
454 metrics:
src/go/plugin/go.d/collector/proxysql/metadata.yaml
+33 -6
@@ -98,7 +98,7 @@ modules:
98 - name: Multi-instance
99 description: |
100 > **Note**: When you define multiple jobs, their names must be unique.
101 -
101 +
102 Local and remote instances.
103 config: |
104 jobs:
@@ -129,7 +129,10 @@ modules:
129 list:
130 - id: top-queries
131 name: Top Queries
132 - summary: Top SQL queries from ProxySQL query digest stats.
132 + description: |
133 + Top SQL queries from ProxySQL query digest stats.
134 +
135 + Queries stats_mysql_query_digest and returns the top entries sorted by the selected column.
136 parameters:
137 - id: __sort
138 name: Filter By
@@ -143,60 +146,84 @@ modules:
146 columns:
147 - name: Digest
148 type: string
149 + unit: ""
150 + visibility: hidden
151 description: ""
152 - name: Query
153 type: string
154 + unit: ""
155 description: ""
156 - name: Schema
157 type: string
158 + unit: ""
159 description: ""
160 - name: User
161 type: string
162 + unit: ""
163 + visibility: hidden
164 description: ""
165 - name: Hostgroup
166 type: integer
167 + unit: ""
168 + visibility: hidden
169 description: ""
170 - name: Calls
171 type: integer
172 + unit: ""
173 description: ""
174 - name: Total Time
175 type: duration
176 + unit: "milliseconds"
177 description: ""
178 - name: Avg Time
179 type: duration
180 + unit: "milliseconds"
181 description: ""
182 - name: Min Time
183 type: duration
184 + unit: "milliseconds"
185 + visibility: hidden
186 description: ""
187 - name: Max Time
188 type: duration
189 + unit: "milliseconds"
190 + visibility: hidden
191 description: ""
192 - name: Rows Affected
193 type: integer
194 + unit: ""
195 description: ""
196 - name: Rows Sent
197 type: integer
198 + unit: ""
199 description: ""
200 - name: Errors
201 type: integer
202 + unit: ""
203 description: ""
204 - name: Warnings
205 type: integer
206 + unit: ""
207 description: ""
208 - name: First Seen
209 type: string
210 + unit: ""
211 + visibility: hidden
212 description: ""
213 - name: Last Seen
214 type: string
215 + unit: ""
216 + visibility: hidden
217 description: ""
192 - behavior: |
193 - Queries stats_mysql_query_digest and returns the top entries sorted by the selected column.
218 performance: |
219 Uses ProxySQL stats tables and can be expensive on busy systems.
220 security: |
221 Query text may contain unmasked literals (potential PII).
198 - requirements: |
199 - Requires access to stats_mysql_query_digest in ProxySQL.
222 + prerequisites:
223 + list:
224 + - title: Grant access to stats_mysql_query_digest
225 + description: |
226 + Ensure the ProxySQL user can read stats_mysql_query_digest.
227 availability: |
228 Available when the collector can query ProxySQL stats; returns errors if the SQL connection is unavailable.
229 metrics:
src/go/plugin/go.d/collector/redis/metadata.yaml
+16 -7
@@ -37,7 +37,7 @@ modules:
37 auto_detection:
38 description: |
39 By default, it detects instances running on localhost by attempting to connect using known Redis TCP and UNIX sockets:
40 -
40 +
41 - 127.0.0.1:6379
42 - /tmp/redis.sock
43 - /var/run/redis/redis.sock
@@ -155,7 +155,7 @@ modules:
155 - name: Multi-instance
156 description: |
157 > **Note**: When you define multiple jobs, their names must be unique.
158 -
158 +
159 Local and remote instances.
160 config: |
161 jobs:
@@ -190,7 +190,10 @@ modules:
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)."
193 + description: |
194 + Slow commands from Redis SLOWLOG. WARNING: Command arguments may contain unmasked literals (potential PII).
195 +
196 + Reads Redis SLOWLOG and returns the top entries sorted by the selected column.
197 parameters:
198 - id: __sort
199 name: Filter By
@@ -204,33 +207,39 @@ modules:
207 columns:
208 - name: ID
209 type: integer
210 + unit: ""
211 + visibility: hidden
212 description: ""
213 - name: Timestamp
214 type: timestamp
215 + unit: ""
216 description: ""
217 - name: Command
218 type: string
219 + unit: ""
220 description: ""
221 - name: Command Name
222 type: string
223 + unit: ""
224 description: ""
225 - name: Duration
226 type: duration
227 + unit: "milliseconds"
228 description: ""
229 - name: Client Address
230 type: string
231 + unit: ""
232 + visibility: hidden
233 description: ""
234 - name: Client Name
235 type: string
236 + unit: ""
237 + visibility: hidden
238 description: ""
226 - behavior: |
227 - Reads Redis SLOWLOG and returns the top entries sorted by the selected column.
239 performance: |
240 Uses SLOWLOG GET and may return many entries; use top_queries_limit to control size.
241 security: |
242 Command arguments may contain unmasked literals (potential PII).
232 - requirements: |
233 - Requires access to the Redis SLOWLOG and a working connection.
243 availability: |
244 Available when the collector is initialized; returns 503 if the collector is still connecting.
245 metrics:
src/go/plugin/go.d/collector/rethinkdb/metadata.yaml
+21 -5
@@ -139,7 +139,10 @@ modules:
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)."
142 + description: |
143 + Currently running queries from rethinkdb.jobs. WARNING: Query text may contain unmasked literals (potential PII).
144 +
145 + Queries rethinkdb.jobs and returns running queries sorted by the selected column.
146 parameters:
147 - id: __sort
148 name: Filter By
@@ -153,36 +156,49 @@ modules:
156 columns:
157 - name: Job ID
158 type: string
159 + unit: ""
160 + visibility: hidden
161 description: ""
162 - name: Query
163 type: string
164 + unit: ""
165 description: ""
166 - name: Duration
167 type: duration
168 + unit: "milliseconds"
169 description: ""
170 - name: Type
171 type: string
172 + unit: ""
173 description: ""
174 - name: User
175 type: string
176 + unit: ""
177 description: ""
178 - name: Client Address
179 type: string
180 + unit: ""
181 + visibility: hidden
182 description: ""
183 - name: Client Port
184 type: integer
185 + unit: ""
186 + visibility: hidden
187 description: ""
188 - name: Servers
189 type: string
190 + unit: ""
191 + visibility: hidden
192 description: ""
178 - behavior: |
179 - Queries rethinkdb.jobs and returns running queries sorted by the selected column.
193 performance: |
194 Uses system tables and may be expensive on busy clusters.
195 security: |
196 Query text may contain unmasked literals (potential PII).
184 - requirements: |
185 - Requires admin access to rethinkdb.jobs and a working connection.
197 + prerequisites:
198 + list:
199 + - title: Grant admin access to rethinkdb.jobs
200 + description: |
201 + Use an admin user with access to rethinkdb.jobs and ensure the connection is working.
202 availability: |
203 Available when the collector is initialized; returns 503 if the collector is still connecting.
204 metrics:
src/go/plugin/go.d/collector/snmp/metadata.yaml
+35 -9
@@ -236,9 +236,9 @@ modules:
236 You can edit the configuration file using the edit-config script from the Netdata [config directory](https://learn.netdata.cloud/docs/netdata-agent/configuration#the-netdata-config-directory).
237
238 ```bash
239 - cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
240 - sudo ./edit-config go.d/sd/snmp.conf
241 - ```
239 + cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
240 + sudo ./edit-config go.d/sd/snmp.conf
241 + ```
242 limits:
243 description: ""
244 performance_impact:
@@ -489,7 +489,10 @@ modules:
489 list:
490 - id: interfaces
491 name: Network Interfaces
492 - summary: Network interface traffic and status metrics.
492 + description: |
493 + Network interface traffic and status metrics.
494 +
495 + Uses the latest cached SNMP interface data, filters by the selected type group, and sorts by the default column.
496 parameters:
497 - id: if_type_group
498 name: Type Group
@@ -512,69 +515,92 @@ modules:
515 columns:
516 - name: Interface
517 type: string
518 + unit: ""
519 description: ""
520 - name: Type
521 type: string
522 + unit: ""
523 description: ""
524 - name: Type Group
525 type: string
526 + unit: ""
527 description: ""
528 - name: Admin Status
529 type: string
530 + unit: ""
531 description: ""
532 - name: Oper Status
533 type: string
534 + unit: ""
535 description: ""
536 - name: Traffic In
537 type: float
538 + unit: "Mbits"
539 description: ""
540 - name: Traffic Out
541 type: float
542 + unit: "Mbits"
543 description: ""
544 - name: Unicast In
545 type: float
546 + unit: "Kpps"
547 + visibility: hidden
548 description: ""
549 - name: Unicast Out
550 type: float
551 + unit: "Kpps"
552 + visibility: hidden
553 description: ""
554 - name: Broadcast In
555 type: float
556 + unit: "Kpps"
557 + visibility: hidden
558 description: ""
559 - name: Broadcast Out
560 type: float
561 + unit: "Kpps"
562 + visibility: hidden
563 description: ""
564 - name: Packets In
565 type: float
566 + unit: "Kpps"
567 description: ""
568 - name: Packets Out
569 type: float
570 + unit: "Kpps"
571 description: ""
572 - name: Errors In
573 type: float
574 + unit: "packets/s"
575 + visibility: hidden
576 description: ""
577 - name: Errors Out
578 type: float
579 + unit: "packets/s"
580 + visibility: hidden
581 description: ""
582 - name: Discards In
583 type: float
584 + unit: "packets/s"
585 description: ""
586 - name: Discards Out
587 type: float
588 + unit: "packets/s"
589 description: ""
590 - name: Multicast In
591 type: float
592 + unit: "Kpps"
593 + visibility: hidden
594 description: ""
595 - name: Multicast Out
596 type: float
597 + unit: "Kpps"
598 + visibility: hidden
599 description: ""
570 - behavior: |
571 - Uses the latest cached SNMP interface data, filters by the selected type group, and sorts by the default column.
600 performance: |
601 Uses cached data only and does not trigger additional SNMP requests. Large devices may return many rows.
602 security: |
603 Exposes interface names and counters only.
576 - requirements: |
577 - Requires successful SNMP collection so interface data is cached.
604 availability: |
605 Available after the collector has completed at least one data collection; returns 503 until cache is ready.
606 metrics:
@@ -586,7 +612,7 @@ modules:
612
613 :::tip
614
589 - To understand the structure of these profiles (metrics, tags, virtual metrics, etc.), see **[SNMP Profile Format](/src/go/plugin/go.d/collector/snmp/profile-format.md)**.
615 + To understand the structure of these profiles (metrics, tags, virtual metrics, etc.), see **[SNMP Profile Format](/src/go/plugin/go.d/collector/snmp/profile-format.md)**.
616
617 :::
618
src/go/plugin/go.d/collector/yugabytedb/metadata.yaml
+52 -12
@@ -35,7 +35,7 @@ modules:
35 description: |
36 By default, it detects YugabyteDB instances running on localhost.
37 On startup, it tries to collect metrics from:
38 -
38 +
39 - http://127.0.0.1:7000/prometheus-metrics (Master)
40 - http://127.0.0.1:9000/prometheus-metrics (Tablet Server)
41 - http://127.0.0.1:12000/prometheus-metrics (YCQL)
@@ -228,7 +228,7 @@ modules:
228 - name: Multi-instance
229 description: |
230 > **Note**: When you define multiple jobs, their names must be unique.
231 -
231 +
232 Collecting metrics from local and remote instances.
233 config: |
234 jobs:
@@ -247,7 +247,10 @@ modules:
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)."
250 + description: |
251 + Top SQL queries from pg_stat_statements. WARNING: Query text may contain unmasked literals (potential PII).
252 +
253 + Reads pg_stat_statements and returns the top entries sorted by the selected column.
254 parameters:
255 - id: __sort
256 name: Filter By
@@ -261,50 +264,69 @@ modules:
264 columns:
265 - name: Query ID
266 type: string
267 + unit: ""
268 + visibility: hidden
269 description: ""
270 - name: Query
271 type: string
272 + unit: ""
273 description: ""
274 - name: Database
275 type: string
276 + unit: ""
277 description: ""
278 - name: User
279 type: string
280 + unit: ""
281 description: ""
282 - name: Calls
283 type: integer
284 + unit: ""
285 description: ""
286 - name: Total Time
287 type: duration
288 + unit: "milliseconds"
289 description: ""
290 - name: Mean Time
291 type: duration
292 + unit: "milliseconds"
293 description: ""
294 - name: Min Time
295 type: duration
296 + unit: "milliseconds"
297 + visibility: hidden
298 description: ""
299 - name: Max Time
300 type: duration
301 + unit: "milliseconds"
302 + visibility: hidden
303 description: ""
304 - name: Rows
305 type: integer
306 + unit: ""
307 description: ""
308 - name: Stddev Time
309 type: duration
310 + unit: "milliseconds"
311 + visibility: hidden
312 description: ""
295 - behavior: |
296 - Reads pg_stat_statements and returns the top entries sorted by the selected column.
313 performance: |
314 Executes SQL queries and may be expensive on busy clusters; use top_queries_limit and sql_timeout.
315 security: |
316 Query text may contain unmasked literals (potential PII).
301 - requirements: |
302 - Requires pg_stat_statements installed and a SQL DSN configured for YSQL.
317 + prerequisites:
318 + list:
319 + - title: Enable pg_stat_statements for YSQL
320 + description: |
321 + Install and enable pg_stat_statements and configure a YSQL DSN.
322 availability: |
323 Available when YSQL is accessible; returns errors if the SQL connection is unavailable.
324 - id: running-queries
325 name: Running Queries
307 - summary: "Currently running SQL statements from pg_stat_activity. WARNING: Query text may contain unmasked literals (potential PII)."
326 + description: |
327 + Currently running SQL statements from pg_stat_activity. WARNING: Query text may contain unmasked literals (potential PII).
328 +
329 + Reads pg_stat_activity and returns running statements sorted by the selected column.
330 parameters:
331 - id: __sort
332 name: Filter By
@@ -318,45 +340,63 @@ modules:
340 columns:
341 - name: PID
342 type: string
343 + unit: ""
344 + visibility: hidden
345 description: ""
346 - name: Query
347 type: string
348 + unit: ""
349 description: ""
350 - name: Database
351 type: string
352 + unit: ""
353 description: ""
354 - name: User
355 type: string
356 + unit: ""
357 description: ""
358 - name: State
359 type: string
360 + unit: ""
361 description: ""
362 - name: Wait Event Type
363 type: string
364 + unit: ""
365 + visibility: hidden
366 description: ""
367 - name: Wait Event
368 type: string
369 + unit: ""
370 + visibility: hidden
371 description: ""
372 - name: Application
373 type: string
374 + unit: ""
375 + visibility: hidden
376 description: ""
377 - name: Client Address
378 type: string
379 + unit: ""
380 + visibility: hidden
381 description: ""
382 - name: Query Start
383 type: string
384 + unit: ""
385 + visibility: hidden
386 description: ""
387 - name: Elapsed
388 type: duration
389 + unit: "milliseconds"
390 description: ""
352 - behavior: |
353 - Reads pg_stat_activity and returns running statements sorted by the selected column.
391 performance: |
392 Executes SQL queries and may be expensive on busy clusters; use top_queries_limit and sql_timeout.
393 security: |
394 Query text may contain unmasked literals (potential PII).
358 - requirements: |
359 - Requires a SQL DSN configured for YSQL and access to pg_stat_activity.
395 + prerequisites:
396 + list:
397 + - title: Grant access to pg_stat_activity
398 + description: |
399 + Configure a YSQL DSN and grant access to pg_stat_activity.
400 availability: |
401 Available when YSQL is accessible; returns errors if the SQL connection is unavailable.
402 metrics: