HyperV

Supported OS Windows

Integration version3.0.0

Overview

This check monitors Hyper-V through the Datadog Agent.

Setup

Installation

The Hyper-V check is included in the Datadog Agent package. No additional installation is needed on your server.

Configuration

  1. Edit the hyperv.d/conf.yaml file, in the conf.d/ folder at the root of your Agent’s configuration directory to collect your Hyper-V performance data. See the sample hyperv.d/conf.yaml for all available configuration options.

  2. Restart the Agent.

Note: Versions 1.5.0 or later of this check use a new implementation for metric collection, which requires Python 3. For hosts that are unable to use Python 3, or if you would like to use a legacy version of this check, refer to the following config.

Validation

Run the Agent’s status subcommand and look for hyperv under the Checks section.

Data Collected

Metrics

hyperv.dynamic_memory_balancer.available_memory
(gauge)
The amount of memory left on the node.
Shown as byte
hyperv.dynamic_memory_balancer.average_pressure
(gauge)
This counter represents the average pressure in the VM.
Shown as percent
hyperv.hypervisor_logical_processor.context_switches_per_sec
(gauge)
The combined rate at which all processors on the computer are switched from one thread to another.
Shown as operation
hyperv.hypervisor_logical_processor.guest_run_time
(gauge)
The percentage of time spent by the processor in guest code.
Shown as percent
hyperv.hypervisor_logical_processor.hypervisor_run_time
(gauge)
The percentage of time spent by the processor in hypervisor code.
Shown as percent
hyperv.hypervisor_logical_processor.idle_time
(gauge)
The percentage of time spent by the processor in an idle state.
Shown as percent
hyperv.hypervisor_logical_processor.total_run_time
(gauge)
The percentage of time spent by the processor in guest and hypervisor code.
Shown as percent
hyperv.hypervisor_root_virtual_processor.guest_run_time
(gauge)
The percentage of time spent by the virtual processor in guest code.
Shown as percent
hyperv.hypervisor_root_virtual_processor.hypervisor_run_time
(gauge)
The percentage of time spent by the virtual processor in hypervisor code.
Shown as percent
hyperv.hypervisor_root_virtual_processor.total_run_time
(gauge)
The percentage of time spent by the virtual processor in guest and hypervisor code.
Shown as percent
hyperv.hypervisor_virtual_processor.guest_run_time
(gauge)
The percentage of time spent by the virtual processor in guest code.
Shown as percent
hyperv.hypervisor_virtual_processor.hypervisor_run_time
(gauge)
The percentage of time spent by the virtual processor in hypervisor code.
Shown as percent
hyperv.hypervisor_virtual_processor.total_run_time
(gauge)
The percentage of time spent by the virtual processor in guest and hypervisor code.
Shown as percent
hyperv.virtual_network_adapter.bytes_per_sec
(gauge)
The rate at which bytes are sent and received over each network adapter.
Shown as byte
hyperv.vm_vid_partition.physical_pages_allocated
(gauge)
The number of physical pages allocated.
Shown as block
hyperv.vm_vid_partition.remote_physical_pages
(gauge)
The number of physical pages not allocated from the preferred NUMA node.
Shown as block

Service Checks

Hyper-V does not include any service checks.

Events

Hyper-V does not include any events.

Troubleshooting

Need help? Contact Datadog support.

Further Reading

Additional helpful documentation, links, and articles:

PREVIEWING: safchain/fix-custom-agent