diff --git a/docs/runtime/go-metrics.md b/docs/runtime/go-metrics.md index bcb3f5b678..8401bf0277 100644 --- a/docs/runtime/go-metrics.md +++ b/docs/runtime/go-metrics.md @@ -84,9 +84,9 @@ This metric is [recommended][MetricRecommended]. | 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. diff --git a/model/metrics/go-metrics.yaml b/model/metrics/go-metrics.yaml index 17e93384cd..6f30f762d7 100644 --- 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