@cryptotaxi247 / netdata-1 / commits / b17a25583

Network Metadata (Windows plugin) (#19188)

Co-authored-by: ilyam8 <ilya@netdata.cloud>

thiagoftsm committed Dec 12, 2024 at 10:32 UTC b17a25583f80b908ad8b962e0dc7fab205e01b5b
1 file changed +324
src/collectors/windows.plugin/metadata.yaml
+324
@@ -481,6 +481,330 @@ modules:
481 chart_type: line
482 dimensions:
483 - name: operations
484 + - meta:
485 + plugin_name: windows.plugin
486 + module_name: PerflibNetwork
487 + monitored_instance:
488 + name: Network Subsystem
489 + link: "https://learn.microsoft.com/en-us/windows/win32/networking"
490 + categories:
491 + - data-collection.windows-systems
492 + icon_filename: "windows.svg"
493 + related_resources:
494 + integrations:
495 + list: []
496 + info_provided_to_referring_integrations:
497 + description: ""
498 + keywords:
499 + - network
500 + - bandwidth
501 + - ip
502 + - udp
503 + - tcp
504 + - interface
505 + most_popular: false
506 + overview:
507 + data_collection:
508 + metrics_description: |
509 + Monitor network interface metrics about bandwidth, state, errors and more.
510 + method_description: |
511 + It queries 'Network Interface' and 'Network Adapter' objects from Perflib in order to gather the metrics.
512 + supported_platforms:
513 + include: ["windows"]
514 + exclude: []
515 + multi_instance: false
516 + additional_permissions:
517 + description: ""
518 + default_behavior:
519 + auto_detection:
520 + description: |
521 + The collector automatically detects all of the metrics, no further configuration is required.
522 + limits:
523 + description: ""
524 + performance_impact:
525 + description: ""
526 + setup:
527 + prerequisites:
528 + list: []
529 + configuration:
530 + file:
531 + name: "netdata.conf"
532 + section_name: "[plugin:windows]"
533 + description: "The Netdata main configuration file"
534 + options:
535 + description: ""
536 + folding:
537 + title: "Config option"
538 + enabled: false
539 + list:
540 + - name: PerflibNetwork
541 + description: An option to enable or disable the data collection.
542 + default_value: yes
543 + required: false
544 + examples:
545 + folding:
546 + enabled: true
547 + title: ""
548 + list: []
549 + troubleshooting:
550 + problems:
551 + list: []
552 + alerts:
553 + - name: inbound_packets_dropped_ratio
554 + metric: net.drops
555 + info: Ratio of inbound dropped packets for the network interface ${label:device} over the last 10 minutes
556 + link: https://github.com/netdata/netdata/blob/master/src/health/health.d/net.conf
557 + - name: outbound_packets_dropped_ratio
558 + metric: net.drops
559 + info: Ratio of outbound dropped packets for the network interface ${label:device} over the last 10 minutes
560 + link: https://github.com/netdata/netdata/blob/master/src/health/health.d/net.conf
561 + - name: 1m_received_traffic_overflow
562 + metric: net.net
563 + info: Average inbound utilization for the network interface ${label:device} over the last minute
564 + link: https://github.com/netdata/netdata/blob/master/src/health/health.d/net.conf
565 + - name: 1m_sent_traffic_overflow
566 + metric: net.net
567 + info: Average outbound utilization for the network interface ${label:device} over the last minute
568 + link: https://github.com/netdata/netdata/blob/master/src/health/health.d/net.conf
569 + - name: network_interface_output_queue_length
570 + metric: net.queue_length
571 + info: Output Queue Length on interface ${label:device} should be zero, otherwise there are delays and bottlenecks.
572 + link: https://github.com/netdata/netdata/blob/master/src/health/health.d/net.conf
573 + metrics:
574 + folding:
575 + title: Metrics
576 + enabled: false
577 + description: ""
578 + availability: []
579 + scopes:
580 + - name: System
581 + description: "These metrics refer to the entire System."
582 + labels: []
583 + metrics:
584 + - name: system.net
585 + description: Physical Network Interfaces Aggregated Bandwidth
586 + unit: "kilobits/s"
587 + chart_type: area
588 + dimensions:
589 + - name: received
590 + - name: sent
591 + - name: ip.tcppackets
592 + description: TCP Packets
593 + unit: "packets/s"
594 + chart_type: area
595 + dimensions:
596 + - name: received
597 + - name: sent
598 + - name: ipv4.packets
599 + description: IPv4 Packets
600 + unit: "packets/s"
601 + chart_type: line
602 + dimensions:
603 + - name: received
604 + - name: sent
605 + - name: forwarded
606 + - name: delivered
607 + - name: ipv4.tcppackets
608 + description: IPv4 TCP Packets
609 + unit: "packets/s"
610 + chart_type: area
611 + dimensions:
612 + - name: received
613 + - name: sent
614 + - name: ipv4.udppackets
615 + description: IPv4 UDP Packets
616 + unit: "packets/s"
617 + chart_type: area
618 + dimensions:
619 + - name: received
620 + - name: sent
621 + - name: ipv4.icmp
622 + description: IPv4 ICMP Packets
623 + unit: "packets/s"
624 + chart_type: area
625 + dimensions:
626 + - name: received
627 + - name: sent
628 + - name: ipv4.errors
629 + description: IPv4 Errors
630 + unit: "packets/s"
631 + chart_type: area
632 + dimensions:
633 + - name: InDiscards
634 + - name: OutDiscards
635 + - name: OutNoRoutes
636 + - name: InAddrErrors
637 + - name: InHdrErrors
638 + - name: InUnknownProtos
639 + - name: ipv4.icmpmsg
640 + description: IPv4 ICMP Packets
641 + unit: "packets/s"
642 + chart_type: area
643 + dimensions:
644 + - name: InEchoReps
645 + - name: OutEchoReps
646 + - name: InDestUnreachs
647 + - name: OutDestUnreachs
648 + - name: InRedirects
649 + - name: OutRedirects
650 + - name: InEchos
651 + - name: OutEchos
652 + - name: InRouterAdvert
653 + - name: OutRouterAdvert
654 + - name: InRouterSelect
655 + - name: OutRouterSelect
656 + - name: InTimeExcds
657 + - name: OutTimeExcds
658 + - name: InParmProbs
659 + - name: OutParmProbs
660 + - name: InTimestamps
661 + - name: OutTimestamps
662 + - name: InTimestampReps
663 + - name: OutTimestampReps
664 + - name: ipv6.packets
665 + description: IPv6 Packets
666 + unit: "packets/s"
667 + chart_type: area
668 + dimensions:
669 + - name: received
670 + - name: sent
671 + - name: forwarded
672 + - name: delivered
673 + - name: ipv6.tcppackets
674 + description: IPv6 TCP Packets
675 + unit: "packets/s"
676 + chart_type: area
677 + dimensions:
678 + - name: received
679 + - name: sent
680 + - name: ipv6.udppackets
681 + description: IPv6 UDP Packets
682 + unit: "packets/s"
683 + chart_type: area
684 + dimensions:
685 + - name: received
686 + - name: sent
687 + - name: ipv6.icmp
688 + description: IPv6 ICMP Packets
689 + unit: "packets/s"
690 + chart_type: area
691 + dimensions:
692 + - name: received
693 + - name: sent
694 + - name: ipv6.errors
695 + description: IPv6 Errors
696 + unit: "packets/s"
697 + chart_type: area
698 + dimensions:
699 + - name: InDiscards
700 + - name: OutDiscards
701 + - name: OutNoRoutes
702 + - name: InAddrErrors
703 + - name: InHdrErrors
704 + - name: InUnknownProtos
705 + - name: ipv6.icmpmsg
706 + description: IPv6 ICMP Packets
707 + unit: "packets/s"
708 + chart_type: area
709 + dimensions:
710 + - name: InEchoReps
711 + - name: OutEchoReps
712 + - name: InDestUnreachs
713 + - name: OutDestUnreachs
714 + - name: InRedirects
715 + - name: OutRedirects
716 + - name: InEchos
717 + - name: OutEchos
718 + - name: InRouterAdvert
719 + - name: OutRouterAdvert
720 + - name: InRouterSelect
721 + - name: OutRouterSelect
722 + - name: InTimeExcds
723 + - name: OutTimeExcds
724 + - name: InParmProbs
725 + - name: OutParmProbs
726 + - name: InTimestamps
727 + - name: OutTimestamps
728 + - name: InTimestampReps
729 + - name: OutTimestampReps
730 + - name: network device
731 + description: "These metrics refer to Network Interfaces."
732 + labels:
733 + - name: interface_type
734 + description: "Classification of the network interface (real or virtual)."
735 + - name: device
736 + description: "System-assigned network interface identifier."
737 + metrics:
738 + - name: net.net
739 + description: Bandwidth
740 + unit: "kilobits/s"
741 + chart_type: area
742 + dimensions:
743 + - name: received
744 + - name: sent
745 + - name: net.packets
746 + description: Packets
747 + unit: "packets/s"
748 + chart_type: line
749 + dimensions:
750 + - name: received
751 + - name: sent
752 + - name: net.speed
753 + description: Interface Speed
754 + unit: "kilobits/s"
755 + chart_type: line
756 + dimensions:
757 + - name: speed
758 + - name: net.errors
759 + description: Interface Errors
760 + unit: "errors/s"
761 + chart_type: line
762 + dimensions:
763 + - name: inbound
764 + - name: outbound
765 + - name: net.drops
766 + description: Interface Drops
767 + unit: "drops/s"
768 + chart_type: line
769 + dimensions:
770 + - name: inbound
771 + - name: outbound
772 + - name: net.queue_length
773 + description: Interface Output Queue Length
774 + unit: "packets"
775 + chart_type: line
776 + dimensions:
777 + - name: length
778 + - name: net.rsc_connections
779 + description: Active TCP Connections Offloaded by RSC
780 + unit: "connections"
781 + chart_type: line
782 + dimensions:
783 + - name: connections
784 + - name: net.rsc_packets
785 + description: TCP RSC Coalesced Packets
786 + unit: "packets/s"
787 + chart_type: line
788 + dimensions:
789 + - name: packets
790 + - name: net.rsc_exceptions
791 + description: TCP RSC Exceptions
792 + unit: "exceptions/s"
793 + chart_type: line
794 + dimensions:
795 + - name: exceptions
796 + - name: net.rsc_average_packet_size
797 + description: TCP RSC Average Packet Size
798 + unit: "bytes"
799 + chart_type: line
800 + dimensions:
801 + - name: average
802 + - name: net.chimney_connections
803 + description: Active TCP Connections Offloaded with Chimney
804 + unit: "connections"
805 + chart_type: line
806 + dimensions:
807 + - name: connections
808 - meta:
809 plugin_name: windows.plugin
810 module_name: PerflibObjects