Skip to content

Commit d25990b

Browse files
BominRahmaniBominRahmani
authored
[vcenterreceiver] Updated units on several metrics (open-telemetry#34946)
**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 change works to update several metrics units to be more inline with the semantics declared here: https://opentelemetry.io/docs/specs/semconv/general/metrics/#instrument-units Specifically it changes all the uses of `sec` to `s` and also updates the incorrect unit usage of `{MHz}` to `MHz` on a couple metrics. **Link to tracking Issue:** <Issue number if applicable> **Testing:** <Describe what testing was performed and which tests were added.> All golden package tests were updated, as well as integration tests. **Documentation:** <Describe the documentation added.> Documentation was updated with mdatagen with the use of `make generate`
1 parent 5822332 commit d25990b

File tree

8 files changed

+161
-119
lines changed

8 files changed

+161
-119
lines changed

‎.chloggen/vcenter-unit-update.yaml‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
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: Updated units on several metrics to be more in line with documented semantics.
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: [34946]
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+
The following are the metrics with their respective unit changes:
20+
- vcenter.datacenter.cpu.limit ({MHz} -> MHz)
21+
- vcenter.cluster.cpu.limit ({MHz} -> MHz)
22+
- vcenter.cluster.cpu.effective ({MHz} -> MHz)
23+
- vcenter.cluster.vsan.operations ({operations/sec} -> {operations/s})
24+
- vcenter.cluster.vsan.congestions ({congestions/sec} -> {congestions/s})
25+
- vcenter.host.network.packet.error.rate ({errors/sec} -> {errors/s})
26+
- vcenter.host.network.packet.rate ({packets/sec} -> {packets/s})
27+
- vcenter.host.network.packet.drop.rate ({packets/sec} -> {packets/s})
28+
- vcenter.host.vsan.operations ({operations/sec} -> {operations/s})
29+
- vcenter.host.vsan.congestions ({congestions/sec} -> {congestions/s})
30+
- vcenter.resource_pool.cpu.usage ({MHz} -> MHz)
31+
- vcenter.vm.network.throughput (By/sec -> By/s)
32+
- vcenter.vm.network.packet.rate ({packets/sec} -> {packets/s})
33+
- vcenter.vm.vsan.operations ({operations/sec} -> {operations/s})
34+
35+
# If your change doesn't affect end users or the exported elements of any package,
36+
# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
37+
# Optional: The change log or logs in which this entry should be included.
38+
# e.g. '[user]' or '[user, api]'
39+
# Include 'user' if the change is relevant to end users.
40+
# Include 'api' if there is a change to a library API.
41+
# Default: '[user]'
42+
change_logs: [user]

‎receiver/vcenterreceiver/documentation.md‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,15 @@ The effective CPU available to the cluster. This value excludes CPU from hosts i
1818
1919
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
2020
| ---- | ----------- | ---------- | ----------------------- | --------- |
21-
| {MHz} | Sum | Int | Cumulative | false |
21+
| MHz | Sum | Int | Cumulative | false |
2222
2323
### vcenter.cluster.cpu.limit
2424
2525
The amount of CPU available to the cluster.
2626
2727
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
2828
| ---- | ----------- | ---------- | ----------------------- | --------- |
29-
| {MHz} | Sum | Int | Cumulative | false |
29+
| MHz | Sum | Int | Cumulative | false |
3030
3131
### vcenter.cluster.host.count
3232
@@ -88,7 +88,7 @@ The congestions of IOs generated by all vSAN clients in the cluster.
8888
8989
| Unit | Metric Type | Value Type |
9090
| ---- | ----------- | ---------- |
91-
| {congestions/sec} | Gauge | Double |
91+
| {congestions/s} | Gauge | Double |
9292
9393
### vcenter.cluster.vsan.latency.avg
9494
@@ -110,7 +110,7 @@ The vSAN IOPs of a cluster.
110110
111111
| Unit | Metric Type | Value Type |
112112
| ---- | ----------- | ---------- |
113-
| {operations/sec} | Gauge | Int |
113+
| {operations/s} | Gauge | Int |
114114
115115
#### Attributes
116116
@@ -152,7 +152,7 @@ The total amount of CPU available to the datacenter.
152152
153153
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
154154
| ---- | ----------- | ---------- | ----------------------- | --------- |
155-
| {MHz} | Sum | Int | Cumulative | false |
155+
| MHz | Sum | Int | Cumulative | false |
156156
157157
### vcenter.datacenter.datastore.count
158158
@@ -348,7 +348,7 @@ As measured over the most recent 20s interval.
348348
349349
| Unit | Metric Type | Value Type |
350350
| ---- | ----------- | ---------- |
351-
| {packets/sec} | Gauge | Double |
351+
| {packets/s} | Gauge | Double |
352352
353353
#### Attributes
354354
@@ -365,7 +365,7 @@ As measured over the most recent 20s interval.
365365
366366
| Unit | Metric Type | Value Type |
367367
| ---- | ----------- | ---------- |
368-
| {errors/sec} | Gauge | Double |
368+
| {errors/s} | Gauge | Double |
369369
370370
#### Attributes
371371
@@ -382,7 +382,7 @@ As measured over the most recent 20s interval.
382382
383383
| Unit | Metric Type | Value Type |
384384
| ---- | ----------- | ---------- |
385-
| {packets/sec} | Gauge | Double |
385+
| {packets/s} | Gauge | Double |
386386
387387
#### Attributes
388388
@@ -440,7 +440,7 @@ As measured over the most recent 5m interval.
440440
441441
| Unit | Metric Type | Value Type |
442442
| ---- | ----------- | ---------- |
443-
| {congestions/sec} | Gauge | Double |
443+
| {congestions/s} | Gauge | Double |
444444
445445
### vcenter.host.vsan.latency.avg
446446
@@ -466,7 +466,7 @@ As measured over the most recent 5m interval.
466466
467467
| Unit | Metric Type | Value Type |
468468
| ---- | ----------- | ---------- |
469-
| {operations/sec} | Gauge | Int |
469+
| {operations/s} | Gauge | Int |
470470
471471
#### Attributes
472472
@@ -504,7 +504,7 @@ The usage of the CPU used by the resource pool.
504504
505505
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
506506
| ---- | ----------- | ---------- | ----------------------- | --------- |
507-
| {MHz} | Sum | Int | Cumulative | false |
507+
| MHz | Sum | Int | Cumulative | false |
508508
509509
### vcenter.resource_pool.memory.ballooned
510510
@@ -701,7 +701,7 @@ As measured over the most recent 20s interval.
701701
702702
| Unit | Metric Type | Value Type |
703703
| ---- | ----------- | ---------- |
704-
| {packets/sec} | Gauge | Double |
704+
| {packets/s} | Gauge | Double |
705705
706706
#### Attributes
707707
@@ -718,7 +718,7 @@ As measured over the most recent 20s interval.
718718
719719
| Unit | Metric Type | Value Type |
720720
| ---- | ----------- | ---------- |
721-
| {packets/sec} | Gauge | Double |
721+
| {packets/s} | Gauge | Double |
722722
723723
#### Attributes
724724
@@ -735,7 +735,7 @@ As measured over the most recent 20s interval.
735735
736736
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
737737
| ---- | ----------- | ---------- | ----------------------- | --------- |
738-
| By/sec | Sum | Int | Cumulative | false |
738+
| By/s | Sum | Int | Cumulative | false |
739739
740740
#### Attributes
741741
@@ -780,7 +780,7 @@ The vSAN IOPs of a virtual machine.
780780
781781
| Unit | Metric Type | Value Type |
782782
| ---- | ----------- | ---------- |
783-
| {operations/sec} | Gauge | Int |
783+
| {operations/s} | Gauge | Int |
784784
785785
#### Attributes
786786

‎receiver/vcenterreceiver/internal/metadata/generated_metrics.go‎

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

0 commit comments

Comments
 (0)