exclude max int-valued metrics

open-telemetry · May 21, 2024 · c527c4b · c527c4b
1 parent 66a9965
commit c527c4b
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/docs/runtime/go-metrics.md b/docs/runtime/go-metrics.md
@@ -84,9 +84,9 @@ This metric is [recommended][MetricRecommended].
 <!-- semconv metric.go.memory.limit(metric_table) -->
 | Name     | Instrument Type | Unit (UCUM) | Description    | Stability |
 | -------- | --------------- | ----------- | -------------- | --------- |
-| `go.memory.limit` | UpDownCounter | `By` | Go runtime memory limit configured by the user, otherwise math.MaxInt64. [1] | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `go.memory.limit` | UpDownCounter | `By` | Go runtime memory limit configured by the user, if a limit exists. [1] | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 
-**[1]:** Computed from `/gc/gomemlimit:bytes`.
+**[1]:** Computed from `/gc/gomemlimit:bytes`. This metric is excluded if the limit obtained from the Go runtime is math.MaxInt64.
 <!-- endsemconv -->
 
 <!-- semconv metric.go.memory.limit(full) -->

diff --git a/model/metrics/go-metrics.yaml b/model/metrics/go-metrics.yaml
@@ -42,9 +42,10 @@ groups:
   - id: metric.go.memory.limit
     type: metric
     metric_name: go.memory.limit
-    brief: "Go runtime memory limit configured by the user, otherwise math.MaxInt64."
+    brief: "Go runtime memory limit configured by the user, if a limit exists."
     note: >
       Computed from `/gc/gomemlimit:bytes`.
+      This metric is excluded if the limit obtained from the Go runtime is math.MaxInt64.
     instrument: updowncounter
     unit: "By"
     stability: experimental