Skip to content

Commit

Permalink
[receiver/vcenter] Replaces Deprecated Packet Metrics (open-telemetry…
Browse files Browse the repository at this point in the history
…#33167)

**Description:** <Describe what has changed.>
This mostly replaced deprecated packet metrics which already had a
warning. Namely `vcenter.host.network.packet.errors`,
`vcenter.host.network.packet.count`, and
`vcenter.vm.network.packet.count`. They are replaced through enabling by
default (while removing the existing warnings) the metrics
`vcenter.host.network.packet.error.rate`,
`vcenter.host.network.packet.rate`, and `vcenter.vm.network.packet.rate`
respectively.

The metric `vcenter.vm.network.packet.rate` is also enabled by default
(while removing its current warning).

**Link to tracking Issue:** <Issue number if applicable>
open-telemetry#32929 open-telemetry#32835

**Testing:** <Describe what testing was performed and which tests were
added.>
Unit tests updated/ran. Integration tests ran. Local environment
checked.

**Documentation:** <Describe the documentation added.>
Documentation regenerated from metadata.
  • Loading branch information
StefanKurek authored May 22, 2024
1 parent 54b25f7 commit 86249ea
Show file tree
Hide file tree
Showing 13 changed files with 1,261 additions and 3,903 deletions.
32 changes: 32 additions & 0 deletions .chloggen/vcenter-replace_deprecated_metrics.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# 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: vcenterreceiver replaces deprecated packet metrics by removing them and enabling by default the newer ones.

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

# (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: |
Removes the following metrics: `vcenter.host.network.packet.errors`, `vcenter.host.network.packet.count`, and
`vcenter.vm.network.packet.count`.
Also enables by default the following metrics: `vcenter.host.network.packet.error.rate`,
`vcenter.host.network.packet.rate`, and `vcenter.vm.network.packet.rate`.
# 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]
111 changes: 27 additions & 84 deletions receiver/vcenterreceiver/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -186,13 +186,15 @@ The percentage of the host system's memory capacity that is being utilized.
| ---- | ----------- | ---------- |
| % | Gauge | Double |
### vcenter.host.network.packet.count
### vcenter.host.network.packet.error.rate
The number of packets transmitted and received, as measured over the most recent 20s interval.
The rate of packet errors transmitted or received on the host network.
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
| {packets/sec} | Sum | Int | Cumulative | false |
As measured over the most recent 20s interval.
| Unit | Metric Type | Value Type |
| ---- | ----------- | ---------- |
| {errors/sec} | Gauge | Double |
#### Attributes
Expand All @@ -201,15 +203,15 @@ The number of packets transmitted and received, as measured over the most recent
| 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.errors
### vcenter.host.network.packet.rate
The summation of packet errors on the host network.
The rate of packets transmitted or received across each physical NIC (network interface controller) instance on the host.
As measured over the most recent 20s interval.
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
| {errors} | Sum | Int | Cumulative | false |
| Unit | Metric Type | Value Type |
| ---- | ----------- | ---------- |
| {packets/sec} | Gauge | Double |
#### Attributes
Expand Down Expand Up @@ -408,73 +410,15 @@ The memory utilization of the VM.
| ---- | ----------- | ---------- |
| % | Gauge | Double |
### vcenter.vm.network.packet.count
The amount of packets that was received or transmitted over the instance's network.
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
| {packets/sec} | Sum | Int | Cumulative | false |
#### 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.throughput
The amount of data that was transmitted or received over the network of the virtual machine.
As measured over the most recent 20s interval.
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
| By/sec | Sum | Int | Cumulative | false |
#### 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.usage
The network utilization combined transmit and receive rates during an interval.
As measured over the most recent 20s interval.
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
| {KiBy/s} | Sum | Int | Cumulative | false |
#### Attributes
| Name | Description | Values |
| ---- | ----------- | ------ |
| object | The object on the virtual machine or host that is being reported on. | Any Str |
## Optional Metrics
The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration:
```yaml
metrics:
<metric_name>:
enabled: true
```
### vcenter.host.network.packet.error.rate
### vcenter.vm.network.packet.drop.rate
The rate of packet errors transmitted or received on the host network.
The rate of transmitted or received packets dropped by each vNIC (virtual network interface controller) on the virtual machine.
As measured over the most recent 20s interval.
| Unit | Metric Type | Value Type |
| ---- | ----------- | ---------- |
| {errors/sec} | Gauge | Double |
| {packets/sec} | Gauge | Double |
#### Attributes
Expand All @@ -483,9 +427,9 @@ As measured over the most recent 20s interval.
| 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.rate
### vcenter.vm.network.packet.rate
The rate of packets transmitted or received across each physical NIC (network interface controller) instance on the host.
The rate of packets transmitted or received by each vNIC (virtual network interface controller) on the virtual machine.
As measured over the most recent 20s interval.
Expand All @@ -500,15 +444,15 @@ As measured over the most recent 20s interval.
| 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.packet.drop.rate
### vcenter.vm.network.throughput
The rate of transmitted or received packets dropped by each vNIC (virtual network interface controller) on the virtual machine.
The amount of data that was transmitted or received over the network of the virtual machine.
As measured over the most recent 20s interval.
| Unit | Metric Type | Value Type |
| ---- | ----------- | ---------- |
| {packets/sec} | Gauge | Double |
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
| By/sec | Sum | Int | Cumulative | false |
#### Attributes
Expand All @@ -517,21 +461,20 @@ As measured over the most recent 20s interval.
| 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.packet.rate
### vcenter.vm.network.usage
The rate of packets transmitted or received by each vNIC (virtual network interface controller) on the virtual machine.
The network utilization combined transmit and receive rates during an interval.
As measured over the most recent 20s interval.
| Unit | Metric Type | Value Type |
| ---- | ----------- | ---------- |
| {packets/sec} | Gauge | Double |
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
| {KiBy/s} | Sum | Int | Cumulative | false |
#### 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
Expand Down
Loading

0 comments on commit 86249ea

Please sign in to comment.