Skip to content

Commit 86249ea

Browse files
StefanKurekStefanKurek
authored
[receiver/vcenter] Replaces Deprecated Packet Metrics (#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> #32929 #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.
1 parent 54b25f7 commit 86249ea

File tree

13 files changed

+1261
-3903
lines changed

13 files changed

+1261
-3903
lines changed

‎.chloggen/vcenter-replace_deprecated_metrics.yaml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
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: breaking
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: vcenterreceiver replaces deprecated packet metrics by removing them and enabling by default the newer ones.
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: [32929, 32835]
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+
Removes the following metrics: `vcenter.host.network.packet.errors`, `vcenter.host.network.packet.count`, and
20+
`vcenter.vm.network.packet.count`.
21+
22+
Also enables by default the following metrics: `vcenter.host.network.packet.error.rate`,
23+
`vcenter.host.network.packet.rate`, and `vcenter.vm.network.packet.rate`.
24+
25+
# If your change doesn't affect end users or the exported elements of any package,
26+
# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
27+
# Optional: The change log or logs in which this entry should be included.
28+
# e.g. '[user]' or '[user, api]'
29+
# Include 'user' if the change is relevant to end users.
30+
# Include 'api' if there is a change to a library API.
31+
# Default: '[user]'
32+
change_logs: [user]

‎receiver/vcenterreceiver/documentation.md

Lines changed: 27 additions & 84 deletions
Original file line numberDiff line numberDiff line change
@@ -186,13 +186,15 @@ The percentage of the host system's memory capacity that is being utilized.
186186
| ---- | ----------- | ---------- |
187187
| % | Gauge | Double |
188188
189-
### vcenter.host.network.packet.count
189+
### vcenter.host.network.packet.error.rate
190190
191-
The number of packets transmitted and received, as measured over the most recent 20s interval.
191+
The rate of packet errors transmitted or received on the host network.
192192
193-
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
194-
| ---- | ----------- | ---------- | ----------------------- | --------- |
195-
| {packets/sec} | Sum | Int | Cumulative | false |
193+
As measured over the most recent 20s interval.
194+
195+
| Unit | Metric Type | Value Type |
196+
| ---- | ----------- | ---------- |
197+
| {errors/sec} | Gauge | Double |
196198
197199
#### Attributes
198200
@@ -201,15 +203,15 @@ The number of packets transmitted and received, as measured over the most recent
201203
| direction | The direction of network throughput. | Str: ``transmitted``, ``received`` |
202204
| object | The object on the virtual machine or host that is being reported on. | Any Str |
203205
204-
### vcenter.host.network.packet.errors
206+
### vcenter.host.network.packet.rate
205207
206-
The summation of packet errors on the host network.
208+
The rate of packets transmitted or received across each physical NIC (network interface controller) instance on the host.
207209
208210
As measured over the most recent 20s interval.
209211
210-
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
211-
| ---- | ----------- | ---------- | ----------------------- | --------- |
212-
| {errors} | Sum | Int | Cumulative | false |
212+
| Unit | Metric Type | Value Type |
213+
| ---- | ----------- | ---------- |
214+
| {packets/sec} | Gauge | Double |
213215
214216
#### Attributes
215217
@@ -408,73 +410,15 @@ The memory utilization of the VM.
408410
| ---- | ----------- | ---------- |
409411
| % | Gauge | Double |
410412
411-
### vcenter.vm.network.packet.count
412-
413-
The amount of packets that was received or transmitted over the instance's network.
414-
415-
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
416-
| ---- | ----------- | ---------- | ----------------------- | --------- |
417-
| {packets/sec} | Sum | Int | Cumulative | false |
418-
419-
#### Attributes
420-
421-
| Name | Description | Values |
422-
| ---- | ----------- | ------ |
423-
| direction | The direction of network throughput. | Str: ``transmitted``, ``received`` |
424-
| object | The object on the virtual machine or host that is being reported on. | Any Str |
425-
426-
### vcenter.vm.network.throughput
427-
428-
The amount of data that was transmitted or received over the network of the virtual machine.
429-
430-
As measured over the most recent 20s interval.
431-
432-
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
433-
| ---- | ----------- | ---------- | ----------------------- | --------- |
434-
| By/sec | Sum | Int | Cumulative | false |
435-
436-
#### Attributes
437-
438-
| Name | Description | Values |
439-
| ---- | ----------- | ------ |
440-
| direction | The direction of network throughput. | Str: ``transmitted``, ``received`` |
441-
| object | The object on the virtual machine or host that is being reported on. | Any Str |
442-
443-
### vcenter.vm.network.usage
444-
445-
The network utilization combined transmit and receive rates during an interval.
446-
447-
As measured over the most recent 20s interval.
448-
449-
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
450-
| ---- | ----------- | ---------- | ----------------------- | --------- |
451-
| {KiBy/s} | Sum | Int | Cumulative | false |
452-
453-
#### Attributes
454-
455-
| Name | Description | Values |
456-
| ---- | ----------- | ------ |
457-
| object | The object on the virtual machine or host that is being reported on. | Any Str |
458-
459-
## Optional Metrics
460-
461-
The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration:
462-
463-
```yaml
464-
metrics:
465-
<metric_name>:
466-
enabled: true
467-
```
468-
469-
### vcenter.host.network.packet.error.rate
413+
### vcenter.vm.network.packet.drop.rate
470414
471-
The rate of packet errors transmitted or received on the host network.
415+
The rate of transmitted or received packets dropped by each vNIC (virtual network interface controller) on the virtual machine.
472416
473417
As measured over the most recent 20s interval.
474418
475419
| Unit | Metric Type | Value Type |
476420
| ---- | ----------- | ---------- |
477-
| {errors/sec} | Gauge | Double |
421+
| {packets/sec} | Gauge | Double |
478422
479423
#### Attributes
480424
@@ -483,9 +427,9 @@ As measured over the most recent 20s interval.
483427
| direction | The direction of network throughput. | Str: ``transmitted``, ``received`` |
484428
| object | The object on the virtual machine or host that is being reported on. | Any Str |
485429
486-
### vcenter.host.network.packet.rate
430+
### vcenter.vm.network.packet.rate
487431
488-
The rate of packets transmitted or received across each physical NIC (network interface controller) instance on the host.
432+
The rate of packets transmitted or received by each vNIC (virtual network interface controller) on the virtual machine.
489433
490434
As measured over the most recent 20s interval.
491435
@@ -500,15 +444,15 @@ As measured over the most recent 20s interval.
500444
| direction | The direction of network throughput. | Str: ``transmitted``, ``received`` |
501445
| object | The object on the virtual machine or host that is being reported on. | Any Str |
502446
503-
### vcenter.vm.network.packet.drop.rate
447+
### vcenter.vm.network.throughput
504448
505-
The rate of transmitted or received packets dropped by each vNIC (virtual network interface controller) on the virtual machine.
449+
The amount of data that was transmitted or received over the network of the virtual machine.
506450
507451
As measured over the most recent 20s interval.
508452
509-
| Unit | Metric Type | Value Type |
510-
| ---- | ----------- | ---------- |
511-
| {packets/sec} | Gauge | Double |
453+
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
454+
| ---- | ----------- | ---------- | ----------------------- | --------- |
455+
| By/sec | Sum | Int | Cumulative | false |
512456
513457
#### Attributes
514458
@@ -517,21 +461,20 @@ As measured over the most recent 20s interval.
517461
| direction | The direction of network throughput. | Str: ``transmitted``, ``received`` |
518462
| object | The object on the virtual machine or host that is being reported on. | Any Str |
519463
520-
### vcenter.vm.network.packet.rate
464+
### vcenter.vm.network.usage
521465
522-
The rate of packets transmitted or received by each vNIC (virtual network interface controller) on the virtual machine.
466+
The network utilization combined transmit and receive rates during an interval.
523467
524468
As measured over the most recent 20s interval.
525469
526-
| Unit | Metric Type | Value Type |
527-
| ---- | ----------- | ---------- |
528-
| {packets/sec} | Gauge | Double |
470+
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
471+
| ---- | ----------- | ---------- | ----------------------- | --------- |
472+
| {KiBy/s} | Sum | Int | Cumulative | false |
529473
530474
#### Attributes
531475
532476
| Name | Description | Values |
533477
| ---- | ----------- | ------ |
534-
| direction | The direction of network throughput. | Str: ``transmitted``, ``received`` |
535478
| object | The object on the virtual machine or host that is being reported on. | Any Str |
536479
537480
## Resource Attributes

0 commit comments

Comments
 (0)