Disks Metadata (Windows plugin) (#19182)
* metdata_storage: Logical disks * metdata_storage: Physical disks * fixes --------- Co-authored-by: ilyam8 <ilya@netdata.cloud>
thiagoftsm committed
Dec 11, 2024 at 10:22 UTC
eabaed6be96f421555c8fdad44c56cbdd38ab932
1 file changed
+188
-5
src/collectors/windows.plugin/metadata.yaml
+188
-5
@@ -78,7 +78,7 @@ modules:
78
description: ""
79
availability: []
80
scopes:
81
- - name: global
81
+ - name: System
82
description: "These metrics refer to the entire system."
83
labels: []
84
metrics:
@@ -178,7 +178,7 @@ modules:
178
description: ""
179
availability: []
180
scopes:
181
- - name: global
181
+ - name: System
182
description: "These metrics refer to the entire system."
183
labels: []
184
metrics:
@@ -276,7 +276,7 @@ modules:
276
description: ""
277
availability: []
278
scopes:
279
- - name: global
279
+ - name: System
280
description: "These metrics refer to the entire system."
281
labels: []
282
metrics:
@@ -298,6 +298,189 @@ modules:
298
chart_type: line
299
dimensions:
300
- name: switches
301
+ - meta:
302
+ plugin_name: windows.plugin
303
+ module_name: PerflibStorage
304
+ monitored_instance:
305
+ name: Physical and Logical Disk Performance Metrics
306
+ link: "https://learn.microsoft.com/en-us/windows/win32/fileio/disk-management"
307
+ categories:
308
+ - data-collection.windows-systems
309
+ icon_filename: "windows.svg"
310
+ related_resources:
311
+ integrations:
312
+ list: []
313
+ info_provided_to_referring_integrations:
314
+ description: ""
315
+ keywords:
316
+ - disk
317
+ - disks
318
+ - io
319
+ - volume
320
+ - physical
321
+ - logical
322
+ most_popular: false
323
+ overview:
324
+ data_collection:
325
+ metrics_description: |
326
+ Detailed statistics for all disk devices and volumes.
327
+ method_description: |
328
+ It queries 'LogicalDisk' and 'PhysicalDisk' objects from Perflib in order to gather the metrics.
329
+ supported_platforms:
330
+ include: ["windows"]
331
+ exclude: []
332
+ multi_instance: false
333
+ additional_permissions:
334
+ description: ""
335
+ default_behavior:
336
+ auto_detection:
337
+ description: |
338
+ The collector automatically detects all of the metrics, no further configuration is required.
339
+ limits:
340
+ description: ""
341
+ performance_impact:
342
+ description: ""
343
+ setup:
344
+ prerequisites:
345
+ list: []
346
+ configuration:
347
+ file:
348
+ name: "netdata.conf"
349
+ section_name: "[plugin:windows]"
350
+ description: "The Netdata main configuration file"
351
+ options:
352
+ description: ""
353
+ folding:
354
+ title: "Config option"
355
+ enabled: false
356
+ list:
357
+ - name: PerflibStorage
358
+ description: An option to enable or disable the data collection.
359
+ default_value: yes
360
+ required: false
361
+ examples:
362
+ folding:
363
+ enabled: true
364
+ title: ""
365
+ list: []
366
+ troubleshooting:
367
+ problems:
368
+ list: []
369
+ alerts: []
370
+ metrics:
371
+ folding:
372
+ title: Metrics
373
+ enabled: false
374
+ description: ""
375
+ availability: []
376
+ scopes:
377
+ - name: System
378
+ description: "These metrics refer to the entire System."
379
+ labels: []
380
+ metrics:
381
+ - name: system.io
382
+ description: Disk I/O
383
+ unit: "KiB/s"
384
+ chart_type: area
385
+ dimensions:
386
+ - name: reads
387
+ - name: writes
388
+ - name: Logical Disk
389
+ description: "These metrics refer to Logical Disks."
390
+ labels:
391
+ - name: mount_point
392
+ description: "Drive letter or mount point path assigned by Windows (e.g., 'C:', 'D:')."
393
+ - name: driver_type
394
+ description: "Classification of the disk device (e.g., norootdir, removable, cdrom, ramdisk)."
395
+ - name: filesystem
396
+ description: "File system format used on the volume (e.g., NTFS, FAT32)."
397
+ - name: rw_mode
398
+ description: "Current read/write permissions status of the volume (read-only access, read and write access)."
399
+ metrics:
400
+ - name: disk.space
401
+ description: Disk Space Usage
402
+ unit: "GiB"
403
+ chart_type: stacked
404
+ dimensions:
405
+ - name: avail
406
+ - name: used
407
+ - name: Physical Disk
408
+ description: "These metrics refer to Physical Disks."
409
+ labels:
410
+ - name: mount_point
411
+ description: "Drive letter or mount point path assigned by Windows (e.g., 'C:', 'D:')."
412
+ - name: device
413
+ description: Manufacturer model name.
414
+ - name: model
415
+ description: The device model.
416
+ - name: device_id
417
+ description: Unique hardware identifier for the storage device within the system.
418
+ metrics:
419
+ - name: disk.io
420
+ description: Disk I/O Bandwidth
421
+ unit: "KiB/s"
422
+ chart_type: area
423
+ dimensions:
424
+ - name: reads
425
+ - name: writes
426
+ - name: disk.avgsz
427
+ description: Average Completed I/O Operation Bandwidth
428
+ unit: "KiB/operation"
429
+ chart_type: area
430
+ dimensions:
431
+ - name: reads
432
+ - name: writes
433
+ - name: disk.ops
434
+ description: Disk Completed I/O Operations
435
+ unit: "operations/s"
436
+ chart_type: line
437
+ dimensions:
438
+ - name: reads
439
+ - name: writes
440
+ - name: disk.split
441
+ description: Split I/O Operations
442
+ unit: "operations/s"
443
+ chart_type: line
444
+ dimensions:
445
+ - name: discards
446
+ - name: disk.await
447
+ description: Average Completed I/O Operation Time
448
+ unit: "milliseconds/operation"
449
+ chart_type: line
450
+ dimensions:
451
+ - name: reads
452
+ - name: writes
453
+ - name: disk.svctm
454
+ description: Average Service Time
455
+ unit: "milliseconds/operation"
456
+ chart_type: line
457
+ dimensions:
458
+ - name: svctm
459
+ - name: disk.util
460
+ description: Disk Utilization Time
461
+ unit: "percent"
462
+ chart_type: area
463
+ dimensions:
464
+ - name: utilization
465
+ - name: disk.busy
466
+ description: Disk Busy Time
467
+ unit: "milliseconds"
468
+ chart_type: area
469
+ dimensions:
470
+ - name: busy
471
+ - name: disk.iotime
472
+ description: Disk Total I/O Time
473
+ unit: "milliseconds/s"
474
+ chart_type: area
475
+ dimensions:
476
+ - name: reads
477
+ - name: writes
478
+ - name: disk.qops
479
+ description: Disk Current I/O Operations
480
+ unit: "operations"
481
+ chart_type: line
482
+ dimensions:
483
+ - name: operations
484
- meta:
485
plugin_name: windows.plugin
486
module_name: PerflibObjects
@@ -374,7 +557,7 @@ modules:
557
description: ""
558
availability: []
559
scopes:
377
- - name: global
560
+ - name: System
561
description: "These metrics refer to the entire system."
562
labels: []
563
metrics:
@@ -711,7 +894,7 @@ modules:
894
description: ""
895
availability: []
896
scopes:
714
- - name: global
897
+ - name: Hyper-V
898
description: "These metrics refer to the Hyper-V instance."
899
labels: []
900
metrics: