Skip to content

Commit

Permalink
Enable vSphere CPU and host metrics by default (#34022)
Browse files Browse the repository at this point in the history
**Description:** <Describe what has changed.>
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
The following PR enables the following metrics by default
```
vcenter.vm.cpu.readiness
vcenter.host.network.packet.drop.rate
vcenter.host.cpu.capacity
vcenter.host.cpu.reserve.capacity
```
**Link to tracking Issue:** <Issue number if applicable>

**Testing:** <Describe what testing was performed and which tests were
added.>
Updated golden files
**Documentation:** <Describe the documentation added.>
Updated documentation using make generate
  • Loading branch information
BominRahmani authored Jul 11, 2024
1 parent 6ed999b commit debd148
Show file tree
Hide file tree
Showing 11 changed files with 783 additions and 96 deletions.
29 changes: 29 additions & 0 deletions .chloggen/update_vcenter_host_vm_metrics_to_default.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Use this changelog template to create an entry for release notes.

# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: breaking

# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
component: vcenterreceiver

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: "Enables various vCenter metrics that were disabled by default until v0.105"

# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
issues: [34022]

# (Optional) One or more lines of additional information to render under the primary note.
# These lines will be padded with 2 spaces and then inserted directly into the document.
# Use pipe (|) for multiline entries.
subtext: |
The following metrics will be enabled by default "vcenter.host.network.packet.drop.rate",
"vcenter.vm.cpu.readiness", "vcenter.host.cpu.capacity", and "vcenter.host.cpu.reserved".
# If your change doesn't affect end users or the exported elements of any package,
# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
# Optional: The change log or logs in which this entry should be included.
# e.g. '[user]' or '[user, api]'
# Include 'user' if the change is relevant to end users.
# Include 'api' if there is a change to a library API.
# Default: '[user]'
change_logs: [user]
94 changes: 47 additions & 47 deletions receiver/vcenterreceiver/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,28 @@ The utilization of the datastore.
| ---- | ----------- | ---------- |
| % | Gauge | Double |
### vcenter.host.cpu.capacity
Total CPU capacity of the host system.
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
| MHz | Sum | Int | Cumulative | false |
### vcenter.host.cpu.reserved
The CPU of the host reserved for use by virtual machines.
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
| MHz | Sum | Int | Cumulative | false |
#### Attributes
| Name | Description | Values |
| ---- | ----------- | ------ |
| cpu_reservation_type | The type of CPU reservation for the host. | Str: ``total``, ``used`` |
### vcenter.host.cpu.usage
The amount of CPU used by the host.
Expand Down Expand Up @@ -186,6 +208,23 @@ The percentage of the host system's memory capacity that is being utilized.
| ---- | ----------- | ---------- |
| % | Gauge | Double |
### vcenter.host.network.packet.drop.rate
The rate of packets dropped across each physical NIC (network interface controller) instance on the host.
As measured over the most recent 20s interval.
| Unit | Metric Type | Value Type |
| ---- | ----------- | ---------- |
| {packets/sec} | Gauge | Double |
#### Attributes
| Name | Description | Values |
| ---- | ----------- | ------ |
| direction | The direction of network throughput. | Str: ``transmitted``, ``received`` |
| object | The object on the virtual machine or host that is being reported on. | Any Str |
### vcenter.host.network.packet.error.rate
The rate of packet errors transmitted or received on the host network.
Expand Down Expand Up @@ -289,6 +328,14 @@ The usage of the memory by the resource pool.
| ---- | ----------- | ------ |
| type | The type of memory usage. | Str: ``guest``, ``host``, ``overhead`` |
### vcenter.vm.cpu.readiness
Percentage of time that the virtual machine was ready, but could not get scheduled to run on the physical CPU.
| Unit | Metric Type | Value Type |
| ---- | ----------- | ---------- |
| % | Gauge | Int |
### vcenter.vm.cpu.usage
The amount of CPU used by the VM.
Expand Down Expand Up @@ -575,45 +622,6 @@ The number of VM's in the datacenter.
| status | The current status of the managed entity. | Str: ``red``, ``yellow``, ``green``, ``gray`` |
| power_state | The current power state of the virtual machine. | Str: ``on``, ``off``, ``suspended``, ``unknown`` |
### vcenter.host.cpu.capacity
Total CPU capacity of the host system.
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
| MHz | Sum | Int | Cumulative | false |
### vcenter.host.cpu.reserved
The CPU of the host reserved for use by virtual machines.
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
| MHz | Sum | Int | Cumulative | false |
#### Attributes
| Name | Description | Values |
| ---- | ----------- | ------ |
| cpu_reservation_type | The type of CPU reservation for the host. | Str: ``total``, ``used`` |
### vcenter.host.network.packet.drop.rate
The rate of packets dropped across each physical NIC (network interface controller) instance on the host.
As measured over the most recent 20s interval.
| Unit | Metric Type | Value Type |
| ---- | ----------- | ---------- |
| {packets/sec} | Gauge | Double |
#### Attributes
| Name | Description | Values |
| ---- | ----------- | ------ |
| direction | The direction of network throughput. | Str: ``transmitted``, ``received`` |
| object | The object on the virtual machine or host that is being reported on. | Any Str |
### vcenter.resource_pool.memory.ballooned
The amount of memory in a resource pool that is ballooned due to virtualization.
Expand Down Expand Up @@ -644,14 +652,6 @@ The amount of memory that is granted to VMs in the resource pool from the host's
| ---- | ----------- | ---------- | ----------------------- | --------- |
| MiBy | Sum | Int | Cumulative | false |
### vcenter.vm.cpu.readiness
Percentage of time that the virtual machine was ready, but could not get scheduled to run on the physical CPU.
| Unit | Metric Type | Value Type |
| ---- | ----------- | ---------- |
| % | Gauge | Int |
## Resource Attributes
| Name | Description | Values | Enabled |
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 0 additions & 12 deletions receiver/vcenterreceiver/internal/metadata/generated_metrics.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -469,6 +469,28 @@
<value>0</value>
<value>0</value>
</value>
<value xsi:type="PerfMetricIntSeries">
<id>
<counterId>529</counterId>
<instance>vmnic0</instance>
</id>
<value>0</value>
<value>0</value>
<value>0</value>
<value>0</value>
<value>0</value>
</value>
<value xsi:type="PerfMetricIntSeries">
<id>
<counterId>530</counterId>
<instance>vmnic0</instance>
</id>
<value>0</value>
<value>0</value>
<value>0</value>
<value>0</value>
<value>0</value>
</value>
<value xsi:type="PerfMetricIntSeries">
<id>
<counterId>146</counterId>
Expand Down Expand Up @@ -1459,7 +1481,7 @@
<value>1646</value>
<value>1291</value>
<value>1058</value>
</value>
</value>
<value xsi:type="PerfMetricIntSeries">
<id>
<counterId>435</counterId>
Expand Down Expand Up @@ -1559,6 +1581,28 @@
<value>0</value>
<value>0</value>
</value>
<value xsi:type="PerfMetricIntSeries">
<id>
<counterId>529</counterId>
<instance>vmnic2</instance>
</id>
<value>0</value>
<value>0</value>
<value>0</value>
<value>0</value>
<value>0</value>
</value>
<value xsi:type="PerfMetricIntSeries">
<id>
<counterId>530</counterId>
<instance>vmnic2</instance>
</id>
<value>0</value>
<value>0</value>
<value>0</value>
<value>0</value>
<value>0</value>
</value>
<value xsi:type="PerfMetricIntSeries">
<id>
<counterId>147</counterId>
Expand Down
Loading

0 comments on commit debd148

Please sign in to comment.