Regenerate integrations docs (#21935)
Co-authored-by: ilyam8 <22274335+ilyam8@users.noreply.github.com>
Netdata bot committed
Mar 10, 2026 at 22:34 UTC
5953aff36f39fcdf0eade2c5ec85e5ba62591fa9
2 files changed
+134
-6
src/collectors/COLLECTORS.md
+1
-1
@@ -169,7 +169,7 @@ Need a dedicated integration? [Submit a feature request](https://github.com/netd
169
| [systemd-nspawn Containers](https://github.com/netdata/netdata/blob/master/src/collectors/cgroups.plugin/integrations/systemd-nspawn_containers.md) | Monitor systemd-nspawn container resource utilization — CPU, memory, disk I/O, and network — via Linux cgroups. |
170
| [vCenter Server Appliance](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/vcsa/integrations/vcenter_server_appliance.md) | This collector monitors [health statistics](https://developer.vmware.com/apis/vsphere-automation/latest/appliance/health/) of vCenter Server Appliance servers. |
171
| [Virtual Machines](https://github.com/netdata/netdata/blob/master/src/collectors/cgroups.plugin/integrations/virtual_machines.md) | Monitor virtual machine resource utilization — CPU, memory, disk I/O, and network — via Linux cgroups. |
172
-| [VMware vCenter Server](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/vsphere/integrations/vmware_vcenter_server.md) | This collector monitors hosts and vms performance statistics from `vCenter` servers. |
172
+| [VMware vCenter Server](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/vsphere/integrations/vmware_vcenter_server.md) | This collector monitors hosts, VMs, datastores, clusters, and resource pools from `vCenter` servers. |
173
| [Xen XCP-ng](https://github.com/netdata/netdata/blob/master/src/collectors/xenstat.plugin/integrations/xen_xcp-ng.md) | This collector monitors XenServer and XCP-ng host and domains statistics. |
174
175
### Operating Systems
src/go/plugin/go.d/collector/vsphere/integrations/vmware_vcenter_server.md
+133
-5
@@ -21,7 +21,7 @@ Module: vsphere
21
22
## Overview
23
24
-This collector monitors hosts and vms performance statistics from `vCenter` servers.
24
+This collector monitors hosts, VMs, datastores, clusters, and resource pools from `vCenter` servers.
25
26
> **Warning**: The `vsphere` collector cannot re-login and continue collecting metrics after a vCenter reboot.
27
> go.d.plugin needs to be restarted.
@@ -49,6 +49,8 @@ The default configuration for this integration does not impose any limits on dat
49
The default `update_every` is 20 seconds, and it doesn't make sense to decrease the value.
50
**VMware real-time statistics are generated at the 20-second specificity**.
51
52
+**Note**: Datastore and cluster performance metrics use 300-second (5-minute) historical intervals because VMware does not support real-time statistics for these entity types. Datastore capacity/status, cluster properties, and resource pool statistics are updated every collection cycle. Host and VM metrics use real-time 20-second intervals.
53
+
54
It is likely that 20 seconds is not enough for big installations and the value should be tuned.
55
56
To get a better view we recommend running the collector in debug mode and seeing how much time it will take to collect metrics.
@@ -156,6 +158,98 @@ Metrics:
158
| vsphere.host_overall_status | green, red, yellow, gray | status |
159
| vsphere.host_system_uptime | uptime | seconds |
160
161
+### Per datastore
162
+
163
+These metrics refer to the Datastore.
164
+
165
+Labels:
166
+
167
+| Label | Description |
168
+|:-----------|:----------------|
169
+| datacenter | Datacenter name |
170
+| datastore | Datastore name |
171
+| type | Datastore type (VMFS, NFS, NFS41, vsan, VVOL, PMEM) |
172
+
173
+Metrics:
174
+
175
+| Metric | Dimensions | Unit |
176
+|:------|:----------|:----|
177
+| vsphere.datastore_disk_io | read, write | KiB/s |
178
+| vsphere.datastore_disk_iops | reads, writes | operations/s |
179
+| vsphere.datastore_disk_latency | read, write | milliseconds |
180
+| vsphere.datastore_space_utilization | used | percentage |
181
+| vsphere.datastore_space_usage | capacity, free, used | bytes |
182
+| vsphere.datastore_overall_status | green, red, yellow, gray | status |
183
+
184
+### Per cluster
185
+
186
+These metrics refer to the vSphere Cluster.
187
+
188
+Labels:
189
+
190
+| Label | Description |
191
+|:-----------|:----------------|
192
+| datacenter | Datacenter name |
193
+| cluster | Cluster name |
194
+
195
+Metrics:
196
+
197
+| Metric | Dimensions | Unit |
198
+|:------|:----------|:----|
199
+| vsphere.cluster_hosts | total, effective | hosts |
200
+| vsphere.cluster_cpu_capacity | total, effective | MHz |
201
+| vsphere.cluster_mem_capacity | total, effective | bytes |
202
+| vsphere.cluster_cpu_topology | cores, threads | count |
203
+| vsphere.cluster_drs_config | enabled | status |
204
+| vsphere.cluster_ha_config | enabled, admission_control | status |
205
+| vsphere.cluster_overall_status | green, red, yellow, gray | status |
206
+| vsphere.cluster_vmotions | vmotions | migrations |
207
+| vsphere.cluster_drs_score | score | percentage |
208
+| vsphere.cluster_drs_balance | current, target | score |
209
+| vsphere.cluster_vm_count | total, powered_off | VMs |
210
+| vsphere.cluster_usage_cpu | demand, entitled, reserved | MHz |
211
+| vsphere.cluster_usage_mem | demand, entitled, reserved | MB |
212
+| vsphere.cluster_cpu_utilization | used | percentage |
213
+| vsphere.cluster_cpu_usage | used, total | MHz |
214
+| vsphere.cluster_mem_utilization | used | percentage |
215
+| vsphere.cluster_mem_usage | consumed, active, granted, shared, overhead, swap_used | KiB |
216
+| vsphere.cluster_services_fairness | cpu, memory | score |
217
+| vsphere.cluster_services_effective_cpu | effective_cpu | MHz |
218
+| vsphere.cluster_services_effective_mem | effective_mem | MB |
219
+| vsphere.cluster_services_failover | failures_tolerable | failures |
220
+| vsphere.cluster_vm_migrations | vmotion, svmotion, xvmotion | operations |
221
+| vsphere.cluster_vm_lifecycle | poweron, poweroff, create, destroy, clone, deploy | operations |
222
+| vsphere.cluster_vm_management | reconfigure, reset, suspend, register, unregister | operations |
223
+| vsphere.cluster_vm_guest_ops | reboot, shutdown, standby | operations |
224
+| vsphere.cluster_vm_cold_migrations | change_ds, change_host, change_host_ds | operations |
225
+
226
+### Per resource pool
227
+
228
+These metrics refer to the vSphere Resource Pool.
229
+
230
+Labels:
231
+
232
+| Label | Description |
233
+|:-----------|:----------------|
234
+| datacenter | Datacenter name |
235
+| cluster | Cluster name |
236
+| resource_pool | Resource Pool name |
237
+
238
+Metrics:
239
+
240
+| Metric | Dimensions | Unit |
241
+|:------|:----------|:----|
242
+| vsphere.resource_pool_cpu_usage | usage, demand | MHz |
243
+| vsphere.resource_pool_cpu_entitlement | distributed | MHz |
244
+| vsphere.resource_pool_cpu_allocation | reservation_used, unreserved_for_vm, max_usage | MHz |
245
+| vsphere.resource_pool_mem_usage | host, guest | MB |
246
+| vsphere.resource_pool_mem_entitlement | distributed | MB |
247
+| vsphere.resource_pool_mem_allocation | reservation_used, unreserved_for_vm, max_usage | bytes |
248
+| vsphere.resource_pool_mem_breakdown | private, shared, swapped, ballooned, overhead, consumed_overhead, compressed | MB |
249
+| vsphere.resource_pool_cpu_config | reservation, limit | MHz |
250
+| vsphere.resource_pool_mem_config | reservation, limit | MB |
251
+| vsphere.resource_pool_overall_status | green, red, yellow, gray | status |
252
+
253
254
255
## Alerts
@@ -205,13 +299,15 @@ The following options can be defined globally: update_every, autodetection_retry
299
300
| Group | Option | Description | Default | Required |
301
|:------|:-----|:------------|:--------|:---------:|
208
-| **Collection** | update_every | Data collection interval (seconds). | 1 | no |
302
+| **Collection** | update_every | Data collection interval (seconds). | 20 | no |
303
| | autodetection_retry | Autodetection retry interval (seconds). Set 0 to disable. | 0 | no |
210
-| **Target** | url | Target endpoint URL. | http://127.0.0.1/server-status?auto | yes |
211
-| | timeout | HTTP request timeout (seconds). | 1 | no |
212
-| **Discovery** | discovery_interval | Hosts and VMs discovery interval (seconds). | 300 | no |
304
+| **Target** | url | Target endpoint URL. | https://vcenter.local | yes |
305
+| | timeout | HTTP request timeout (seconds). | 20 | no |
306
+| **Discovery** | discovery_interval | Hosts, VMs, datastores, clusters, and resource pools discovery interval (seconds). | 300 | no |
307
| **Filters** | [host_include](#option-filters-host-include) | Hosts selector (filter). | /* | no |
308
| | [vm_include](#option-filters-vm-include) | VM selector (filter). | /* | no |
309
+| | [datastore_include](#option-filters-datastore-include) | Datastore selector (filter). | /* | no |
310
+| | [cluster_include](#option-filters-cluster-include) | Cluster selector (filter). Resource pools follow their owning cluster. | /* | no |
311
| **HTTP Auth** | username | Username for Basic HTTP authentication. | | yes |
312
| | password | Password for Basic HTTP authentication. | | yes |
313
| | bearer_token_file | Path to a file containing a bearer token (used for `Authorization: Bearer`). | | no |
@@ -263,6 +359,38 @@ Metrics of VMs matching the selector will be collected.
359
```
360
361
362
+<a id="option-filters-datastore-include"></a>
363
+##### datastore_include
364
+
365
+Metrics of datastores matching the selector will be collected.
366
+
367
+- Include pattern syntax: "/Datacenter pattern/Datastore pattern".
368
+- Match pattern syntax: [simple patterns](https://github.com/netdata/netdata/blob/master/src/libnetdata/simple_pattern/README.md#simple-patterns).
369
+- Syntax:
370
+
371
+ ```yaml
372
+ datastore_include:
373
+ - '/DC1/*' # all datastores from datacenter DC1
374
+ - '/DC2/!DS2 *' # all datastores from DC2 except DS2
375
+ ```
376
+
377
+
378
+<a id="option-filters-cluster-include"></a>
379
+##### cluster_include
380
+
381
+Metrics of clusters and their resource pools matching the selector will be collected.
382
+
383
+- Include pattern syntax: "/Datacenter pattern/Cluster pattern".
384
+- Match pattern syntax: [simple patterns](https://github.com/netdata/netdata/blob/master/src/libnetdata/simple_pattern/README.md#simple-patterns).
385
+- Syntax:
386
+
387
+ ```yaml
388
+ cluster_include:
389
+ - '/DC1/*' # all clusters from datacenter DC1
390
+ - '/DC2/!Cluster2 *' # all clusters from DC2 except Cluster2
391
+ ```
392
+
393
+
394
395
</details>
396