add go attributes to the attributes registry

open-telemetry · May 21, 2024 · a708352 · a708352
1 parent 32e4ebe
commit a708352
Show file tree

Hide file tree

Showing 7 changed files with 52 additions and 17 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml
@@ -43,6 +43,7 @@ body:
         - area:file
         - area:gcp
         - area:gen-ai
+        - area:go
         - area:graphql
         - area:heroku
         - area:host

diff --git a/.github/ISSUE_TEMPLATE/change_proposal.yaml b/.github/ISSUE_TEMPLATE/change_proposal.yaml
@@ -36,6 +36,7 @@ body:
         - area:file
         - area:gcp
         - area:gen-ai
+        - area:go
         - area:graphql
         - area:heroku
         - area:host

diff --git a/.github/ISSUE_TEMPLATE/new-conventions.yaml b/.github/ISSUE_TEMPLATE/new-conventions.yaml
@@ -45,6 +45,7 @@ body:
         - area:file
         - area:gcp
         - area:gen-ai
+        - area:go
         - area:graphql
         - area:heroku
         - area:host

diff --git a/docs/attributes-registry/README.md b/docs/attributes-registry/README.md
@@ -55,6 +55,7 @@ Currently, the following namespaces exist:
 - [File](file.md)
 - [GCP](gcp.md)
 - [Gen AI](gen-ai.md)
+- [Go](go.md)
 - [GraphQL](graphql.md)
 - [Heroku](heroku.md)
 - [Host](host.md)

diff --git a/docs/attributes-registry/go.md b/docs/attributes-registry/go.md
@@ -0,0 +1,22 @@
+<!--- Hugo front matter used to generate the website version of this page:
+--->
+
+<!-- NOTE: THIS FILE IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
+<!-- see templates/registry/markdown/attribute_namespace.md.j2 -->
+
+# Go
+
+## Go Attributes
+
+This document defines Go related attributes.
+
+| Attribute        | Type   | Description         | Examples         | Stability                                                        |
+| ---------------- | ------ | ------------------- | ---------------- | ---------------------------------------------------------------- |
+| `go.memory.type` | string | The type of memory. | `stack`; `other` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+
+`go.memory.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
+
+| Value   | Description                                                                                             | Stability                                                        |
+| ------- | ------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- |
+| `stack` | Memory allocated from the heap that is reserved for stack space, whether or not it is currently in-use. | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `other` | Memory used by the Go runtime, excluding other categories of memory usage.                              | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
diff --git a/model/metrics/go-metrics.yaml b/model/metrics/go-metrics.yaml
@@ -9,24 +9,8 @@ groups:
     prefix: go.memory
     unit: "By"
     attributes:
-      - id: type
-        stability: experimental
-        type:
-          allow_custom_values: false
-          members:
-            - id: stack
-              value: 'stack'
-              brief: 'Memory allocated from the heap that is reserved for stack space, whether or not it is currently in-use.'
-              note: >
-                Computed from `/memory/classes/heap/stacks:bytes`.
-              stability: experimental
-            - id: other
-              value: 'other'
-              brief: 'Memory used by the Go runtime, excluding other categories of memory usage.'
-              stability: experimental
+      - ref: go.memory.type
         requirement_level: recommended
-        brief: The type of memory.
-        examples: ["other", "stack"]
     stability: experimental
 
   - id: metric.go.memory.released

diff --git a/model/registry/go.yaml b/model/registry/go.yaml
@@ -0,0 +1,25 @@
+groups:
+  - id: registry.go
+    type: attribute_group
+    prefix: go
+    brief: >
+      This document defines Go related attributes.
+    attributes:
+      - id: memory.type
+        stability: experimental
+        type:
+          allow_custom_values: false
+          members:
+            - id: stack
+              value: 'stack'
+              brief: 'Memory allocated from the heap that is reserved for stack space, whether or not it is currently in-use.'
+              note: >
+                Computed from `/memory/classes/heap/stacks:bytes`.
+              stability: experimental
+            - id: other
+              value: 'other'
+              brief: 'Memory used by the Go runtime, excluding other categories of memory usage.'
+              stability: experimental
+        requirement_level: recommended
+        brief: The type of memory.
+        examples: ["other", "stack"]