Skip to content

Commit b4b07d5

Browse files
authored
[receiver/vcenter] Enabled vCenter Datacenter metrics by default (open-telemetry#34228)
**Description:** <Describe what has changed.> <!--Ex. Fixing a bug - Describe the bug and how this fixes the issue. --> The following PR enabled all the metrics that are to be released by v.0.106.0 by default. <!-- Ex. Adding a feature - Explain what this achieves.--> **Link to tracking Issue:** <Issue number if applicable> **Testing:** <Describe what testing was performed and which tests were added.> - Ran integration test, passing - Ran scraper test, passing. **Documentation:** <Describe the documentation added.> Updated documentation using `make generate`
1 parent 13366cc commit b4b07d5

File tree

11 files changed

+507
-244
lines changed

11 files changed

+507
-244
lines changed
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
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: "Enables various vCenter metrics that were disabled by default until v0.106.0"
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: [33607]
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 metrics will be enabled by default "vcenter.datacenter.cluster.count", "vcenter.datacenter.vm.count", "vcenter.datacenter.datastore.count",
20+
"vcenter.datacenter.host.count", "vcenter.datacenter.disk.space", "vcenter.datacenter.cpu.limit", "vcenter.datacenter.memory.limit",
21+
"vcenter.resource_pool.memory.swapped", "vcenter.resource_pool.memory.ballooned", and "vcenter.resource_pool.memory.granted". The
22+
"resourcePoolMemoryUsageAttribute" has also been bumped up to release v.0.107.0
23+
24+
# If your change doesn't affect end users or the exported elements of any package,
25+
# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
26+
# Optional: The change log or logs in which this entry should be included.
27+
# e.g. '[user]' or '[user, api]'
28+
# Include 'user' if the change is relevant to end users.
29+
# Include 'api' if there is a change to a library API.
30+
# Default: '[user]'
31+
change_logs: [user]

receiver/vcenterreceiver/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,4 +63,4 @@ the `vcenter.resource_pool.memory.usage` metric.
6363

6464
This feature gate will eventually be enabled by default, and eventually the old implementation will be removed. It aims
6565
to give users time to migrate to the new implementation. The target release for this featuregate to be enabled by default
66-
is v0.106.0.
66+
is v0.107.0.

receiver/vcenterreceiver/documentation.md

Lines changed: 112 additions & 122 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,88 @@ The number of virtual machine templates in the cluster.
8282
| ---- | ----------- | ---------- | ----------------------- | --------- |
8383
| {virtual_machine_templates} | Sum | Int | Cumulative | false |
8484
85+
### vcenter.datacenter.cluster.count
86+
87+
The number of clusters in the datacenter.
88+
89+
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
90+
| ---- | ----------- | ---------- | ----------------------- | --------- |
91+
| {clusters} | Sum | Int | Cumulative | false |
92+
93+
#### Attributes
94+
95+
| Name | Description | Values |
96+
| ---- | ----------- | ------ |
97+
| status | The current status of the managed entity. | Str: ``red``, ``yellow``, ``green``, ``gray`` |
98+
99+
### vcenter.datacenter.cpu.limit
100+
101+
The total amount of CPU available to the datacenter.
102+
103+
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
104+
| ---- | ----------- | ---------- | ----------------------- | --------- |
105+
| {MHz} | Sum | Int | Cumulative | false |
106+
107+
### vcenter.datacenter.datastore.count
108+
109+
The number of datastores in the datacenter.
110+
111+
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
112+
| ---- | ----------- | ---------- | ----------------------- | --------- |
113+
| {datastores} | Sum | Int | Cumulative | false |
114+
115+
### vcenter.datacenter.disk.space
116+
117+
The amount of available and used disk space in the datacenter.
118+
119+
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
120+
| ---- | ----------- | ---------- | ----------------------- | --------- |
121+
| By | Sum | Int | Cumulative | false |
122+
123+
#### Attributes
124+
125+
| Name | Description | Values |
126+
| ---- | ----------- | ------ |
127+
| disk_state | The state of storage and whether it is already allocated or free. | Str: ``available``, ``used`` |
128+
129+
### vcenter.datacenter.host.count
130+
131+
The number of hosts in the datacenter.
132+
133+
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
134+
| ---- | ----------- | ---------- | ----------------------- | --------- |
135+
| {hosts} | Sum | Int | Cumulative | false |
136+
137+
#### Attributes
138+
139+
| Name | Description | Values |
140+
| ---- | ----------- | ------ |
141+
| status | The current status of the managed entity. | Str: ``red``, ``yellow``, ``green``, ``gray`` |
142+
| power_state | The current power state of the host. | Str: ``on``, ``off``, ``standby``, ``unknown`` |
143+
144+
### vcenter.datacenter.memory.limit
145+
146+
The total amount of memory available to the datacenter.
147+
148+
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
149+
| ---- | ----------- | ---------- | ----------------------- | --------- |
150+
| By | Sum | Int | Cumulative | false |
151+
152+
### vcenter.datacenter.vm.count
153+
154+
The number of VM's in the datacenter.
155+
156+
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
157+
| ---- | ----------- | ---------- | ----------------------- | --------- |
158+
| {virtual_machines} | Sum | Int | Cumulative | false |
159+
160+
#### Attributes
161+
162+
| Name | Description | Values |
163+
| ---- | ----------- | ------ |
164+
| status | The current status of the managed entity. | Str: ``red``, ``yellow``, ``green``, ``gray`` |
165+
| power_state | The current power state of the virtual machine. | Str: ``on``, ``off``, ``suspended``, ``unknown`` |
166+
85167
### vcenter.datastore.disk.usage
86168
87169
The amount of space in the datastore.
@@ -306,6 +388,28 @@ The usage of the CPU used by the resource pool.
306388
| ---- | ----------- | ---------- | ----------------------- | --------- |
307389
| {MHz} | Sum | Int | Cumulative | false |
308390
391+
### vcenter.resource_pool.memory.ballooned
392+
393+
The amount of memory in a resource pool that is ballooned due to virtualization.
394+
395+
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
396+
| ---- | ----------- | ---------- | ----------------------- | --------- |
397+
| MiBy | Sum | Int | Cumulative | false |
398+
399+
### vcenter.resource_pool.memory.granted
400+
401+
The amount of memory that is granted to VMs in the resource pool from shared and non-shared host memory.
402+
403+
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
404+
| ---- | ----------- | ---------- | ----------------------- | --------- |
405+
| MiBy | Sum | Int | Cumulative | false |
406+
407+
#### Attributes
408+
409+
| Name | Description | Values |
410+
| ---- | ----------- | ------ |
411+
| type | The type of memory granted. | Str: ``private``, ``shared`` |
412+
309413
### vcenter.resource_pool.memory.shares
310414
311415
The amount of shares of memory in the resource pool.
@@ -314,6 +418,14 @@ The amount of shares of memory in the resource pool.
314418
| ---- | ----------- | ---------- | ----------------------- | --------- |
315419
| {shares} | Sum | Int | Cumulative | false |
316420
421+
### vcenter.resource_pool.memory.swapped
422+
423+
The amount of memory that is granted to VMs in the resource pool from the host's swap space.
424+
425+
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
426+
| ---- | ----------- | ---------- | ----------------------- | --------- |
427+
| MiBy | Sum | Int | Cumulative | false |
428+
317429
### vcenter.resource_pool.memory.usage
318430
319431
The usage of the memory by the resource pool.
@@ -530,128 +642,6 @@ As measured over the most recent 20s interval.
530642
| ---- | ----------- | ------ |
531643
| object | The object on the virtual machine or host that is being reported on. | Any Str |
532644
533-
## Optional Metrics
534-
535-
The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration:
536-
537-
```yaml
538-
metrics:
539-
<metric_name>:
540-
enabled: true
541-
```
542-
543-
### vcenter.datacenter.cluster.count
544-
545-
The number of clusters in the datacenter.
546-
547-
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
548-
| ---- | ----------- | ---------- | ----------------------- | --------- |
549-
| {clusters} | Sum | Int | Cumulative | false |
550-
551-
#### Attributes
552-
553-
| Name | Description | Values |
554-
| ---- | ----------- | ------ |
555-
| status | The current status of the managed entity. | Str: ``red``, ``yellow``, ``green``, ``gray`` |
556-
557-
### vcenter.datacenter.cpu.limit
558-
559-
The total amount of CPU available to the datacenter.
560-
561-
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
562-
| ---- | ----------- | ---------- | ----------------------- | --------- |
563-
| {MHz} | Sum | Int | Cumulative | false |
564-
565-
### vcenter.datacenter.datastore.count
566-
567-
The number of datastores in the datacenter.
568-
569-
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
570-
| ---- | ----------- | ---------- | ----------------------- | --------- |
571-
| {datastores} | Sum | Int | Cumulative | false |
572-
573-
### vcenter.datacenter.disk.space
574-
575-
The amount of available and used disk space in the datacenter.
576-
577-
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
578-
| ---- | ----------- | ---------- | ----------------------- | --------- |
579-
| By | Sum | Int | Cumulative | false |
580-
581-
#### Attributes
582-
583-
| Name | Description | Values |
584-
| ---- | ----------- | ------ |
585-
| disk_state | The state of storage and whether it is already allocated or free. | Str: ``available``, ``used`` |
586-
587-
### vcenter.datacenter.host.count
588-
589-
The number of hosts in the datacenter.
590-
591-
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
592-
| ---- | ----------- | ---------- | ----------------------- | --------- |
593-
| {hosts} | Sum | Int | Cumulative | false |
594-
595-
#### Attributes
596-
597-
| Name | Description | Values |
598-
| ---- | ----------- | ------ |
599-
| status | The current status of the managed entity. | Str: ``red``, ``yellow``, ``green``, ``gray`` |
600-
| power_state | The current power state of the host. | Str: ``on``, ``off``, ``standby``, ``unknown`` |
601-
602-
### vcenter.datacenter.memory.limit
603-
604-
The total amount of memory available to the datacenter.
605-
606-
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
607-
| ---- | ----------- | ---------- | ----------------------- | --------- |
608-
| By | Sum | Int | Cumulative | false |
609-
610-
### vcenter.datacenter.vm.count
611-
612-
The number of VM's in the datacenter.
613-
614-
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
615-
| ---- | ----------- | ---------- | ----------------------- | --------- |
616-
| {virtual_machines} | Sum | Int | Cumulative | false |
617-
618-
#### Attributes
619-
620-
| Name | Description | Values |
621-
| ---- | ----------- | ------ |
622-
| status | The current status of the managed entity. | Str: ``red``, ``yellow``, ``green``, ``gray`` |
623-
| power_state | The current power state of the virtual machine. | Str: ``on``, ``off``, ``suspended``, ``unknown`` |
624-
625-
### vcenter.resource_pool.memory.ballooned
626-
627-
The amount of memory in a resource pool that is ballooned due to virtualization.
628-
629-
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
630-
| ---- | ----------- | ---------- | ----------------------- | --------- |
631-
| MiBy | Sum | Int | Cumulative | false |
632-
633-
### vcenter.resource_pool.memory.granted
634-
635-
The amount of memory that is granted to VMs in the resource pool from shared and non-shared host memory.
636-
637-
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
638-
| ---- | ----------- | ---------- | ----------------------- | --------- |
639-
| MiBy | Sum | Int | Cumulative | false |
640-
641-
#### Attributes
642-
643-
| Name | Description | Values |
644-
| ---- | ----------- | ------ |
645-
| type | The type of memory granted. | Str: ``private``, ``shared`` |
646-
647-
### vcenter.resource_pool.memory.swapped
648-
649-
The amount of memory that is granted to VMs in the resource pool from the host's swap space.
650-
651-
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
652-
| ---- | ----------- | ---------- | ----------------------- | --------- |
653-
| MiBy | Sum | Int | Cumulative | false |
654-
655645
## Resource Attributes
656646
657647
| Name | Description | Values | Enabled |

receiver/vcenterreceiver/internal/metadata/generated_config.go

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

receiver/vcenterreceiver/internal/metadata/generated_metrics.go

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

0 commit comments

Comments
 (0)