Skip to content

Commit

Permalink
[receiver/vcenter] Switches Over Metadata Configs Waiting for v0.100.…
Browse files Browse the repository at this point in the history
…0 Release (#32913)

**Description:** <Describe what has changed.>
A number of configurations were disabled by default and had warnings
that they were going to be enabled in v0.101.0 (1 metric had a warning
that it was going to be removed).

Now that v0.100.0 has been release, I have removed all of these
warnings, and made the modifications that the warnings "warned" about. I
have also updated the tests to reflect this.

**Link to tracking Issue:** <Issue number if applicable>
#32803 #32805 #32821 #32531 #32557

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

**Documentation:** <Describe the documentation added.>
New documentation generated based on the metadata.
  • Loading branch information
StefanKurek committed May 8, 2024
1 parent 497fed7 commit fec5543
Show file tree
Hide file tree
Showing 14 changed files with 741 additions and 3,511 deletions.
31 changes: 31 additions & 0 deletions .chloggen/receiver-vcenter_modify-default-configs.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: enhancement

# 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: Changing various default configurations for vcenterreceiver and removing warnings about future release.

# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
issues: [32803, 32805, 32821, 32531, 32557]

# (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 resource attributes that will now be enabled by default are `vcenter.datacenter.name`, `vcenter.virtual_app.name`,
`vcenter.virtual_app.inventory_path`, `vcenter.vm_template.name`, and `vcenter.vm_template.id`. The metric
`vcenter.cluster.memory.used` will be removed. The metrics `vcenter.cluster.vm_template.count` and
`vcenter.vm.memory.utilization` will be enabled by default.
# 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]
50 changes: 21 additions & 29 deletions receiver/vcenterreceiver/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,14 +60,6 @@ The available memory of the cluster.
| ---- | ----------- | ---------- | ----------------------- | --------- |
| By | Sum | Int | Cumulative | false |

### vcenter.cluster.memory.used

The memory that is currently used by the cluster.

| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
| By | Sum | Int | Cumulative | false |

### vcenter.cluster.vm.count

The number of virtual machines in the cluster.
Expand All @@ -82,6 +74,14 @@ The number of virtual machines in the cluster.
| ---- | ----------- | ------ |
| power_state | The current power state of the virtual machine. | Str: ``on``, ``off``, ``suspended`` |

### vcenter.cluster.vm_template.count

The number of virtual machine templates in the cluster.

| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
| {virtual_machine_templates} | Sum | Int | Cumulative | false |

### vcenter.datastore.disk.usage

The amount of space in the datastore.
Expand Down Expand Up @@ -400,6 +400,14 @@ The amount of memory that is used by the virtual machine.
| ---- | ----------- | ---------- | ----------------------- | --------- |
| MiBy | Sum | Int | Cumulative | false |

### vcenter.vm.memory.utilization

The memory utilization of the VM.

| Unit | Metric Type | Value Type |
| ---- | ----------- | ---------- |
| % | Gauge | Double |

### vcenter.vm.network.packet.count

The amount of packets that was received or transmitted over the instance's network.
Expand Down Expand Up @@ -458,14 +466,6 @@ metrics:
enabled: true
```

### vcenter.cluster.vm_template.count

The number of virtual machine templates in the cluster.

| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
| {virtual_machine_templates} | Sum | Int | Cumulative | false |

### vcenter.host.network.packet.error.rate

The rate of packet errors transmitted or received on the host network.
Expand Down Expand Up @@ -500,14 +500,6 @@ 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.memory.utilization

The memory utilization of the VM.

| Unit | Metric Type | Value Type |
| ---- | ----------- | ---------- |
| % | Gauge | Double |

### vcenter.vm.network.packet.drop.rate

The rate of transmitted or received packets dropped by each vNIC (virtual network interface controller) on the virtual machine.
Expand Down Expand Up @@ -547,14 +539,14 @@ As measured over the most recent 20s interval.
| Name | Description | Values | Enabled |
| ---- | ----------- | ------ | ------- |
| vcenter.cluster.name | The name of the vCenter cluster. | Any Str | true |
| vcenter.datacenter.name | The name of the vCenter datacenter. | Any Str | false |
| vcenter.datacenter.name | The name of the vCenter datacenter. | Any Str | true |
| vcenter.datastore.name | The name of the vCenter datastore. | Any Str | true |
| vcenter.host.name | The hostname of the vCenter ESXi host. | Any Str | true |
| vcenter.resource_pool.inventory_path | The inventory path of the resource pool. | Any Str | true |
| vcenter.resource_pool.name | The name of the resource pool. | Any Str | true |
| vcenter.virtual_app.inventory_path | The inventory path of the vApp. | Any Str | false |
| vcenter.virtual_app.name | The name of the vApp. | Any Str | false |
| vcenter.virtual_app.inventory_path | The inventory path of the vApp. | Any Str | true |
| vcenter.virtual_app.name | The name of the vApp. | Any Str | true |
| vcenter.vm.id | The instance UUID of the virtual machine. | Any Str | true |
| vcenter.vm.name | The name of the virtual machine. | Any Str | true |
| vcenter.vm_template.id | The instance UUID of the virtual machine template. | Any Str | false |
| vcenter.vm_template.name | The name of the virtual machine template. | Any Str | false |
| vcenter.vm_template.id | The instance UUID of the virtual machine template. | Any Str | true |
| vcenter.vm_template.name | The name of the virtual machine template. | Any Str | true |
18 changes: 7 additions & 11 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.

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

80 changes: 0 additions & 80 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.

0 comments on commit fec5543

Please sign in to comment.