Rename k8s.node.allocatable.* metrics to k8s.node.*.allocatable (#2973)

Signed-off-by: ChrsMark <[email protected]>

Author: ChrsMark

.chloggen/fix_k8s_allocatable_updowncounters.yaml

@@ -0,0 +1,26 @@
+# Use this changelog template to create an entry for release notes.
+#
+# If your change doesn't affect end users you should instead start
+# your pull request title with [chore] or use the "Skip Changelog" label.
+
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: breaking
+
+# The name of the area of concern in the attributes-registry, (e.g. http, cloud, db)
+component: k8s
+
+# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Rename `k8s.node.allocatable.*` metrics to `k8s.node.*.allocatable`
+
+# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
+# The values here must be integers.
+issues: [2973]
+
+# (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: |
+  Renamed metrics:
+  - k8s.node.allocatable.cpu -> k8s.node.cpu.allocatable
+  - k8s.node.allocatable.memory -> k8s.node.memory.allocatable
+  - k8s.node.allocatable.ephemeral_storage -> k8s.node.ephemeral_storage.allocatable

docs/non-normative/k8s-migration.md

@@ -108,10 +108,10 @@ The changes between collector implementation and semantic conventions:
 
 | Old (Collector) ![changed](https://img.shields.io/badge/changed-orange?style=flat) | New                                                              |
 |------------------------------------------------------------------------------------|------------------------------------------------------------------|
-| `k8s.node.allocatable_cpu`                 (type: `gauge`)                         | `k8s.node.allocatable.cpu`               (type: `updowncounter`) |
-| `k8s.node.allocatable_memory`              (type: `gauge`)                         | `k8s.node.allocatable.memory`            (type: `updowncounter`) |
-| `k8s.node.allocatable_ephemeral_storage`   (type: `gauge`)                         | `k8s.node.allocatable.ephemeral_storage` (type: `updowncounter`) |
-| `k8s.node.allocatable_pods`                (type: `gauge`)                         | `k8s.node.pod.allocatable`              (type: `updowncounter`) |
+| `k8s.node.allocatable_cpu`                 (type: `gauge`)                         | `k8s.node.cpu.allocatable`               (type: `updowncounter`)            |
+| `k8s.node.allocatable_memory`              (type: `gauge`)                         | `k8s.node.memory.allocatable`            (type: `updowncounter`) |
+| `k8s.node.allocatable_ephemeral_storage`   (type: `gauge`)                         | `k8s.node.ephemeral_storage.allocatable` (type: `updowncounter`) |
+| `k8s.node.allocatable_pods`                (type: `gauge`)                         | `k8s.node.pod.allocatable`              (type: `updowncounter`)  |
 
 <!-- prettier-ignore-end -->
 

docs/system/k8s-metrics.md

@@ -44,9 +44,9 @@ and therefore inherit its attributes, like `k8s.pod.name` and `k8s.pod.uid`.
   - [Metric: `k8s.container.status.reason`](#metric-k8scontainerstatusreason)
 - [Node metrics](#node-metrics)
   - [Metric: `k8s.node.uptime`](#metric-k8snodeuptime)
-  - [Metric: `k8s.node.allocatable.cpu`](#metric-k8snodeallocatablecpu)
-  - [Metric: `k8s.node.allocatable.memory`](#metric-k8snodeallocatablememory)
-  - [Metric: `k8s.node.allocatable.ephemeral_storage`](#metric-k8snodeallocatableephemeral_storage)
+  - [Metric: `k8s.node.cpu.allocatable`](#metric-k8snodecpuallocatable)
+  - [Metric: `k8s.node.memory.allocatable`](#metric-k8snodememoryallocatable)
+  - [Metric: `k8s.node.ephemeral_storage.allocatable`](#metric-k8snodeephemeral_storageallocatable)
   - [Metric: `k8s.node.pod.allocatable`](#metric-k8snodepodallocatable)
   - [Metric: `k8s.node.condition.status`](#metric-k8snodeconditionstatus)
   - [Metric: `k8s.node.cpu.time`](#metric-k8snodecputime)
@@ -955,11 +955,11 @@ The actual accuracy would depend on the instrumentation and operating system.
 <!-- END AUTOGENERATED TEXT -->
 <!-- endsemconv -->
 
-### Metric: `k8s.node.allocatable.cpu`
+### Metric: `k8s.node.cpu.allocatable`
 
 This metric is [recommended][MetricRecommended].
 
-<!-- semconv metric.k8s.node.allocatable.cpu -->
+<!-- semconv metric.k8s.node.cpu.allocatable -->
 <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
 <!-- see templates/registry/markdown/snippet.md.j2 -->
 <!-- prettier-ignore-start -->
@@ -968,18 +968,18 @@ This metric is [recommended][MetricRecommended].
 
 | Name     | Instrument Type | Unit (UCUM) | Description    | Stability | Entity Associations |
 | -------- | --------------- | ----------- | -------------- | --------- | ------ |
-| `k8s.node.allocatable.cpu` | UpDownCounter | `{cpu}` | Amount of cpu allocatable on the node. | ![Development](https://img.shields.io/badge/-development-blue) | [`k8s.node`](/docs/registry/entities/k8s.md#k8s-node) |
+| `k8s.node.cpu.allocatable` | UpDownCounter | `{cpu}` | Amount of cpu allocatable on the node. | ![Development](https://img.shields.io/badge/-development-blue) | [`k8s.node`](/docs/registry/entities/k8s.md#k8s-node) |
 
 <!-- markdownlint-restore -->
 <!-- prettier-ignore-end -->
 <!-- END AUTOGENERATED TEXT -->
 <!-- endsemconv -->
 
-### Metric: `k8s.node.allocatable.memory`
+### Metric: `k8s.node.memory.allocatable`
 
 This metric is [recommended][MetricRecommended].
 
-<!-- semconv metric.k8s.node.allocatable.memory -->
+<!-- semconv metric.k8s.node.memory.allocatable -->
 <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
 <!-- see templates/registry/markdown/snippet.md.j2 -->
 <!-- prettier-ignore-start -->
@@ -988,18 +988,18 @@ This metric is [recommended][MetricRecommended].
 
 | Name     | Instrument Type | Unit (UCUM) | Description    | Stability | Entity Associations |
 | -------- | --------------- | ----------- | -------------- | --------- | ------ |
-| `k8s.node.allocatable.memory` | UpDownCounter | `By` | Amount of memory allocatable on the node. | ![Development](https://img.shields.io/badge/-development-blue) | [`k8s.node`](/docs/registry/entities/k8s.md#k8s-node) |
+| `k8s.node.memory.allocatable` | UpDownCounter | `By` | Amount of memory allocatable on the node. | ![Development](https://img.shields.io/badge/-development-blue) | [`k8s.node`](/docs/registry/entities/k8s.md#k8s-node) |
 
 <!-- markdownlint-restore -->
 <!-- prettier-ignore-end -->
 <!-- END AUTOGENERATED TEXT -->
 <!-- endsemconv -->
 
-### Metric: `k8s.node.allocatable.ephemeral_storage`
+### Metric: `k8s.node.ephemeral_storage.allocatable`
 
 This metric is [recommended][MetricRecommended].
 
-<!-- semconv metric.k8s.node.allocatable.ephemeral_storage -->
+<!-- semconv metric.k8s.node.ephemeral_storage.allocatable -->
 <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
 <!-- see templates/registry/markdown/snippet.md.j2 -->
 <!-- prettier-ignore-start -->
@@ -1008,7 +1008,7 @@ This metric is [recommended][MetricRecommended].
 
 | Name     | Instrument Type | Unit (UCUM) | Description    | Stability | Entity Associations |
 | -------- | --------------- | ----------- | -------------- | --------- | ------ |
-| `k8s.node.allocatable.ephemeral_storage` | UpDownCounter | `By` | Amount of ephemeral-storage allocatable on the node. | ![Development](https://img.shields.io/badge/-development-blue) | [`k8s.node`](/docs/registry/entities/k8s.md#k8s-node) |
+| `k8s.node.ephemeral_storage.allocatable` | UpDownCounter | `By` | Amount of ephemeral-storage allocatable on the node. | ![Development](https://img.shields.io/badge/-development-blue) | [`k8s.node`](/docs/registry/entities/k8s.md#k8s-node) |
 
 <!-- markdownlint-restore -->
 <!-- prettier-ignore-end -->

model/k8s/deprecated/metrics-deprecated.yaml

@@ -465,3 +465,48 @@ groups:
     entity_associations:
       - k8s.hpa
     unit: "{pod}"
+  - id: metric.k8s.node.allocatable.cpu
+    type: metric
+    metric_name: k8s.node.allocatable.cpu
+    annotations:
+      code_generation:
+        metric_value_type: double
+    stability: development
+    deprecated:
+      reason: renamed
+      renamed_to: k8s.node.cpu.allocatable
+    brief: "Deprecated, use `k8s.node.cpu.allocatable` instead."
+    entity_associations:
+      - k8s.node
+    instrument: updowncounter
+    unit: "{cpu}"
+  - id: metric.k8s.node.allocatable.ephemeral_storage
+    type: metric
+    metric_name: k8s.node.allocatable.ephemeral_storage
+    annotations:
+      code_generation:
+        metric_value_type: int
+    stability: development
+    deprecated:
+      reason: renamed
+      renamed_to: k8s.node.ephemeral_storage.allocatable
+    brief: "Deprecated, use `k8s.node.ephemeral_storage.allocatable` instead."
+    entity_associations:
+      - k8s.node
+    instrument: updowncounter
+    unit: "By"
+  - id: metric.k8s.node.allocatable.memory
+    type: metric
+    metric_name: k8s.node.allocatable.memory
+    annotations:
+      code_generation:
+        metric_value_type: int
+    stability: development
+    deprecated:
+      reason: renamed
+      renamed_to: k8s.node.memory.allocatable
+    brief: "Deprecated, use `k8s.node.memory.allocatable` instead."
+    entity_associations:
+      - k8s.node
+    instrument: updowncounter
+    unit: "By"

model/k8s/metrics.yaml

@@ -458,10 +458,10 @@ groups:
     unit: "s"
     entity_associations:
       - k8s.node
-  # k8s.node.allocatable.* metrics
-  - id: metric.k8s.node.allocatable.cpu
+  # k8s.node.*.allocatable metrics
+  - id: metric.k8s.node.cpu.allocatable
     type: metric
-    metric_name: k8s.node.allocatable.cpu
+    metric_name: k8s.node.cpu.allocatable
     annotations:
       code_generation:
         metric_value_type: double
@@ -471,9 +471,9 @@ groups:
       - k8s.node
     instrument: updowncounter
     unit: "{cpu}"
-  - id: metric.k8s.node.allocatable.ephemeral_storage
+  - id: metric.k8s.node.ephemeral_storage.allocatable
     type: metric
-    metric_name: k8s.node.allocatable.ephemeral_storage
+    metric_name: k8s.node.ephemeral_storage.allocatable
     annotations:
       code_generation:
         metric_value_type: int
@@ -483,9 +483,9 @@ groups:
       - k8s.node
     instrument: updowncounter
     unit: "By"
-  - id: metric.k8s.node.allocatable.memory
+  - id: metric.k8s.node.memory.allocatable
     type: metric
-    metric_name: k8s.node.allocatable.memory
+    metric_name: k8s.node.memory.allocatable
     annotations:
       code_generation:
         metric_value_type: int