improve description

Signed-off-by: ChrsMark <[email protected]>
open-telemetry · Oct 31, 2024 · cccecf1 · cccecf1
1 parent 1b9ea2e
commit cccecf1
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 12 deletions.
diff --git a/docs/system/k8s-metrics.md b/docs/system/k8s-metrics.md
@@ -94,7 +94,7 @@ This metric is [recommended][MetricRecommended].
 
 | Name     | Instrument Type | Unit (UCUM) | Description    | Stability |
 | -------- | --------------- | ----------- | -------------- | --------- |
-| `k8s.pod.network.io` | Counter | `By` | Pod network IO | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `k8s.pod.network.io` | Counter | `By` | Network bytes for the Pod | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 
 | Attribute  | Type | Description  | Examples  | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
 |---|---|---|---|---|---|
@@ -108,8 +108,6 @@ This metric is [recommended][MetricRecommended].
 | `receive` | receive | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 | `transmit` | transmit | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 
-
-
 <!-- markdownlint-restore -->
 <!-- prettier-ignore-end -->
 <!-- END AUTOGENERATED TEXT -->
@@ -142,8 +140,6 @@ This metric is [recommended][MetricRecommended].
 | `receive` | receive | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 | `transmit` | transmit | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 
-
-
 <!-- markdownlint-restore -->
 <!-- prettier-ignore-end -->
 <!-- END AUTOGENERATED TEXT -->
@@ -228,7 +224,7 @@ This metric is [recommended][MetricRecommended].
 
 | Name     | Instrument Type | Unit (UCUM) | Description    | Stability |
 | -------- | --------------- | ----------- | -------------- | --------- |
-| `k8s.node.network.io` | Counter | `By` | Node network IO | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `k8s.node.network.io` | Counter | `By` | Network bytes for the Node | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 
 | Attribute  | Type | Description  | Examples  | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
 |---|---|---|---|---|---|
@@ -242,8 +238,6 @@ This metric is [recommended][MetricRecommended].
 | `receive` | receive | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 | `transmit` | transmit | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 
-
-
 <!-- markdownlint-restore -->
 <!-- prettier-ignore-end -->
 <!-- END AUTOGENERATED TEXT -->
@@ -276,8 +270,6 @@ This metric is [recommended][MetricRecommended].
 | `receive` | receive | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 | `transmit` | transmit | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 
-
-
 <!-- markdownlint-restore -->
 <!-- prettier-ignore-end -->
 <!-- END AUTOGENERATED TEXT -->

diff --git a/model/k8s/metrics.yaml b/model/k8s/metrics.yaml
@@ -35,7 +35,7 @@ groups:
     type: metric
     metric_name: k8s.pod.network.io
     stability: experimental
-    brief: "Pod network IO"
+    brief: "Network bytes for the Pod"
     instrument: counter
     unit: "By"
     attributes:
@@ -88,7 +88,7 @@ groups:
     type: metric
     metric_name: k8s.node.network.io
     stability: experimental
-    brief: "Node network IO"
+    brief: "Network bytes for the Node"
     instrument: counter
     unit: "By"
     attributes: