Update dotnet attribute registry

- Remove exception.type - Rename gc.generation -> gc.heap.generation - Switch type for gc.heap.generation to an enumeration
open-telemetry · Aug 5, 2024 · 72c1657 · 72c1657
1 parent d08792a
commit 72c1657
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 12 deletions.
diff --git a/docs/attributes-registry/dotnet.md b/docs/attributes-registry/dotnet.md
@@ -10,7 +10,16 @@
 
 This document defines .NET Common Language Runtime (CLR) related attributes.
 
-| Attribute               | Type   | Description                                    | Examples                                                                     | Stability                                                        |
-| ----------------------- | ------ | ---------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------- |
-| `dotnet.exception.type` | string | The .NET type name of an exception.            | `ArgumentNullException`; `IndexOutOfRangeException`; `NotSupportedException` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
-| `dotnet.gc.generation`  | string | Name of the garbage collector heap generation. | `gen0`; `gen1`; `gen2`; `loh`; `poh`                                         | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| Attribute                   | Type   | Description                                            | Examples               | Stability                                                        |
+| --------------------------- | ------ | ------------------------------------------------------ | ---------------------- | ---------------------------------------------------------------- |
+| `dotnet.gc.heap.generation` | string | Name of the garbage collector managed heap generation. | `gen0`; `gen1`; `gen2` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+
+`dotnet.gc.heap.generation` 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                                                        |
+| ------ | ------------------ | ---------------------------------------------------------------- |
+| `gen0` | Generation 0       | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `gen1` | Generation 1       | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `gen2` | Generation 2       | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `loh`  | Large Object Heap  | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `poh`  | Pinned Object Heap | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
diff --git a/model/registry/dotnet.yaml b/model/registry/dotnet.yaml
@@ -5,13 +5,24 @@ groups:
     brief: >
       This document defines .NET Common Language Runtime (CLR) related attributes.
     attributes:
-      - id: gc.generation
+      - id: gc.heap.generation
         stability: experimental
-        type: string
-        brief: Name of the garbage collector heap generation.
+        type:
+          members:
+            - id: gen0
+              value: 'gen0'
+              stability: experimental
+            - id: gen1
+              value: 'gen1'
+              stability: experimental
+            - id: gen2
+              value: 'gen2'
+              stability: experimental
+            - id: loh
+              value: 'loh'
+              stability: experimental
+            - id: poh
+              value: 'poh'
+              stability: experimental
+        brief: Name of the garbage collector managed heap generation.
         examples: ["gen0", "gen1", "gen2", "loh", "poh"]
-      - id: exception.type
-        stability: experimental
-        type: string
-        brief: The .NET type name of an exception.
-        examples: ["ArgumentNullException", "IndexOutOfRangeException", "NotSupportedException"]