Skip to content

Commit 1274615

Browse files
samiurachengchuanpeng
authored andcommitted
added new metrics for vcenter receiver VM performance related met… (open-telemetry#37489)
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue. Ex. Adding a feature - Explain what this achieves.--> #### Description This PR adds the following VM performance metrics for vcenter. 1. `vcenter.vm.cpu.time` 2. `vcenter.vm.network.multicast.packet.rate` 3. `vcenter.vm.network.broadcast.packet.rate` More information on these metrics can be found [here](https://docs.vmware.com/en/vRealize-Operations/8.10/com.vmware.vcom.metrics.doc/GUID-41603CD6-453B-4E26-A237-34E733BAB00C.html). and also succinctly described [here](https://www.servicenow.com/docs/bundle/xanadu-it-operations-management/page/product/agent-client-collector/reference/vsphere-metrics.html) <!-- Issue number (e.g. open-telemetry#1234) or full URL to issue, if applicable. --> open-telemetry#37488 <!--Describe what testing was performed and which tests were added.--> #### Testing The metrics were scraped from a test vCenter environment, and golden test files were updated accordingly to reflect the addition of the metric. <!--Describe the documentation added.--> #### Documentation Documentation was updated according to the metadata.yaml <img width="1776" alt="evidence1" src="https://github.com/user-attachments/assets/662d6ff5-dda5-4e56-b124-5b401992871a" /> <img width="650" alt="Screenshot 2025-01-29 at 10 48 33 AM" src="https://github.com/user-attachments/assets/c421ed17-d718-4f78-b5d1-4b96627d7584" /> <img width="125" alt="Screenshot 2025-01-29 at 10 53 54 AM" src="https://github.com/user-attachments/assets/12317bf0-d767-4d6d-ad2f-0daf07c18555" /> <img width="933" alt="Screenshot 2025-01-29 at 10 54 11 AM" src="https://github.com/user-attachments/assets/331a31fb-0574-4465-8fc5-240be40e2684" /> Signed-off-by: Samiur Arif <[email protected]>
1 parent 82b6b55 commit 1274615

File tree

12 files changed

+1712
-353
lines changed

12 files changed

+1712
-353
lines changed
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Use this changelog template to create an entry for release notes.
2+
3+
# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
4+
change_type: enhancement
5+
6+
# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
7+
component: vcenterreceiver
8+
9+
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
10+
note: Adds three more vCenter virtual machine performance metrics
11+
12+
# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
13+
issues: [37488]
14+
15+
# (Optional) One or more lines of additional information to render under the primary note.
16+
# These lines will be padded with 2 spaces and then inserted directly into the document.
17+
# Use pipe (|) for multiline entries.
18+
subtext:
19+
20+
# If your change doesn't affect end users or the exported elements of any package,
21+
# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
22+
# Optional: The change log or logs in which this entry should be included.
23+
# e.g. '[user]' or '[user, api]'
24+
# Include 'user' if the change is relevant to end users.
25+
# Include 'api' if there is a change to a library API.
26+
# Default: '[user]'
27+
change_logs: [user]

receiver/vcenterreceiver/documentation.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -820,6 +820,23 @@ Total memory capacity of the host system.
820820
| ---- | ----------- | ---------- | ----------------------- | --------- |
821821
| MiBy | Sum | Double | Cumulative | false |
822822
823+
### vcenter.vm.cpu.time
824+
825+
CPU time spent in idle, ready or wait state.
826+
827+
As measured over the most recent 20s interval.
828+
829+
| Unit | Metric Type | Value Type |
830+
| ---- | ----------- | ---------- |
831+
| % | Gauge | Double |
832+
833+
#### Attributes
834+
835+
| Name | Description | Values |
836+
| ---- | ----------- | ------ |
837+
| cpu_state | CPU time spent in idle, ready or idle state. | Str: ``idle``, ``ready``, ``wait`` |
838+
| object | The object on the virtual machine or host that is being reported on. | Any Str |
839+
823840
### vcenter.vm.memory.granted
824841
825842
The amount of memory that is granted to a VM.
@@ -828,6 +845,40 @@ The amount of memory that is granted to a VM.
828845
| ---- | ----------- | ---------- | ----------------------- | --------- |
829846
| MiBy | Sum | Int | Cumulative | false |
830847
848+
### vcenter.vm.network.broadcast.packet.rate
849+
850+
The rate of broadcast packets transmitted or received by each vNIC (virtual network interface controller) on the virtual machine.
851+
852+
As measured over the most recent 20s interval.
853+
854+
| Unit | Metric Type | Value Type |
855+
| ---- | ----------- | ---------- |
856+
| {packets/s} | Gauge | Double |
857+
858+
#### Attributes
859+
860+
| Name | Description | Values |
861+
| ---- | ----------- | ------ |
862+
| direction | The direction of network throughput. | Str: ``transmitted``, ``received`` |
863+
| object | The object on the virtual machine or host that is being reported on. | Any Str |
864+
865+
### vcenter.vm.network.multicast.packet.rate
866+
867+
The rate of multicast packets transmitted or received by each vNIC (virtual network interface controller) on the virtual machine.
868+
869+
As measured over the most recent 20s interval.
870+
871+
| Unit | Metric Type | Value Type |
872+
| ---- | ----------- | ---------- |
873+
| {packets/s} | Gauge | Double |
874+
875+
#### Attributes
876+
877+
| Name | Description | Values |
878+
| ---- | ----------- | ------ |
879+
| direction | The direction of network throughput. | Str: ``transmitted``, ``received`` |
880+
| object | The object on the virtual machine or host that is being reported on. | Any Str |
881+
831882
## Resource Attributes
832883
833884
| Name | Description | Values | Enabled |

receiver/vcenterreceiver/internal/metadata/generated_config.go

Lines changed: 80 additions & 68 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)