Skip to content

Commit

Permalink
added new metrics for vcenter receiver VM performance related met… (#…
Browse files Browse the repository at this point in the history
…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. #1234) or full URL to issue, if applicable. -->
#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]>
  • Loading branch information
samiura authored Feb 5, 2025
1 parent 32635f2 commit f342012
Show file tree
Hide file tree
Showing 12 changed files with 1,712 additions and 353 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Use this changelog template to create an entry for release notes.

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

# 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: Adds three more vCenter virtual machine performance metrics

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

# (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:

# 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]
51 changes: 51 additions & 0 deletions receiver/vcenterreceiver/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -820,6 +820,23 @@ Total memory capacity of the host system.
| ---- | ----------- | ---------- | ----------------------- | --------- |
| MiBy | Sum | Double | Cumulative | false |
### vcenter.vm.cpu.time
CPU time spent in idle, ready or wait state.
As measured over the most recent 20s interval.
| Unit | Metric Type | Value Type |
| ---- | ----------- | ---------- |
| % | Gauge | Double |
#### Attributes
| Name | Description | Values |
| ---- | ----------- | ------ |
| cpu_state | CPU time spent in idle, ready or idle state. | Str: ``idle``, ``ready``, ``wait`` |
| object | The object on the virtual machine or host that is being reported on. | Any Str |
### vcenter.vm.memory.granted
The amount of memory that is granted to a VM.
Expand All @@ -828,6 +845,40 @@ The amount of memory that is granted to a VM.
| ---- | ----------- | ---------- | ----------------------- | --------- |
| MiBy | Sum | Int | Cumulative | false |
### vcenter.vm.network.broadcast.packet.rate
The rate of broadcast packets transmitted or received by each vNIC (virtual network interface controller) on the virtual machine.
As measured over the most recent 20s interval.
| Unit | Metric Type | Value Type |
| ---- | ----------- | ---------- |
| {packets/s} | 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.vm.network.multicast.packet.rate
The rate of multicast packets transmitted or received by each vNIC (virtual network interface controller) on the virtual machine.
As measured over the most recent 20s interval.
| Unit | Metric Type | Value Type |
| ---- | ----------- | ---------- |
| {packets/s} | 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 |
## Resource Attributes
| Name | Description | Values | Enabled |
Expand Down
148 changes: 80 additions & 68 deletions receiver/vcenterreceiver/internal/metadata/generated_config.go

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

Loading

0 comments on commit f342012

Please sign in to comment.