Skip to content

Commit

Permalink
[receiver/vcenter] Enabled vCenter Datacenter metrics by default (#34228
Browse files Browse the repository at this point in the history
)

**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`
  • Loading branch information
BominRahmani authored Jul 23, 2024
1 parent 13366cc commit b4b07d5
Show file tree
Hide file tree
Showing 11 changed files with 507 additions and 244 deletions.
31 changes: 31 additions & 0 deletions .chloggen/enable-vcenter-datacenter-resource-pool-metrics.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# 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: "Enables various vCenter metrics that were disabled by default until v0.106.0"

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

# (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: |
The following metrics will be enabled by default "vcenter.datacenter.cluster.count", "vcenter.datacenter.vm.count", "vcenter.datacenter.datastore.count",
"vcenter.datacenter.host.count", "vcenter.datacenter.disk.space", "vcenter.datacenter.cpu.limit", "vcenter.datacenter.memory.limit",
"vcenter.resource_pool.memory.swapped", "vcenter.resource_pool.memory.ballooned", and "vcenter.resource_pool.memory.granted". The
"resourcePoolMemoryUsageAttribute" has also been bumped up to release v.0.107.0
# 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]
2 changes: 1 addition & 1 deletion receiver/vcenterreceiver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,4 +63,4 @@ the `vcenter.resource_pool.memory.usage` metric.

This feature gate will eventually be enabled by default, and eventually the old implementation will be removed. It aims
to give users time to migrate to the new implementation. The target release for this featuregate to be enabled by default
is v0.106.0.
is v0.107.0.
234 changes: 112 additions & 122 deletions receiver/vcenterreceiver/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,88 @@ The number of virtual machine templates in the cluster.
| ---- | ----------- | ---------- | ----------------------- | --------- |
| {virtual_machine_templates} | Sum | Int | Cumulative | false |
### vcenter.datacenter.cluster.count
The number of clusters in the datacenter.
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
| {clusters} | Sum | Int | Cumulative | false |
#### Attributes
| Name | Description | Values |
| ---- | ----------- | ------ |
| status | The current status of the managed entity. | Str: ``red``, ``yellow``, ``green``, ``gray`` |
### vcenter.datacenter.cpu.limit
The total amount of CPU available to the datacenter.
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
| {MHz} | Sum | Int | Cumulative | false |
### vcenter.datacenter.datastore.count
The number of datastores in the datacenter.
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
| {datastores} | Sum | Int | Cumulative | false |
### vcenter.datacenter.disk.space
The amount of available and used disk space in the datacenter.
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
| By | Sum | Int | Cumulative | false |
#### Attributes
| Name | Description | Values |
| ---- | ----------- | ------ |
| disk_state | The state of storage and whether it is already allocated or free. | Str: ``available``, ``used`` |
### vcenter.datacenter.host.count
The number of hosts in the datacenter.
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
| {hosts} | Sum | Int | Cumulative | false |
#### Attributes
| Name | Description | Values |
| ---- | ----------- | ------ |
| status | The current status of the managed entity. | Str: ``red``, ``yellow``, ``green``, ``gray`` |
| power_state | The current power state of the host. | Str: ``on``, ``off``, ``standby``, ``unknown`` |
### vcenter.datacenter.memory.limit
The total amount of memory available to the datacenter.
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
| By | Sum | Int | Cumulative | false |
### vcenter.datacenter.vm.count
The number of VM's in the datacenter.
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
| {virtual_machines} | Sum | Int | Cumulative | false |
#### Attributes
| Name | Description | Values |
| ---- | ----------- | ------ |
| status | The current status of the managed entity. | Str: ``red``, ``yellow``, ``green``, ``gray`` |
| power_state | The current power state of the virtual machine. | Str: ``on``, ``off``, ``suspended``, ``unknown`` |
### vcenter.datastore.disk.usage
The amount of space in the datastore.
Expand Down Expand Up @@ -306,6 +388,28 @@ The usage of the CPU used by the resource pool.
| ---- | ----------- | ---------- | ----------------------- | --------- |
| {MHz} | Sum | Int | Cumulative | false |
### vcenter.resource_pool.memory.ballooned
The amount of memory in a resource pool that is ballooned due to virtualization.
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
| MiBy | Sum | Int | Cumulative | false |
### vcenter.resource_pool.memory.granted
The amount of memory that is granted to VMs in the resource pool from shared and non-shared host memory.
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
| MiBy | Sum | Int | Cumulative | false |
#### Attributes
| Name | Description | Values |
| ---- | ----------- | ------ |
| type | The type of memory granted. | Str: ``private``, ``shared`` |
### vcenter.resource_pool.memory.shares
The amount of shares of memory in the resource pool.
Expand All @@ -314,6 +418,14 @@ The amount of shares of memory in the resource pool.
| ---- | ----------- | ---------- | ----------------------- | --------- |
| {shares} | Sum | Int | Cumulative | false |
### vcenter.resource_pool.memory.swapped
The amount of memory that is granted to VMs in the resource pool from the host's swap space.
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
| MiBy | Sum | Int | Cumulative | false |
### vcenter.resource_pool.memory.usage
The usage of the memory by the resource pool.
Expand Down Expand Up @@ -530,128 +642,6 @@ As measured over the most recent 20s interval.
| ---- | ----------- | ------ |
| 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.datacenter.cluster.count
The number of clusters in the datacenter.
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
| {clusters} | Sum | Int | Cumulative | false |
#### Attributes
| Name | Description | Values |
| ---- | ----------- | ------ |
| status | The current status of the managed entity. | Str: ``red``, ``yellow``, ``green``, ``gray`` |
### vcenter.datacenter.cpu.limit
The total amount of CPU available to the datacenter.
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
| {MHz} | Sum | Int | Cumulative | false |
### vcenter.datacenter.datastore.count
The number of datastores in the datacenter.
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
| {datastores} | Sum | Int | Cumulative | false |
### vcenter.datacenter.disk.space
The amount of available and used disk space in the datacenter.
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
| By | Sum | Int | Cumulative | false |
#### Attributes
| Name | Description | Values |
| ---- | ----------- | ------ |
| disk_state | The state of storage and whether it is already allocated or free. | Str: ``available``, ``used`` |
### vcenter.datacenter.host.count
The number of hosts in the datacenter.
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
| {hosts} | Sum | Int | Cumulative | false |
#### Attributes
| Name | Description | Values |
| ---- | ----------- | ------ |
| status | The current status of the managed entity. | Str: ``red``, ``yellow``, ``green``, ``gray`` |
| power_state | The current power state of the host. | Str: ``on``, ``off``, ``standby``, ``unknown`` |
### vcenter.datacenter.memory.limit
The total amount of memory available to the datacenter.
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
| By | Sum | Int | Cumulative | false |
### vcenter.datacenter.vm.count
The number of VM's in the datacenter.
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
| {virtual_machines} | Sum | Int | Cumulative | false |
#### Attributes
| Name | Description | Values |
| ---- | ----------- | ------ |
| status | The current status of the managed entity. | Str: ``red``, ``yellow``, ``green``, ``gray`` |
| power_state | The current power state of the virtual machine. | Str: ``on``, ``off``, ``suspended``, ``unknown`` |
### vcenter.resource_pool.memory.ballooned
The amount of memory in a resource pool that is ballooned due to virtualization.
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
| MiBy | Sum | Int | Cumulative | false |
### vcenter.resource_pool.memory.granted
The amount of memory that is granted to VMs in the resource pool from shared and non-shared host memory.
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
| MiBy | Sum | Int | Cumulative | false |
#### Attributes
| Name | Description | Values |
| ---- | ----------- | ------ |
| type | The type of memory granted. | Str: ``private``, ``shared`` |
### vcenter.resource_pool.memory.swapped
The amount of memory that is granted to VMs in the resource pool from the host's swap space.
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
| MiBy | Sum | Int | Cumulative | false |
## Resource Attributes
| Name | Description | Values | Enabled |
Expand Down
20 changes: 10 additions & 10 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.

30 changes: 0 additions & 30 deletions receiver/vcenterreceiver/internal/metadata/generated_metrics.go

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

Loading

0 comments on commit b4b07d5

Please sign in to comment.