Apply latest naming suggestions

open-telemetry · Aug 5, 2024 · f8866a1 · f8866a1
1 parent 90a9356
commit f8866a1
Show file tree

Hide file tree

Showing 2 changed files with 52 additions and 52 deletions.
diff --git a/docs/runtime/dotnet-metrics.md b/docs/runtime/dotnet-metrics.md
@@ -14,11 +14,11 @@ This document describes semantic conventions for .NET CLR runtime metrics in Ope
 
 - [CLR Garbage Collection](#clr-garbage-collection)
   - [Metric: `dotnet.gc.collections`](#metric-dotnetgccollections)
-  - [Metric: `dotnet.gc.objects.size`](#metric-dotnetgcobjectssize)
-  - [Metric: `dotnet.gc.memory.total_allocated`](#metric-dotnetgcmemorytotal_allocated)
-  - [Metric: `dotnet.gc.memory.committed`](#metric-dotnetgcmemorycommitted)
-  - [Metric: `dotnet.gc.heap.size`](#metric-dotnetgcheapsize)
-  - [Metric: `dotnet.gc.heap.fragmentation`](#metric-dotnetgcheapfragmentation)
+  - [Metric: `dotnet.process.memory.working_set`](#metric-dotnetprocessmemoryworking_set)
+  - [Metric: `dotnet.gc.heap.total_allocated`](#metric-dotnetgcheaptotal_allocated)
+  - [Metric: `dotnet.gc.last_collection.memory.committed_size`](#metric-dotnetgclast_collectionmemorycommitted_size)
+  - [Metric: `dotnet.gc.last_collection.heap.size`](#metric-dotnetgclast_collectionheapsize)
+  - [Metric: `dotnet.gc.last_collection.heap.fragmentation.size`](#metric-dotnetgclast_collectionheapfragmentationsize)
   - [Metric: `dotnet.gc.pause.time`](#metric-dotnetgcpausetime)
 - [Just-In-Time (JIT) Compiler](#just-in-time-jit-compiler)
   - [Metric: `dotnet.jit.compiled_il.size`](#metric-dotnetjitcompiled_ilsize)
@@ -29,8 +29,8 @@ This document describes semantic conventions for .NET CLR runtime metrics in Ope
   - [Metric: `dotnet.thread_pool.work_item.count`](#metric-dotnetthread_poolwork_itemcount)
   - [Metric: `dotnet.thread_pool.queue.length`](#metric-dotnetthread_poolqueuelength)
 - [CPU](#cpu)
-  - [Metric: `dotnet.cpu.count`](#metric-dotnetcpucount)
-  - [Metric: `dotnet.cpu.time`](#metric-dotnetcputime)
+  - [Metric: `dotnet.process.cpu.count`](#metric-dotnetprocesscpucount)
+  - [Metric: `dotnet.process.cpu.time`](#metric-dotnetprocesscputime)
 - [General](#general)
   - [Metric: `dotnet.monitor.lock_contentions`](#metric-dotnetmonitorlock_contentions)
   - [Metric: `dotnet.timer.count`](#metric-dotnettimercount)
@@ -98,11 +98,11 @@ This metric is [recommended][MetricRecommended].
 <!-- END AUTOGENERATED TEXT -->
 <!-- endsemconv -->
 
-### Metric: `dotnet.gc.objects.size`
+### Metric: `dotnet.process.memory.working_set`
 
 This metric is [recommended][MetricRecommended].
 
-<!-- semconv metric.dotnet.gc.objects.size(metric_table) -->
+<!-- semconv metric.dotnet.process.memory.working_set(metric_table) -->
 <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
 <!-- see templates/registry/markdown/snippet.md.j2 -->
 <!-- prettier-ignore-start -->
@@ -111,10 +111,10 @@ This metric is [recommended][MetricRecommended].
 
 | Name     | Instrument Type | Unit (UCUM) | Description    | Stability |
 | -------- | --------------- | ----------- | -------------- | --------- |
-| `dotnet.gc.objects.size` | UpDownCounter | `By` | The number of bytes currently allocated on the managed GC heap. Fragmentation and other GC committed memory pools are excluded. [1] | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `dotnet.process.memory.working_set` | UpDownCounter | `By` | The number of bytes of physical memory mapped to the process context. [1] | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 
 
-**[1]:** This metric reports the same values as calling [`GC.GetTotalMemory(false)`](https://learn.microsoft.com/dotnet/api/system.gc.gettotalmemory).
+**[1]:** This metric reports the same values as calling [`Environment.WorkingSet`](https://learn.microsoft.com/dotnet/api/system.environment.workingset).
 
 
 
@@ -123,7 +123,7 @@ This metric is [recommended][MetricRecommended].
 <!-- END AUTOGENERATED TEXT -->
 <!-- endsemconv -->
 
-<!-- semconv metric.dotnet.gc.objects.size(full) -->
+<!-- semconv metric.dotnet.process.memory.working_set(full) -->
 <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
 <!-- see templates/registry/markdown/snippet.md.j2 -->
 <!-- prettier-ignore-start -->
@@ -136,11 +136,11 @@ This metric is [recommended][MetricRecommended].
 <!-- END AUTOGENERATED TEXT -->
 <!-- endsemconv -->
 
-### Metric: `dotnet.gc.memory.total_allocated`
+### Metric: `dotnet.gc.heap.total_allocated`
 
 This metric is [recommended][MetricRecommended].
 
-<!-- semconv metric.dotnet.gc.memory.total_allocated(metric_table) -->
+<!-- semconv metric.dotnet.gc.heap.total_allocated(metric_table) -->
 <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
 <!-- see templates/registry/markdown/snippet.md.j2 -->
 <!-- prettier-ignore-start -->
@@ -149,7 +149,7 @@ This metric is [recommended][MetricRecommended].
 
 | Name     | Instrument Type | Unit (UCUM) | Description    | Stability |
 | -------- | --------------- | ----------- | -------------- | --------- |
-| `dotnet.gc.memory.total_allocated` | Counter | `By` | The approximate number of bytes allocated on the managed GC heap since the process has started. The returned value does not include any native allocations. [1] | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `dotnet.gc.heap.total_allocated` | Counter | `By` | The approximate number of bytes allocated on the managed GC heap since the process has started. The returned value does not include any native allocations. [1] | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 
 
 **[1]:** This metric reports the same values as calling [`GC.GetTotalAllocatedBytes()`](https://learn.microsoft.com/dotnet/api/system.gc.gettotalallocatedbytes).
@@ -161,7 +161,7 @@ This metric is [recommended][MetricRecommended].
 <!-- END AUTOGENERATED TEXT -->
 <!-- endsemconv -->
 
-<!-- semconv metric.dotnet.gc.memory.total_allocated(full) -->
+<!-- semconv metric.dotnet.gc.heap.total_allocated(full) -->
 <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
 <!-- see templates/registry/markdown/snippet.md.j2 -->
 <!-- prettier-ignore-start -->
@@ -174,11 +174,11 @@ This metric is [recommended][MetricRecommended].
 <!-- END AUTOGENERATED TEXT -->
 <!-- endsemconv -->
 
-### Metric: `dotnet.gc.memory.committed`
+### Metric: `dotnet.gc.last_collection.memory.committed_size`
 
 This metric is [recommended][MetricRecommended].
 
-<!-- semconv metric.dotnet.gc.memory.committed(metric_table) -->
+<!-- semconv metric.dotnet.gc.last_collection.memory.committed_size(metric_table) -->
 <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
 <!-- see templates/registry/markdown/snippet.md.j2 -->
 <!-- prettier-ignore-start -->
@@ -187,7 +187,7 @@ This metric is [recommended][MetricRecommended].
 
 | Name     | Instrument Type | Unit (UCUM) | Description    | Stability |
 | -------- | --------------- | ----------- | -------------- | --------- |
-| `dotnet.gc.memory.committed` | UpDownCounter | `By` | The amount of committed virtual memory in use by the .NET GC, as observed during the latest garbage collection. [1] | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `dotnet.gc.last_collection.memory.committed_size` | UpDownCounter | `By` | The amount of committed virtual memory in use by the .NET GC, as observed during the latest garbage collection. [1] | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 
 
 **[1]:** This metric reports the same values as calling [`GC.GetGCMemoryInfo().TotalCommittedBytes`](https://learn.microsoft.com/dotnet/api/system.gcmemoryinfo.totalcommittedbytes). Committed virtual memory may be larger than the heap size because it includes both memory for storing existing objects (the heap size) and some extra memory that is ready to handle newly allocated objects in the future.
@@ -199,7 +199,7 @@ This metric is [recommended][MetricRecommended].
 <!-- END AUTOGENERATED TEXT -->
 <!-- endsemconv -->
 
-<!-- semconv metric.dotnet.gc.memory.committed(full) -->
+<!-- semconv metric.dotnet.gc.last_collection.memory.committed_size(full) -->
 <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
 <!-- see templates/registry/markdown/snippet.md.j2 -->
 <!-- prettier-ignore-start -->
@@ -212,11 +212,11 @@ This metric is [recommended][MetricRecommended].
 <!-- END AUTOGENERATED TEXT -->
 <!-- endsemconv -->
 
-### Metric: `dotnet.gc.heap.size`
+### Metric: `dotnet.gc.last_collection.heap.size`
 
 This metric is [recommended][MetricRecommended].
 
-<!-- semconv metric.dotnet.gc.heap.size(metric_table) -->
+<!-- semconv metric.dotnet.gc.last_collection.heap.size(metric_table) -->
 <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
 <!-- see templates/registry/markdown/snippet.md.j2 -->
 <!-- prettier-ignore-start -->
@@ -225,7 +225,7 @@ This metric is [recommended][MetricRecommended].
 
 | Name     | Instrument Type | Unit (UCUM) | Description    | Stability |
 | -------- | --------------- | ----------- | -------------- | --------- |
-| `dotnet.gc.heap.size` | UpDownCounter | `By` | The managed GC heap size (including fragmentation), as observed during the latest garbage collection. [1] | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `dotnet.gc.last_collection.heap.size` | UpDownCounter | `By` | The managed GC heap size (including fragmentation), as observed during the latest garbage collection. [1] | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 
 
 **[1]:** This metric reports the same values as calling [`GC.GetGCMemoryInfo().GenerationInfo.SizeAfterBytes`](https://learn.microsoft.com/dotnet/api/system.gcgenerationinfo.sizeafterbytes).
@@ -237,7 +237,7 @@ This metric is [recommended][MetricRecommended].
 <!-- END AUTOGENERATED TEXT -->
 <!-- endsemconv -->
 
-<!-- semconv metric.dotnet.gc.heap.size(full) -->
+<!-- semconv metric.dotnet.gc.last_collection.heap.size(full) -->
 <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
 <!-- see templates/registry/markdown/snippet.md.j2 -->
 <!-- prettier-ignore-start -->
@@ -265,11 +265,11 @@ This metric is [recommended][MetricRecommended].
 <!-- END AUTOGENERATED TEXT -->
 <!-- endsemconv -->
 
-### Metric: `dotnet.gc.heap.fragmentation`
+### Metric: `dotnet.gc.last_collection.heap.fragmentation.size`
 
 This metric is [recommended][MetricRecommended].
 
-<!-- semconv metric.dotnet.gc.heap.fragmentation(metric_table) -->
+<!-- semconv metric.dotnet.gc.last_collection.heap.fragmentation.size(metric_table) -->
 <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
 <!-- see templates/registry/markdown/snippet.md.j2 -->
 <!-- prettier-ignore-start -->
@@ -278,7 +278,7 @@ This metric is [recommended][MetricRecommended].
 
 | Name     | Instrument Type | Unit (UCUM) | Description    | Stability |
 | -------- | --------------- | ----------- | -------------- | --------- |
-| `dotnet.gc.heap.fragmentation` | UpDownCounter | `By` | The heap fragmentation, as observed during the latest garbage collection. [1] | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `dotnet.gc.last_collection.heap.fragmentation.size` | UpDownCounter | `By` | The heap fragmentation, as observed during the latest garbage collection. [1] | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 
 
 **[1]:** This metric reports the same values as calling [`GC.GetGCMemoryInfo().GenerationInfo.FragmentationAfterBytes`](https://learn.microsoft.com/dotnet/api/system.gcgenerationinfo.fragmentationafterbytes).
@@ -290,7 +290,7 @@ This metric is [recommended][MetricRecommended].
 <!-- END AUTOGENERATED TEXT -->
 <!-- endsemconv -->
 
-<!-- semconv metric.dotnet.gc.heap.fragmentation(full) -->
+<!-- semconv metric.dotnet.gc.last_collection.heap.fragmentation.size(full) -->
 <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
 <!-- see templates/registry/markdown/snippet.md.j2 -->
 <!-- prettier-ignore-start -->
@@ -605,11 +605,11 @@ This metric is [recommended][MetricRecommended].
 _Note: These metrics represent CPU information from the perspective of the .NET process and may differ from
 CPU metrics measured from outside the process (e.g. `system.cpu.*`)._
 
-### Metric: `dotnet.cpu.count`
+### Metric: `dotnet.process.cpu.count`
 
 This metric is [recommended][MetricRecommended].
 
-<!-- semconv metric.dotnet.cpu.count(metric_table) -->
+<!-- semconv metric.dotnet.process.cpu.count(metric_table) -->
 <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
 <!-- see templates/registry/markdown/snippet.md.j2 -->
 <!-- prettier-ignore-start -->
@@ -618,7 +618,7 @@ This metric is [recommended][MetricRecommended].
 
 | Name     | Instrument Type | Unit (UCUM) | Description    | Stability |
 | -------- | --------------- | ----------- | -------------- | --------- |
-| `dotnet.cpu.count` | UpDownCounter | `{cpu}` | The number of processors available to the process. [1] | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `dotnet.process.cpu.count` | UpDownCounter | `{cpu}` | The number of processors available to the process. [1] | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 
 
 **[1]:** This metric reports the same values as accessing [`Environment.ProcessorCount`](https://learn.microsoft.com/dotnet/api/system.environment.processorcount).
@@ -630,7 +630,7 @@ This metric is [recommended][MetricRecommended].
 <!-- END AUTOGENERATED TEXT -->
 <!-- endsemconv -->
 
-<!-- semconv metric.dotnet.cpu.count(full) -->
+<!-- semconv metric.dotnet.process.cpu.count(full) -->
 <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
 <!-- see templates/registry/markdown/snippet.md.j2 -->
 <!-- prettier-ignore-start -->
@@ -643,11 +643,11 @@ This metric is [recommended][MetricRecommended].
 <!-- END AUTOGENERATED TEXT -->
 <!-- endsemconv -->
 
-### Metric: `dotnet.cpu.time`
+### Metric: `dotnet.process.cpu.time`
 
 This metric is [recommended][MetricRecommended].
 
-<!-- semconv metric.dotnet.cpu.time(metric_table) -->
+<!-- semconv metric.dotnet.process.cpu.time(metric_table) -->
 <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
 <!-- see templates/registry/markdown/snippet.md.j2 -->
 <!-- prettier-ignore-start -->
@@ -656,7 +656,7 @@ This metric is [recommended][MetricRecommended].
 
 | Name     | Instrument Type | Unit (UCUM) | Description    | Stability |
 | -------- | --------------- | ----------- | -------------- | --------- |
-| `dotnet.cpu.time` | Counter | `s` | CPU time used by the process as reported by the CLR. [1] | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `dotnet.process.cpu.time` | Counter | `s` | CPU time used by the process as reported by the CLR. [1] | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 
 
 **[1]:** This metric reports the same values as accessing the corresponding processor time properties on [`System.Diagnostics.Process`](https://learn.microsoft.com/dotnet/api/system.diagnostics.process)."
@@ -668,7 +668,7 @@ This metric is [recommended][MetricRecommended].
 <!-- END AUTOGENERATED TEXT -->
 <!-- endsemconv -->
 
-<!-- semconv metric.dotnet.cpu.time(full) -->
+<!-- semconv metric.dotnet.process.cpu.time(full) -->
 <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
 <!-- see templates/registry/markdown/snippet.md.j2 -->
 <!-- prettier-ignore-start -->

diff --git a/model/metrics/dotnet-metrics.yaml b/model/metrics/dotnet-metrics.yaml
@@ -11,18 +11,18 @@ groups:
       - ref: dotnet.gc.heap.generation
         requirement_level: required
 
-  - id: metric.dotnet.gc.objects.size
+  - id: metric.dotnet.process.memory.working_set
     type: metric
-    metric_name: dotnet.gc.objects.size
-    brief: "The number of bytes currently allocated on the managed GC heap. Fragmentation and other GC committed memory pools are excluded."
-    note: "This metric reports the same values as calling [`GC.GetTotalMemory(false)`](https://learn.microsoft.com/dotnet/api/system.gc.gettotalmemory)."
+    metric_name: dotnet.process.memory.working_set
+    brief: "The number of bytes of physical memory mapped to the process context."
+    note: "This metric reports the same values as calling [`Environment.WorkingSet`](https://learn.microsoft.com/dotnet/api/system.environment.workingset)."
     instrument: updowncounter
     unit: "By"
     stability: experimental
 
-  - id: metric.dotnet.gc.memory.total_allocated
+  - id: metric.dotnet.gc.heap.total_allocated
     type: metric
-    metric_name: dotnet.gc.memory.total_allocated
+    metric_name: dotnet.gc.heap.total_allocated
     brief: >
       The approximate number of bytes allocated on the managed GC heap since the process has
       started. The returned value does not include any native allocations.
@@ -31,9 +31,9 @@ groups:
     unit: "By"
     stability: experimental
 
-  - id: metric.dotnet.gc.memory.committed
+  - id: metric.dotnet.gc.last_collection.memory.committed_size
     type: metric
-    metric_name: dotnet.gc.memory.committed
+    metric_name: dotnet.gc.last_collection.memory.committed_size
     brief: >
       The amount of committed virtual memory in use by the .NET GC, as
       observed during the latest garbage collection.
@@ -48,9 +48,9 @@ groups:
     unit: "By"
     stability: experimental
 
-  - id: metric.dotnet.gc.heap.size
+  - id: metric.dotnet.gc.last_collection.heap.size
     type: metric
-    metric_name: dotnet.gc.heap.size
+    metric_name: dotnet.gc.last_collection.heap.size
     brief: >
       The managed GC heap size (including fragmentation), as observed during the
       latest garbage collection.
@@ -62,9 +62,9 @@ groups:
       - ref: dotnet.gc.heap.generation
         requirement_level: required
 
-  - id: metric.dotnet.gc.heap.fragmentation
+  - id: metric.dotnet.gc.last_collection.heap.fragmentation.size
     type: metric
-    metric_name: dotnet.gc.heap.fragmentation
+    metric_name: dotnet.gc.last_collection.heap.fragmentation.size
     brief: >
       The heap fragmentation, as observed during the latest garbage collection.
     note: >
@@ -189,18 +189,18 @@ groups:
       - ref: error.type
         requirement_level: required
 
-  - id: metric.dotnet.cpu.count
+  - id: metric.dotnet.process.cpu.count
     type: metric
-    metric_name: dotnet.cpu.count
+    metric_name: dotnet.process.cpu.count
     brief: "The number of processors available to the process."
     note: "This metric reports the same values as accessing [`Environment.ProcessorCount`](https://learn.microsoft.com/dotnet/api/system.environment.processorcount)."
     instrument: updowncounter
     unit: "{cpu}"
     stability: experimental
 
-  - id: metric.dotnet.cpu.time
+  - id: metric.dotnet.process.cpu.time
     type: metric
-    metric_name: dotnet.cpu.time
+    metric_name: dotnet.process.cpu.time
     brief: "CPU time used by the process as reported by the CLR."
     note: >
       This metric reports the same values as accessing the corresponding