@cryptotaxi247 / netdata-1 / commits / b919d4dbe

Regenerate integrations docs (#19131)

Co-authored-by: ilyam8 <22274335+ilyam8@users.noreply.github.com>

Netdata bot committed Dec 5, 2024 at 09:51 UTC b919d4dbee64e4560061f6eaabfeb1f9bf180390
2 files changed +222
src/collectors/COLLECTORS.md
+2
@@ -1157,6 +1157,8 @@ If you don't see the app/service you'd like to monitor in this list:
1157
1158 ### Windows Systems
1159
1160 +- [Hyper-V](https://github.com/netdata/netdata/blob/master/src/collectors/windows.plugin/integrations/hyper-v.md)
1161 +
1162 - [IIS](https://github.com/netdata/netdata/blob/master/src/collectors/windows.plugin/integrations/iis.md)
1163
1164 - [Memory statistics](https://github.com/netdata/netdata/blob/master/src/collectors/windows.plugin/integrations/memory_statistics.md)
src/collectors/windows.plugin/integrations/hyper-v.md new
+220
@@ -0,0 +1,220 @@
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/Windows Systems"
7 +most_popular: False
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 +
53 +## Metrics
54 +
55 +Metrics grouped by *scope*.
56 +
57 +The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
58 +
59 +
60 +
61 +### Per Hyper-V instance
62 +
63 +These metrics refer to the Hyper-V instance.
64 +
65 +This scope has no labels.
66 +
67 +Metrics:
68 +
69 +| Metric | Dimensions | Unit |
70 +|:------|:----------|:----|
71 +| hyperv.vms_health | ok, critical | vms |
72 +| hyperv.root_partition_io_tlb_flush | gpa | flushes/s |
73 +| hyperv.root_partition_virtual_tlb_flush_entries | flushes | flushes/s |
74 +| hyperv.root_partition_virtual_tlb_pages | used | pages |
75 +| hyperv.root_partition_address_space | address_spaces | address spaces |
76 +| hyperv.root_partition_attached_devices | attached | devices |
77 +| hyperv.root_partition_device_dma_errors | illegal_dma | requests |
78 +| hyperv.root_partition_device_interrupt_errors | illegal_interrupt | requests |
79 +| hyperv.root_partition_device_interrupt_throttle_events | throttling | events |
80 +| hyperv.root_partition_deposited_pages | gpa | pages |
81 +| hyperv.root_partition_device_space_pages | 4K, 2M, 1G | pages |
82 +| hyperv.root_partition_gpa_space_pages | 4K, 2M, 1G | pages |
83 +| hyperv.root_partition_gpa_space_modifications | gpa | modifications/s |
84 +
85 +### Per Virtual Machine
86 +
87 +These metrics refer to the Virtual Machine.
88 +
89 +Labels:
90 +
91 +| Label | Description |
92 +|:-----------|:----------------|
93 +| vm_name | The name of the Virtual Machine. |
94 +
95 +Metrics:
96 +
97 +| Metric | Dimensions | Unit |
98 +|:------|:----------|:----|
99 +| hyperv.vm_cpu_usage | usage | percentage |
100 +| hyperv.vm_cpu_usage_by_run_context | guest, hypervisor, remote | percentage |
101 +| hyperv.vm_memory_physical | assigned | bytes |
102 +| hyperv.vm_memory_physical_guest_visible | visible, available | bytes |
103 +| hyperv.vm_memory_pressure_current | pressure | percentage |
104 +| hyperv.vm_vid_physical_pages_allocated | allocated | pages |
105 +| hyperv.vm_vid_remote_physical_pages | remote_physical | pages |
106 +
107 +### Per Virtual Machine Storage Device
108 +
109 +These metrics refer to the Virtual Machine Storage Device.
110 +
111 +Labels:
112 +
113 +| Label | Description |
114 +|:-----------|:----------------|
115 +| vm_storage_device | The name of the Storage Device. |
116 +
117 +Metrics:
118 +
119 +| Metric | Dimensions | Unit |
120 +|:------|:----------|:----|
121 +| hyperv.vm_storage_device_bytes | read, write | bytes/s |
122 +| hyperv.vm_storage_device_operations | read, write | operations/s |
123 +| hyperv.vm_storage_device_errors | errors | errors/s |
124 +
125 +### Per Virtual Machine Network Interface
126 +
127 +These metrics refer to the Virtual Machine Network Interface.
128 +
129 +Labels:
130 +
131 +| Label | Description |
132 +|:-----------|:----------------|
133 +| vm_net_interface | The name of the Network Interface. |
134 +
135 +Metrics:
136 +
137 +| Metric | Dimensions | Unit |
138 +|:------|:----------|:----|
139 +| hyperv.vm_net_interface_traffic | received, sent | kilobits/s |
140 +| hyperv.vm_net_interface_ipsec_traffic | received, sent | kilobits/s |
141 +| hyperv.vm_net_interface_packets | received, sent | packets/s |
142 +| hyperv.vm_net_interface_directed_packets | received, sent | packets/s |
143 +| hyperv.vm_net_interface_broadcast_packets | received, sent | packets/s |
144 +| hyperv.vm_net_interface_multicast_packets | received, sent | packets/s |
145 +| hyperv.vm_net_interface_packets_dropped | incoming, outgoing | drops/s |
146 +
147 +### Per Virtual Switch
148 +
149 +These metrics refer to the Virtual Switch.
150 +
151 +Labels:
152 +
153 +| Label | Description |
154 +|:-----------|:----------------|
155 +| vswitch | The name of the Virtual Switch. |
156 +
157 +Metrics:
158 +
159 +| Metric | Dimensions | Unit |
160 +|:------|:----------|:----|
161 +| hyperv.vswitch_traffic | received, sent | kilobits/s |
162 +| hyperv.vswitch_packets | received, sent | packets/s |
163 +| hyperv.vswitch_directed_packets | received, sent | packets/s |
164 +| hyperv.vswitch_broadcast_packets | received, sent | packets/s |
165 +| hyperv.vswitch_multicast_packets | received, sent | packets/s |
166 +| hyperv.vswitch_dropped_packets | incoming, outgoing | drops/s |
167 +| hyperv.vswitch_extensions_dropped_packets | incoming, outgoing | drops/s |
168 +| hyperv.vswitch_packets_flooded | flooded | packets/s |
169 +| hyperv.vswitch_learned_mac_addresses | learned | mac addresses/s |
170 +| hyperv.vswitch_purged_mac_addresses | purged | mac addresses/s |
171 +
172 +
173 +
174 +## Alerts
175 +
176 +There are no alerts configured by default for this integration.
177 +
178 +
179 +## Setup
180 +
181 +### Prerequisites
182 +
183 +No action required.
184 +
185 +### Configuration
186 +
187 +#### File
188 +
189 +The configuration file name for this integration is `netdata.conf`.
190 +Configuration for this specific integration is located in the `[plugin:windows]` section within that file.
191 +
192 +The file format is a modified INI syntax. The general structure is:
193 +
194 +```ini
195 +[section1]
196 + option1 = some value
197 + option2 = some other value
198 +
199 +[section2]
200 + option3 = some third value
201 +```
202 +You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config) script from the
203 +Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).
204 +
205 +```bash
206 +cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
207 +sudo ./edit-config netdata.conf
208 +```
209 +#### Options
210 +
211 +
212 +
213 +| Name | Description | Default | Required |
214 +|:----|:-----------|:-------|:--------:|
215 +| PerflibHyperV | An option to enable or disable the data collection. | yes | no |
216 +
217 +#### Examples
218 +There are no configuration examples.
219 +
220 +