Skip to main content

Hyper-V

Plugin: windows.plugin Module: PerflibHyperV

Overview

This collector monitors website requests and logins.

It queries the 'HyperV' object from Perflib in order to gather the metrics.

This collector is only supported on the following platforms:

  • windows

This collector only supports collecting metrics from a single instance of this integration.

Default Behavior

Auto-Detection

The collector automatically detects all of the metrics, no further configuration is required.

Limits

The default configuration for this integration does not impose any limits on data collection.

Performance Impact

The default configuration for this integration is not expected to impose a significant performance impact on the system.

Metrics

Metrics grouped by scope.

The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.

Per Hyper-V

These metrics refer to the Hyper-V instance.

This scope has no labels.

Metrics:

MetricDimensionsUnit
hyperv.vms_healthok, criticalvms
hyperv.root_partition_io_tlb_flushgpaflushes/s
hyperv.root_partition_virtual_tlb_flush_entriesflushesflushes/s
hyperv.root_partition_virtual_tlb_pagesusedpages
hyperv.root_partition_address_spaceaddress_spacesaddress spaces
hyperv.root_partition_attached_devicesattacheddevices
hyperv.root_partition_device_dma_errorsillegal_dmarequests
hyperv.root_partition_device_interrupt_errorsillegal_interruptrequests
hyperv.root_partition_device_interrupt_throttle_eventsthrottlingevents
hyperv.root_partition_deposited_pagesgpapages
hyperv.root_partition_device_space_pages4K, 2M, 1Gpages
hyperv.root_partition_gpa_space_pages4K, 2M, 1Gpages
hyperv.root_partition_gpa_space_modificationsgpamodifications/s

Per Virtual Machine

These metrics refer to the Virtual Machine.

Labels:

LabelDescription
vm_nameThe name of the Virtual Machine.

Metrics:

MetricDimensionsUnit
hyperv.vm_cpu_usageusagepercentage
hyperv.vm_cpu_usage_by_run_contextguest, hypervisor, remotepercentage
hyperv.vm_memory_physicalassignedbytes
hyperv.vm_memory_physical_guest_visiblevisible, availablebytes
hyperv.vm_memory_pressure_currentpressurepercentage
hyperv.vm_vid_physical_pages_allocatedallocatedpages
hyperv.vm_vid_remote_physical_pagesremote_physicalpages

Per Virtual Machine Storage Device

These metrics refer to the Virtual Machine Storage Device.

Labels:

LabelDescription
vm_storage_deviceThe name of the Storage Device.

Metrics:

MetricDimensionsUnit
hyperv.vm_storage_device_bytesread, writebytes/s
hyperv.vm_storage_device_operationsread, writeoperations/s
hyperv.vm_storage_device_errorserrorserrors/s

Per Virtual Machine Network Interface

These metrics refer to the Virtual Machine Network Interface.

Labels:

LabelDescription
vm_net_interfaceThe name of the Network Interface.

Metrics:

MetricDimensionsUnit
hyperv.vm_net_interface_trafficreceived, sentkilobits/s
hyperv.vm_net_interface_ipsec_trafficreceived, sentkilobits/s
hyperv.vm_net_interface_packetsreceived, sentpackets/s
hyperv.vm_net_interface_directed_packetsreceived, sentpackets/s
hyperv.vm_net_interface_broadcast_packetsreceived, sentpackets/s
hyperv.vm_net_interface_multicast_packetsreceived, sentpackets/s
hyperv.vm_net_interface_packets_droppedincoming, outgoingdrops/s

Per Virtual Switch

These metrics refer to the Virtual Switch.

Labels:

LabelDescription
vswitchThe name of the Virtual Switch.

Metrics:

MetricDimensionsUnit
hyperv.vswitch_trafficreceived, sentkilobits/s
hyperv.vswitch_packetsreceived, sentpackets/s
hyperv.vswitch_directed_packetsreceived, sentpackets/s
hyperv.vswitch_broadcast_packetsreceived, sentpackets/s
hyperv.vswitch_multicast_packetsreceived, sentpackets/s
hyperv.vswitch_dropped_packetsincoming, outgoingdrops/s
hyperv.vswitch_extensions_dropped_packetsincoming, outgoingdrops/s
hyperv.vswitch_packets_floodedfloodedpackets/s
hyperv.vswitch_learned_mac_addresseslearnedmac addresses/s
hyperv.vswitch_purged_mac_addressespurgedmac addresses/s

Alerts

There are no alerts configured by default for this integration.

Setup

Prerequisites

No action required.

Configuration

File

The configuration file name for this integration is netdata.conf. Configuration for this specific integration is located in the [plugin:windows] section within that file.

The file format is a modified INI syntax. The general structure is:

[section1]
option1 = some value
option2 = some other value

[section2]
option3 = some third value

You can edit the configuration file using the edit-config script from the Netdata config directory.

cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config netdata.conf

Options

NameDescriptionDefaultRequired
PerflibHyperVAn option to enable or disable the data collection.yesno

Examples

There are no configuration examples.


Do you have any feedback for this page? If so, you can open a new issue on our netdata/learn repository.