[receiver/vcenter] Enables the vSAN metrics by default (#34409)

**Description:** <Describe what has changed.> Enables the vSAN metrics by default. Removes the warning about them being enabled in a future version. **Link to tracking Issue:** <Issue number if applicable> **Testing:** <Describe what testing was performed and which tests were added.> Unit tests run. Integration tests run. Test against live environment. **Documentation:** <Describe the documentation added.> Documentation regenerated.
open-telemetry · Aug 5, 2024 · 1d184dc · 1d184dc
1 parent d79b8ef
commit 1d184dc
Show file tree

Hide file tree

Showing 8 changed files with 744 additions and 272 deletions.
diff --git a/.chloggen/vcenterreceiver-vsan-metrics-enabled.yaml b/.chloggen/vcenterreceiver-vsan-metrics-enabled.yaml
@@ -0,0 +1,40 @@
+# 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 all of the vSAN metrics by default.
+
+# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
+issues: [34409]
+
+# (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 now:
+    - vcenter.cluster.vsan.throughput
+    - vcenter.cluster.vsan.operations
+    - vcenter.cluster.vsan.latency.avg
+    - vcenter.cluster.vsan.congestions
+    - vcenter.host.vsan.throughput
+    - vcenter.host.vsan.operations
+    - vcenter.host.vsan.latency.avg
+    - vcenter.host.vsan.congestions
+    - vcenter.host.vsan.cache.hit_rate
+    - vcenter.vm.vsan.throughput
+    - vcenter.vm.vsan.operations
+    - vcenter.vm.vsan.latency.avg
+
+# 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]
diff --git a/receiver/vcenterreceiver/documentation.md b/receiver/vcenterreceiver/documentation.md
@@ -82,6 +82,56 @@ The number of virtual machine templates in the cluster.
 | ---- | ----------- | ---------- | ----------------------- | --------- |
 | {virtual_machine_templates} | Sum | Int | Cumulative | false |
 
+### vcenter.cluster.vsan.congestions
+
+The congestions of IOs generated by all vSAN clients in the cluster.
+
+| Unit | Metric Type | Value Type |
+| ---- | ----------- | ---------- |
+| {congestions/sec} | Gauge | Double |
+
+### vcenter.cluster.vsan.latency.avg
+
+The overall cluster latency while accessing vSAN storage.
+
+| Unit | Metric Type | Value Type |
+| ---- | ----------- | ---------- |
+| us | Gauge | Int |
+
+#### Attributes
+
+| Name | Description | Values |
+| ---- | ----------- | ------ |
+| type | The type of vSAN latency. | Str: ``read``, ``write`` |
+
+### vcenter.cluster.vsan.operations
+
+The vSAN IOPs of a cluster.
+
+| Unit | Metric Type | Value Type |
+| ---- | ----------- | ---------- |
+| {operations/sec} | Gauge | Int |
+
+#### Attributes
+
+| Name | Description | Values |
+| ---- | ----------- | ------ |
+| type | The type of vSAN operation. | Str: ``read``, ``write``, ``unmap`` |
+
+### vcenter.cluster.vsan.throughput
+
+The vSAN throughput of a cluster.
+
+| Unit | Metric Type | Value Type |
+| ---- | ----------- | ---------- |
+| By/s | Gauge | Double |
+
+#### Attributes
+
+| Name | Description | Values |
+| ---- | ----------- | ------ |
+| direction | The type of vSAN throughput. | Str: ``read``, ``write`` |
+
 ### vcenter.datacenter.cluster.count
 
 The number of clusters in the datacenter.
@@ -372,6 +422,74 @@ The sum of the data transmitted and received for all the NIC instances of the ho
 | ---- | ----------- | ------ |
 | object | The object on the virtual machine or host that is being reported on. | Any Str |
 
+### vcenter.host.vsan.cache.hit_rate
+
+The host's read IOs which could be satisfied by the local client cache.
+
+As measured over the most recent 5m interval.
+
+| Unit | Metric Type | Value Type |
+| ---- | ----------- | ---------- |
+| % | Gauge | Int |
+
+### vcenter.host.vsan.congestions
+
+The congestions of IOs generated by all vSAN clients in the host.
+
+As measured over the most recent 5m interval.
+
+| Unit | Metric Type | Value Type |
+| ---- | ----------- | ---------- |
+| {congestions/sec} | Gauge | Double |
+
+### vcenter.host.vsan.latency.avg
+
+The host latency while accessing vSAN storage.
+
+As measured over the most recent 5m interval.
+
+| Unit | Metric Type | Value Type |
+| ---- | ----------- | ---------- |
+| us | Gauge | Int |
+
+#### Attributes
+
+| Name | Description | Values |
+| ---- | ----------- | ------ |
+| type | The type of vSAN latency. | Str: ``read``, ``write`` |
+
+### vcenter.host.vsan.operations
+
+The vSAN IOPs of a host.
+
+As measured over the most recent 5m interval.
+
+| Unit | Metric Type | Value Type |
+| ---- | ----------- | ---------- |
+| {operations/sec} | Gauge | Int |
+
+#### Attributes
+
+| Name | Description | Values |
+| ---- | ----------- | ------ |
+| type | The type of vSAN operation. | Str: ``read``, ``write``, ``unmap`` |
+
+### vcenter.host.vsan.throughput
+
+The vSAN throughput of a host.
+
+As measured over the most recent 5m interval.
+
+| Unit | Metric Type | Value Type |
+| ---- | ----------- | ---------- |
+| By/s | Gauge | Double |
+
+#### Attributes
+
+| Name | Description | Values |
+| ---- | ----------- | ------ |
+| direction | The type of vSAN throughput. | Str: ``read``, ``write`` |
+
 ### vcenter.resource_pool.cpu.shares
 
 The amount of shares of CPU in the resource pool.
@@ -642,134 +760,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.cluster.vsan.congestions
-
-The congestions of IOs generated by all vSAN clients in the cluster.
-
-| Unit | Metric Type | Value Type |
-| ---- | ----------- | ---------- |
-| {congestions/sec} | Gauge | Double |
-
-### vcenter.cluster.vsan.latency.avg
-
-The overall cluster latency while accessing vSAN storage.
-
-| Unit | Metric Type | Value Type |
-| ---- | ----------- | ---------- |
-| us | Gauge | Int |
-
-#### Attributes
-
-| Name | Description | Values |
-| ---- | ----------- | ------ |
-| type | The type of vSAN latency. | Str: ``read``, ``write`` |
-
-### vcenter.cluster.vsan.operations
-
-The vSAN IOPs of a cluster.
-
-| Unit | Metric Type | Value Type |
-| ---- | ----------- | ---------- |
-| {operations/sec} | Gauge | Int |
-
-#### Attributes
-
-| Name | Description | Values |
-| ---- | ----------- | ------ |
-| type | The type of vSAN operation. | Str: ``read``, ``write``, ``unmap`` |
-
-### vcenter.cluster.vsan.throughput
-
-The vSAN throughput of a cluster.
-
-| Unit | Metric Type | Value Type |
-| ---- | ----------- | ---------- |
-| By/s | Gauge | Double |
-
-#### Attributes
-
-| Name | Description | Values |
-| ---- | ----------- | ------ |
-| direction | The type of vSAN throughput. | Str: ``read``, ``write`` |
-
-### vcenter.host.vsan.cache.hit_rate
-
-The host's read IOs which could be satisfied by the local client cache.
-
-As measured over the most recent 5m interval.
-
-| Unit | Metric Type | Value Type |
-| ---- | ----------- | ---------- |
-| % | Gauge | Int |
-
-### vcenter.host.vsan.congestions
-
-The congestions of IOs generated by all vSAN clients in the host.
-
-As measured over the most recent 5m interval.
-
-| Unit | Metric Type | Value Type |
-| ---- | ----------- | ---------- |
-| {congestions/sec} | Gauge | Double |
-
-### vcenter.host.vsan.latency.avg
-
-The host latency while accessing vSAN storage.
-
-As measured over the most recent 5m interval.
-
-| Unit | Metric Type | Value Type |
-| ---- | ----------- | ---------- |
-| us | Gauge | Int |
-
-#### Attributes
-
-| Name | Description | Values |
-| ---- | ----------- | ------ |
-| type | The type of vSAN latency. | Str: ``read``, ``write`` |
-
-### vcenter.host.vsan.operations
-
-The vSAN IOPs of a host.
-
-As measured over the most recent 5m interval.
-
-| Unit | Metric Type | Value Type |
-| ---- | ----------- | ---------- |
-| {operations/sec} | Gauge | Int |
-
-#### Attributes
-
-| Name | Description | Values |
-| ---- | ----------- | ------ |
-| type | The type of vSAN operation. | Str: ``read``, ``write``, ``unmap`` |
-
-### vcenter.host.vsan.throughput
-
-The vSAN throughput of a host.
-
-As measured over the most recent 5m interval.
-
-| Unit | Metric Type | Value Type |
-| ---- | ----------- | ---------- |
-| By/s | Gauge | Double |
-
-#### Attributes
-
-| Name | Description | Values |
-| ---- | ----------- | ------ |
-| direction | The type of vSAN throughput. | Str: ``read``, ``write`` |
-
 ### vcenter.vm.vsan.latency.avg
 
 The virtual machine latency while accessing vSAN storage.

diff --git a/receiver/vcenterreceiver/internal/metadata/generated_config.go b/receiver/vcenterreceiver/internal/metadata/generated_config.go