hyper-v.md · cryptotaxi247/netdata-1

Code Commits Issues Pulls Sessions CI/CD

master

md 226 lines 6.58 KB

Rendered Raw

1	<!--startmeta
2	custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/integrations/hyper-v.md"
3	meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/metadata.yaml"
4	sidebar_label: "Hyper-V"
5	learn_status: "Published"
6	learn_rel_path: "Collecting Metrics/Collectors/Containers and VMs"
7	keywords: ['windows', 'microsoft', 'hyperv', 'virtualization', 'vm']
8	message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
9	endmeta-->
10
11	# Hyper-V
12
13
14	<img src="https://netdata.cloud/img/windows.svg" width="150"/>
15
16
17	Plugin: windows.plugin
18	Module: PerflibHyperV
19
20	<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
21
22	## Overview
23
24	This collector monitors website requests and logins.
25
26
27	It queries the 'HyperV' object from Perflib in order to gather the metrics.
28
29
30	This collector is only supported on the following platforms:
31
32	- windows
33
34	This collector only supports collecting metrics from a single instance of this integration.
35
36
37	### Default Behavior
38
39	#### Auto-Detection
40
41	The collector automatically detects all of the metrics, no further configuration is required.
42
43
44	#### Limits
45
46	The default configuration for this integration does not impose any limits on data collection.
47
48	#### Performance Impact
49
50	The default configuration for this integration is not expected to impose a significant performance impact on the system.
51
52	## Setup
53
54
55	### Prerequisites
56
57	No action required.
58
59	### Configuration
60
61	#### Options
62
63
64
65
66
67	\| Option \| Description \| Default \| Required \|
68	\|:-----\|:------------\|:--------\|:---------:\|
69	\| update every \| Data collection frequency. \| 5 \| no \|
70
71
72
73
74	#### via File
75
76	The configuration file name for this integration is `netdata.conf`.
77	Configuration for this specific integration is located in the `[plugin:windows:PerflibHyperV]` section within that file.
78
79	The file format is a modified INI syntax. The general structure is:
80
81	```ini
82	[section1]
83	option1 = some value
84	option2 = some other value
85
86	[section2]
87	option3 = some third value
88	```
89	You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the
90	Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory).
91
92	```bash
93	cd /etc/netdata 2>/dev/null \|\| cd /opt/netdata/etc/netdata
94	sudo ./edit-config netdata.conf
95	```
96
97	##### Examples
98	There are no configuration examples.
99
100
101
102	## Alerts
103
104	There are no alerts configured by default for this integration.
105
106
107	## Metrics
108
109	Metrics grouped by scope.
110
111	The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
112
113
114
115	### Per Hyper-V
116
117	These metrics refer to the Hyper-V instance.
118
119	This scope has no labels.
120
121	Metrics:
122
123	\| Metric \| Dimensions \| Unit \|
124	\|:------\|:----------\|:----\|
125	\| hyperv.vms_health \| ok, critical \| vms \|
126	\| hyperv.root_partition_io_tlb_flush \| gpa \| flushes/s \|
127	\| hyperv.root_partition_virtual_tlb_flush_entries \| flushes \| flushes/s \|
128	\| hyperv.root_partition_virtual_tlb_pages \| used \| pages \|
129	\| hyperv.root_partition_address_space \| address_spaces \| address spaces \|
130	\| hyperv.root_partition_attached_devices \| attached \| devices \|
131	\| hyperv.root_partition_device_dma_errors \| illegal_dma \| requests \|
132	\| hyperv.root_partition_device_interrupt_errors \| illegal_interrupt \| requests \|
133	\| hyperv.root_partition_device_interrupt_throttle_events \| throttling \| events \|
134	\| hyperv.root_partition_deposited_pages \| gpa \| pages \|
135	\| hyperv.root_partition_device_space_pages \| 4K, 2M, 1G \| pages \|
136	\| hyperv.root_partition_gpa_space_pages \| 4K, 2M, 1G \| pages \|
137	\| hyperv.root_partition_gpa_space_modifications \| gpa \| modifications/s \|
138
139	### Per Virtual Machine
140
141	These metrics refer to the Virtual Machine.
142
143	Labels:
144
145	\| Label \| Description \|
146	\|:-----------\|:----------------\|
147	\| vm_name \| The name of the Virtual Machine. \|
148
149	Metrics:
150
151	\| Metric \| Dimensions \| Unit \|
152	\|:------\|:----------\|:----\|
153	\| hyperv.vm_cpu_usage \| usage \| percentage \|
154	\| hyperv.vm_cpu_usage_by_run_context \| guest, hypervisor, remote \| percentage \|
155	\| hyperv.vm_memory_physical \| assigned \| bytes \|
156	\| hyperv.vm_memory_physical_guest_visible \| visible, available \| bytes \|
157	\| hyperv.vm_memory_pressure_current \| pressure \| percentage \|
158	\| hyperv.vm_vid_physical_pages_allocated \| allocated \| pages \|
159	\| hyperv.vm_vid_remote_physical_pages \| remote_physical \| pages \|
160
161	### Per Virtual Machine Storage Device
162
163	These metrics refer to the Virtual Machine Storage Device.
164
165	Labels:
166
167	\| Label \| Description \|
168	\|:-----------\|:----------------\|
169	\| vm_storage_device \| The name of the Storage Device. \|
170
171	Metrics:
172
173	\| Metric \| Dimensions \| Unit \|
174	\|:------\|:----------\|:----\|
175	\| hyperv.vm_storage_device_bytes \| read, write \| bytes/s \|
176	\| hyperv.vm_storage_device_operations \| read, write \| operations/s \|
177	\| hyperv.vm_storage_device_errors \| errors \| errors/s \|
178
179	### Per Virtual Machine Network Interface
180
181	These metrics refer to the Virtual Machine Network Interface.
182
183	Labels:
184
185	\| Label \| Description \|
186	\|:-----------\|:----------------\|
187	\| vm_net_interface \| The name of the Network Interface. \|
188
189	Metrics:
190
191	\| Metric \| Dimensions \| Unit \|
192	\|:------\|:----------\|:----\|
193	\| hyperv.vm_net_interface_traffic \| received, sent \| kilobits/s \|
194	\| hyperv.vm_net_interface_ipsec_traffic \| received, sent \| kilobits/s \|
195	\| hyperv.vm_net_interface_packets \| received, sent \| packets/s \|
196	\| hyperv.vm_net_interface_directed_packets \| received, sent \| packets/s \|
197	\| hyperv.vm_net_interface_broadcast_packets \| received, sent \| packets/s \|
198	\| hyperv.vm_net_interface_multicast_packets \| received, sent \| packets/s \|
199	\| hyperv.vm_net_interface_packets_dropped \| incoming, outgoing \| drops/s \|
200
201	### Per Virtual Switch
202
203	These metrics refer to the Virtual Switch.
204
205	Labels:
206
207	\| Label \| Description \|
208	\|:-----------\|:----------------\|
209	\| vswitch \| The name of the Virtual Switch. \|
210
211	Metrics:
212
213	\| Metric \| Dimensions \| Unit \|
214	\|:------\|:----------\|:----\|
215	\| hyperv.vswitch_traffic \| received, sent \| kilobits/s \|
216	\| hyperv.vswitch_packets \| received, sent \| packets/s \|
217	\| hyperv.vswitch_directed_packets \| received, sent \| packets/s \|
218	\| hyperv.vswitch_broadcast_packets \| received, sent \| packets/s \|
219	\| hyperv.vswitch_multicast_packets \| received, sent \| packets/s \|
220	\| hyperv.vswitch_dropped_packets \| incoming, outgoing \| drops/s \|
221	\| hyperv.vswitch_extensions_dropped_packets \| incoming, outgoing \| drops/s \|
222	\| hyperv.vswitch_packets_flooded \| flooded \| packets/s \|
223	\| hyperv.vswitch_learned_mac_addresses \| learned \| mac addresses/s \|
224	\| hyperv.vswitch_purged_mac_addresses \| purged \| mac addresses/s \|
225
226