@cryptotaxi247 / netdata-1 / commits / 6d0bd3238

docs(windows/hyperv): add Hyper-V metadata (#19129)

Ilya Mashchenko committed Dec 5, 2024 at 16:42 UTC 6d0bd3238c4a0692feb5a9a191cab5f984946597
1 file changed +368
src/collectors/windows.plugin/metadata.yaml
+368
@@ -444,3 +444,371 @@ modules:
444 chart_type: line
445 dimensions:
446 - name: uptime
447 + - meta:
448 + plugin_name: windows.plugin
449 + module_name: PerflibHyperV
450 + monitored_instance:
451 + name: Hyper-V
452 + link: "https://learn.microsoft.com/en-us/virtualization/hyper-v-on-windows/about/"
453 + categories:
454 + - data-collection.windows-systems
455 + icon_filename: "windows.svg"
456 + related_resources:
457 + integrations:
458 + list: []
459 + info_provided_to_referring_integrations:
460 + description: ""
461 + keywords:
462 + - windows
463 + - microsoft
464 + - hyperv
465 + - virtualization
466 + - vm
467 + most_popular: false
468 + overview:
469 + data_collection:
470 + metrics_description: |
471 + This collector monitors website requests and logins.
472 + method_description: |
473 + It queries the 'HyperV' object from Perflib in order to gather the metrics.
474 + supported_platforms:
475 + include: ["windows"]
476 + exclude: []
477 + multi_instance: false
478 + additional_permissions:
479 + description: ""
480 + default_behavior:
481 + auto_detection:
482 + description: |
483 + The collector automatically detects all of the metrics, no further configuration is required.
484 + limits:
485 + description: ""
486 + performance_impact:
487 + description: ""
488 + setup:
489 + prerequisites:
490 + list: []
491 + configuration:
492 + file:
493 + name: "netdata.conf"
494 + section_name: "[plugin:windows]"
495 + description: "The Netdata main configuration file"
496 + options:
497 + description: ""
498 + folding:
499 + title: "Config option"
500 + enabled: false
501 + list:
502 + - name: PerflibHyperV
503 + description: An option to enable or disable the data collection.
504 + default_value: yes
505 + required: false
506 + examples:
507 + folding:
508 + enabled: true
509 + title: ""
510 + list: []
511 + troubleshooting:
512 + problems:
513 + list: []
514 + alerts: []
515 + metrics:
516 + folding:
517 + title: Metrics
518 + enabled: false
519 + description: ""
520 + availability: []
521 + scopes:
522 + - name: global
523 + description: "These metrics refer to the Hyper-V instance."
524 + labels: []
525 + metrics:
526 + - name: hyperv.vms_health
527 + description: Virtual machines health status
528 + unit: "vms"
529 + chart_type: line
530 + dimensions:
531 + - name: ok
532 + - name: critical
533 + - name: hyperv.root_partition_io_tlb_flush
534 + description: Root partition flushes of I/O TLBs
535 + unit: "flushes/s"
536 + chart_type: line
537 + dimensions:
538 + - name: gpa
539 + - name: hyperv.root_partition_virtual_tlb_flush_entries
540 + description: Root partition flushes of the entire virtual TLB
541 + unit: "flushes/s"
542 + chart_type: line
543 + dimensions:
544 + - name: flushes
545 + - name: hyperv.root_partition_virtual_tlb_pages
546 + description: Root partition pages used by the virtual TLB
547 + unit: "pages"
548 + chart_type: line
549 + dimensions:
550 + - name: used
551 + - name: hyperv.root_partition_address_space
552 + description: Root partition address spaces in the virtual TLB
553 + unit: "address spaces"
554 + chart_type: line
555 + dimensions:
556 + - name: address_spaces
557 + - name: hyperv.root_partition_attached_devices
558 + description: Root partition attached devices
559 + unit: "devices"
560 + chart_type: line
561 + dimensions:
562 + - name: attached
563 + - name: hyperv.root_partition_device_dma_errors
564 + description: Root partition illegal DMA requests
565 + unit: "requests"
566 + chart_type: line
567 + dimensions:
568 + - name: illegal_dma
569 + - name: hyperv.root_partition_device_interrupt_errors
570 + description: Root partition illegal interrupt requests
571 + unit: "requests"
572 + chart_type: line
573 + dimensions:
574 + - name: illegal_interrupt
575 + - name: hyperv.root_partition_device_interrupt_throttle_events
576 + description: Root partition throttled interrupts
577 + unit: "events"
578 + chart_type: line
579 + dimensions:
580 + - name: throttling
581 + - name: hyperv.root_partition_deposited_pages
582 + description: Root partition deposited pages
583 + unit: "pages"
584 + chart_type: line
585 + dimensions:
586 + - name: gpa
587 + - name: hyperv.root_partition_device_space_pages
588 + description: Root partition device space pages
589 + unit: "pages"
590 + chart_type: line
591 + dimensions:
592 + - name: 4K
593 + - name: 2M
594 + - name: 1G
595 + - name: hyperv.root_partition_gpa_space_pages
596 + description: Root partition GPA space pages
597 + unit: "pages"
598 + chart_type: line
599 + dimensions:
600 + - name: 4K
601 + - name: 2M
602 + - name: 1G
603 + - name: hyperv.root_partition_gpa_space_modifications
604 + description: Root partition GPA space modifications
605 + unit: "modifications/s"
606 + chart_type: line
607 + dimensions:
608 + - name: gpa
609 +
610 + - name: Virtual Machine
611 + description: "These metrics refer to the Virtual Machine."
612 + labels:
613 + - name: vm_name
614 + description: The name of the Virtual Machine.
615 + metrics:
616 + - name: hyperv.vm_cpu_usage
617 + description: VM CPU usage
618 + unit: "percentage"
619 + chart_type: area
620 + dimensions:
621 + - name: usage
622 + - name: hyperv.vm_cpu_usage_by_run_context
623 + description: VM CPU usage by run context
624 + unit: "percentage"
625 + chart_type: stacked
626 + dimensions:
627 + - name: guest
628 + - name: hypervisor
629 + - name: remote
630 + - name: hyperv.vm_memory_physical
631 + description: VM assigned memory
632 + unit: "bytes"
633 + chart_type: line
634 + dimensions:
635 + - name: assigned
636 + - name: hyperv.vm_memory_physical_guest_visible
637 + description: VM guest visible memory
638 + unit: "bytes"
639 + chart_type: line
640 + dimensions:
641 + - name: visible
642 + - name: available
643 + - name: hyperv.vm_memory_pressure_current
644 + description: VM Memory Pressure
645 + unit: "percentage"
646 + chart_type: line
647 + dimensions:
648 + - name: pressure
649 + - name: hyperv.vm_vid_physical_pages_allocated
650 + description: VM physical pages allocated
651 + unit: "pages"
652 + chart_type: line
653 + dimensions:
654 + - name: allocated
655 + - name: hyperv.vm_vid_remote_physical_pages
656 + description: VM physical pages not allocated from the preferred NUMA node
657 + unit: "pages"
658 + chart_type: line
659 + dimensions:
660 + - name: remote_physical
661 + - name: Virtual Machine Storage Device
662 + description: "These metrics refer to the Virtual Machine Storage Device."
663 + labels:
664 + - name: vm_storage_device
665 + description: The name of the Storage Device.
666 + metrics:
667 + - name: hyperv.vm_storage_device_bytes
668 + description: VM storage device IO
669 + unit: "bytes/s"
670 + chart_type: area
671 + dimensions:
672 + - name: read
673 + - name: write
674 + - name: hyperv.vm_storage_device_operations
675 + description: VM storage device IOPS"
676 + unit: "operations/s"
677 + chart_type: line
678 + dimensions:
679 + - name: read
680 + - name: write
681 + - name: hyperv.vm_storage_device_errors
682 + description: VM storage device errors
683 + unit: "errors/s"
684 + chart_type: line
685 + dimensions:
686 + - name: errors
687 + - name: Virtual Machine Network Interface
688 + description: "These metrics refer to the Virtual Machine Network Interface."
689 + labels:
690 + - name: vm_net_interface
691 + description: The name of the Network Interface.
692 + metrics:
693 + - name: hyperv.vm_net_interface_traffic
694 + description: VM interface traffic
695 + unit: "kilobits/s"
696 + chart_type: line
697 + dimensions:
698 + - name: received
699 + - name: sent
700 + - name: hyperv.vm_net_interface_ipsec_traffic
701 + description: VM interface traffic
702 + unit: "kilobits/s"
703 + chart_type: line
704 + dimensions:
705 + - name: received
706 + - name: sent
707 + - name: hyperv.vm_net_interface_packets
708 + description: VM interface packets
709 + unit: "packets/s"
710 + chart_type: line
711 + dimensions:
712 + - name: received
713 + - name: sent
714 + - name: hyperv.vm_net_interface_directed_packets
715 + description: VM interface directed packets
716 + unit: "packets/s"
717 + chart_type: line
718 + dimensions:
719 + - name: received
720 + - name: sent
721 + - name: hyperv.vm_net_interface_broadcast_packets
722 + description: VM interface broadcast
723 + unit: "packets/s"
724 + chart_type: line
725 + dimensions:
726 + - name: received
727 + - name: sent
728 + - name: hyperv.vm_net_interface_multicast_packets
729 + description: VM interface multicast
730 + unit: "packets/s"
731 + chart_type: line
732 + dimensions:
733 + - name: received
734 + - name: sent
735 + - name: hyperv.vm_net_interface_packets_dropped
736 + description: VM interface packets dropped
737 + unit: "drops/s"
738 + chart_type: line
739 + dimensions:
740 + - name: incoming
741 + - name: outgoing
742 + - name: Virtual Switch
743 + description: "These metrics refer to the Virtual Switch."
744 + labels:
745 + - name: vswitch
746 + description: The name of the Virtual Switch.
747 + metrics:
748 + - name: hyperv.vswitch_traffic
749 + description: Virtual switch traffic
750 + unit: "kilobits/s"
751 + chart_type: area
752 + dimensions:
753 + - name: received
754 + - name: sent
755 + - name: hyperv.vswitch_packets
756 + description: Virtual switch packets
757 + unit: "packets/s"
758 + chart_type: line
759 + dimensions:
760 + - name: received
761 + - name: sent
762 + - name: hyperv.vswitch_directed_packets
763 + description: Virtual switch directed packets
764 + unit: "packets/s"
765 + chart_type: line
766 + dimensions:
767 + - name: received
768 + - name: sent
769 + - name: hyperv.vswitch_broadcast_packets
770 + description: Virtual switch broadcast packets
771 + unit: "packets/s"
772 + chart_type: line
773 + dimensions:
774 + - name: received
775 + - name: sent
776 + - name: hyperv.vswitch_multicast_packets
777 + description: Virtual switch multicast packets
778 + unit: "packets/s"
779 + chart_type: line
780 + dimensions:
781 + - name: received
782 + - name: sent
783 + - name: hyperv.vswitch_dropped_packets
784 + description: Virtual switch dropped packets
785 + unit: "drops/s"
786 + chart_type: line
787 + dimensions:
788 + - name: incoming
789 + - name: outgoing
790 + - name: hyperv.vswitch_extensions_dropped_packets
791 + description: Virtual switch extensions dropped packets
792 + unit: "drops/s"
793 + chart_type: line
794 + dimensions:
795 + - name: incoming
796 + - name: outgoing
797 + - name: hyperv.vswitch_packets_flooded
798 + description: Virtual switch flooded packets
799 + unit: "packets/s"
800 + chart_type: line
801 + dimensions:
802 + - name: flooded
803 + - name: hyperv.vswitch_learned_mac_addresses
804 + description: Virtual switch learned MAC addresses
805 + unit: "mac addresses/s"
806 + chart_type: line
807 + dimensions:
808 + - name: learned
809 + - name: hyperv.vswitch_purged_mac_addresses
810 + description: Virtual switch purged MAC addresses
811 + unit: "mac addresses/s"
812 + chart_type: line
813 + dimensions:
814 + - name: purged