Update based on PR feedback

open-telemetry · lmolkova · Aug 23, 2024 · May 14, 2024 · May 14, 2024 · May 14, 2024
commit f1dd3dd8a3f0e84e9137994fb14ec3439d17aa5e
diff --git a/docs/runtime/clr-metrics.md b/docs/runtime/clr-metrics.md
@@ -19,11 +19,11 @@ This document describes semantic conventions for .NET CLR runtime metrics in Ope
   - [Metric: `clr.gc.committed_memory.size`](#metric-clrgccommitted_memorysize)
   - [Metric: `clr.gc.heap.size`](#metric-clrgcheapsize)
   - [Metric: `clr.gc.heap.fragmentation.size`](#metric-clrgcheapfragmentationsize)
-  - [Metric: `clr.gc.duration`](#metric-clrgcduration)
+  - [Metric: `clr.gc.pause.time`](#metric-clrgcpausetime)
 - [Just-In-Time (JIT) Compiler](#just-in-time-jit-compiler)
   - [Metric: `clr.jit.il_compiled.size`](#metric-clrjitil_compiledsize)
   - [Metric: `clr.jit.methods_compiled.count`](#metric-clrjitmethods_compiledcount)
-  - [Metric: `clr.jit.compilation_time`](#metric-clrjitcompilation_time)
+  - [Metric: `clr.jit.compilation.time`](#metric-clrjitcompilationtime)
 - [Thread pool](#thread-pool)
   - [Metric: `clr.thread_pool.threads.count`](#metric-clrthread_poolthreadscount)
   - [Metric: `clr.thread_pool.work_items.count`](#metric-clrthread_poolwork_itemscount)
@@ -45,7 +45,6 @@ This document describes semantic conventions for .NET CLR runtime metrics in Ope
 ### Metric: `clr.gc.collections.count`
 
 This metric is [recommended][MetricRecommended].
-This metric is obtained from [`GC.CollectionCount(int generation)`](https://learn.microsoft.com/en-us/dotnet/api/system.gc.collectioncount).
 
 <!-- semconv metric.clr.gc.collections.count(metric_table) -->
 <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
@@ -56,7 +55,7 @@ This metric is obtained from [`GC.CollectionCount(int generation)`](https://lear
 
 | Name     | Instrument Type | Unit (UCUM) | Description    | Stability |
 | -------- | --------------- | ----------- | -------------- | --------- |
-| `clr.gc.collections.count` | Counter | `{collection}` | Number of garbage collections that have occurred since the process started. | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `clr.gc.collections.count` | Counter | `{collection}` | Number of garbage collections that have occurred since the process has started. | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 
 
 <!-- markdownlint-restore -->
@@ -84,7 +83,6 @@ This metric is obtained from [`GC.CollectionCount(int generation)`](https://lear
 ### Metric: `clr.gc.objects.size`
 
 This metric is [recommended][MetricRecommended].
-This metric is obtained from [`GC.GetTotalMemory(false)`](https://learn.microsoft.com/en-us/dotnet/api/system.gc.gettotalmemory).
 
 <!-- semconv metric.clr.gc.objects.size(metric_table) -->
 <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
@@ -119,7 +117,6 @@ This metric is obtained from [`GC.GetTotalMemory(false)`](https://learn.microsof
 ### Metric: `clr.gc.allocations.size`
 
 This metric is [recommended][MetricRecommended].
-This metric is obtained from [`GC.GetTotalAllocatedBytes()`](https://learn.microsoft.com/en-us/dotnet/api/system.gc.gettotalallocatedbytes).
 
 <!-- semconv metric.clr.gc.allocations.size(metric_table) -->
 <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
@@ -130,7 +127,7 @@ This metric is obtained from [`GC.GetTotalAllocatedBytes()`](https://learn.micro
 
 | Name     | Instrument Type | Unit (UCUM) | Description    | Stability |
 | -------- | --------------- | ----------- | -------------- | --------- |
-| `clr.gc.allocations.size` | Counter | `By` | The number of bytes allocated on the managed GC heap since the process started. The returned value does not include any native allocations. | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `clr.gc.allocations.size` | Counter | `By` | The number of bytes allocated on the managed GC heap since the process has started. The returned value does not include any native allocations. | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 
 
 <!-- markdownlint-restore -->
@@ -154,7 +151,6 @@ This metric is obtained from [`GC.GetTotalAllocatedBytes()`](https://learn.micro
 ### Metric: `clr.gc.committed_memory.size`
 
 This metric is [recommended][MetricRecommended].
-This metric is obtained from [`GC.GetGCMemoryInfo().TotalCommittedBytes`](https://learn.microsoft.com/en-us/dotnet/api/system.gcmemoryinfo.totalcommittedbytes).
 
 <!-- semconv metric.clr.gc.committed_memory.size(metric_table) -->
 <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
@@ -193,7 +189,6 @@ This metric is obtained from [`GC.GetGCMemoryInfo().TotalCommittedBytes`](https:
 ### Metric: `clr.gc.heap.size`
 
 This metric is [recommended][MetricRecommended].
-This metric is obtained from [`GC.GetGCMemoryInfo().GenerationInfo.SizeAfterBytes`](https://learn.microsoft.com/en-us/dotnet/api/system.gcgenerationinfo.sizeafterbytes).
 
 <!-- semconv metric.clr.gc.heap.size(metric_table) -->
 <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
@@ -232,7 +227,6 @@ This metric is obtained from [`GC.GetGCMemoryInfo().GenerationInfo.SizeAfterByte
 ### Metric: `clr.gc.heap.fragmentation.size`
 
 This metric is [recommended][MetricRecommended].
-This metric is obtained from [`GC.GetGCMemoryInfo().GenerationInfo.FragmentationAfterBytes`](https://learn.microsoft.com/en-us/dotnet/api/system.gcgenerationinfo.fragmentationafterbytes).
 
 <!-- semconv metric.clr.gc.heap.fragmentation.size(metric_table) -->
 <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
@@ -268,12 +262,11 @@ This metric is obtained from [`GC.GetGCMemoryInfo().GenerationInfo.Fragmentation
 <!-- END AUTOGENERATED TEXT -->
 <!-- endsemconv -->
 
-### Metric: `clr.gc.duration`
+### Metric: `clr.gc.pause.time`
 
 This metric is [recommended][MetricRecommended].
-This metric is obtained from [`GC.GetTotalPauseDuration()`](https://learn.microsoft.com/en-us/dotnet/api/system.gc.gettotalpauseduration).
 
-<!-- semconv metric.clr.gc.duration(metric_table) -->
+<!-- semconv metric.clr.gc.pause.time(metric_table) -->
 <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
 <!-- see templates/registry/markdown/snippet.md.j2 -->
 <!-- prettier-ignore-start -->
@@ -282,15 +275,15 @@ This metric is obtained from [`GC.GetTotalPauseDuration()`](https://learn.micros
 
 | Name     | Instrument Type | Unit (UCUM) | Description    | Stability |
 | -------- | --------------- | ----------- | -------------- | --------- |
-| `clr.gc.duration` | Counter | `ns` | The total amount of time paused in GC since the process started. | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `clr.gc.pause.time` | Counter | `s` | The total amount of time paused in GC since the process has started. | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 
 
 <!-- markdownlint-restore -->
 <!-- prettier-ignore-end -->
 <!-- END AUTOGENERATED TEXT -->
 <!-- endsemconv -->
 
-<!-- semconv metric.clr.gc.duration(full) -->
+<!-- semconv metric.clr.gc.pause.time(full) -->
 <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
 <!-- see templates/registry/markdown/snippet.md.j2 -->
 <!-- prettier-ignore-start -->
@@ -312,7 +305,6 @@ This metric is obtained from [`GC.GetTotalPauseDuration()`](https://learn.micros
 ### Metric: `clr.jit.il_compiled.size`
 
 This metric is [recommended][MetricRecommended].
-This metric is obtained from [`JitInfo.GetCompiledILBytes()`](https://learn.microsoft.com/en-us/dotnet/api/system.runtime.jitinfo.getcompiledilbytes).
 
 <!-- semconv metric.clr.jit.il_compiled.size(metric_table) -->
 <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
@@ -323,7 +315,7 @@ This metric is obtained from [`JitInfo.GetCompiledILBytes()`](https://learn.micr
 
 | Name     | Instrument Type | Unit (UCUM) | Description    | Stability |
 | -------- | --------------- | ----------- | -------------- | --------- |
-| `clr.jit.il_compiled.size` | Counter | `By` | Count of bytes of intermediate language that have been compiled since the process start. | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `clr.jit.il_compiled.size` | Counter | `By` | Count of bytes of intermediate language that have been compiled since the process has started. | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 
 
 <!-- markdownlint-restore -->
@@ -347,7 +339,6 @@ This metric is obtained from [`JitInfo.GetCompiledILBytes()`](https://learn.micr
 ### Metric: `clr.jit.methods_compiled.count`
 
 This metric is [recommended][MetricRecommended].
-This metric is obtained from [`JitInfo.GetCompiledMethodCount()`](https://learn.microsoft.com/en-us/dotnet/api/system.runtime.jitinfo.getcompiledmethodcount).
 
 <!-- semconv metric.clr.jit.methods_compiled.count(metric_table) -->
 <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
@@ -358,7 +349,7 @@ This metric is obtained from [`JitInfo.GetCompiledMethodCount()`](https://learn.
 
 | Name     | Instrument Type | Unit (UCUM) | Description    | Stability |
 | -------- | --------------- | ----------- | -------------- | --------- |
-| `clr.jit.methods_compiled.count` | Counter | `{method}` | The number of times the JIT compiler (re)compiled methods since the process start. | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `clr.jit.methods_compiled.count` | Counter | `{method}` | The number of times the JIT compiler (re)compiled methods since the process has started. | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 
 
 <!-- markdownlint-restore -->
@@ -379,12 +370,11 @@ This metric is obtained from [`JitInfo.GetCompiledMethodCount()`](https://learn.
 <!-- END AUTOGENERATED TEXT -->
 <!-- endsemconv -->
 
-### Metric: `clr.jit.compilation_time`
+### Metric: `clr.jit.compilation.time`
 
 This metric is [recommended][MetricRecommended].
-This metric is obtained from [`JitInfo.GetCompilationTime()`](https://learn.microsoft.com/en-us/dotnet/api/system.runtime.jitinfo.getcompilationtime).
 
-<!-- semconv metric.clr.jit.compilation_time(metric_table) -->
+<!-- semconv metric.clr.jit.compilation.time(metric_table) -->
 <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
 <!-- see templates/registry/markdown/snippet.md.j2 -->
 <!-- prettier-ignore-start -->
@@ -393,15 +383,15 @@ This metric is obtained from [`JitInfo.GetCompilationTime()`](https://learn.micr
 
 | Name     | Instrument Type | Unit (UCUM) | Description    | Stability |
 | -------- | --------------- | ----------- | -------------- | --------- |
-| `clr.jit.compilation_time` | Counter | `ns` | The amount of time the JIT compiler has spent compiling methods since the process start. | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `clr.jit.compilation.time` | Counter | `s` | The amount of time the JIT compiler has spent compiling methods since the process has started. | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 
 
 <!-- markdownlint-restore -->
 <!-- prettier-ignore-end -->
 <!-- END AUTOGENERATED TEXT -->
 <!-- endsemconv -->
 
-<!-- semconv metric.clr.jit.compilation_time(full) -->
+<!-- semconv metric.clr.jit.compilation.time(full) -->
 <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
 <!-- see templates/registry/markdown/snippet.md.j2 -->
 <!-- prettier-ignore-start -->
@@ -423,7 +413,6 @@ This metric is obtained from [`JitInfo.GetCompilationTime()`](https://learn.micr
 ### Metric: `clr.thread_pool.threads.count`
 
 This metric is [recommended][MetricRecommended].
-This metric is obtained from [`ThreadPool.ThreadCount`](https://learn.microsoft.com/en-us/dotnet/api/system.threading.threadpool.threadcount).
 
 <!-- semconv metric.clr.thread_pool.threads.count(metric_table) -->
 <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
@@ -458,7 +447,6 @@ This metric is obtained from [`ThreadPool.ThreadCount`](https://learn.microsoft.
 ### Metric: `clr.thread_pool.work_items.count`
 
 This metric is [recommended][MetricRecommended].
-This metric is obtained from [`ThreadPool.CompletedWorkItemCount`](https://learn.microsoft.com/en-us/dotnet/api/system.threading.threadpool.completedworkitemcount).
 
 <!-- semconv metric.clr.thread_pool.work_items.count(metric_table) -->
 <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
@@ -469,7 +457,7 @@ This metric is obtained from [`ThreadPool.CompletedWorkItemCount`](https://learn
 
 | Name     | Instrument Type | Unit (UCUM) | Description    | Stability |
 | -------- | --------------- | ----------- | -------------- | --------- |
-| `clr.thread_pool.work_items.count` | Counter | `{work_item}` | The number of work items that the thread pool has processed since the process start. | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `clr.thread_pool.work_items.count` | Counter | `{work_item}` | The number of work items that the thread pool has completed since the process has started. | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 
 
 <!-- markdownlint-restore -->
@@ -493,7 +481,6 @@ This metric is obtained from [`ThreadPool.CompletedWorkItemCount`](https://learn
 ### Metric: `clr.thread_pool.queue.length`
 
 This metric is [recommended][MetricRecommended].
-This metric is obtained from [`ThreadPool.PendingWorkItemCount`](https://learn.microsoft.com/en-us/dotnet/api/system.threading.threadpool.pendingworkitemcount).
 
 <!-- semconv metric.clr.thread_pool.queue.length(metric_table) -->
 <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
@@ -534,7 +521,6 @@ This metric is obtained from [`ThreadPool.PendingWorkItemCount`](https://learn.m
 ### Metric: `clr.monitor.lock_contention.count`
 
 This metric is [recommended][MetricRecommended].
-This metric is obtained from [`Monitor.LockContentionCount`](https://learn.microsoft.com/en-us/dotnet/api/system.threading.monitor.lockcontentioncount).
 
 <!-- semconv metric.clr.monitor.lock_contention.count(metric_table) -->
 <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
@@ -545,7 +531,7 @@ This metric is obtained from [`Monitor.LockContentionCount`](https://learn.micro
 
 | Name     | Instrument Type | Unit (UCUM) | Description    | Stability |
 | -------- | --------------- | ----------- | -------------- | --------- |
-| `clr.monitor.lock_contention.count` | Counter | `{contention}` | The number of times there was contention when trying to acquire a monitor lock since the process start. | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `clr.monitor.lock_contention.count` | Counter | `{contention}` | The number of times there was contention when trying to acquire a monitor lock since the process has started. | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 
 
 <!-- markdownlint-restore -->
@@ -569,7 +555,6 @@ This metric is obtained from [`Monitor.LockContentionCount`](https://learn.micro
 ### Metric: `clr.timer.count`
 
 This metric is [recommended][MetricRecommended].
-This metric is obtained from [`Timer.ActiveCount`](https://learn.microsoft.com/en-us/dotnet/api/system.threading.timer.activecount).
 
 <!-- semconv metric.clr.timer.count(metric_table) -->
 <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
@@ -604,7 +589,6 @@ This metric is obtained from [`Timer.ActiveCount`](https://learn.microsoft.com/e
 ### Metric: `clr.assemblies.count`
 
 This metric is [recommended][MetricRecommended].
-This metric is obtained from [`AppDomain.CurrentDomain.GetAssemblies().Length`](https://learn.microsoft.com/en-us/dotnet/api/system.appdomain.getassemblies).
 
 <!-- semconv metric.clr.assemblies.count(metric_table) -->
 <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
@@ -639,7 +623,6 @@ This metric is obtained from [`AppDomain.CurrentDomain.GetAssemblies().Length`](
 ### Metric: `clr.exceptions.count`
 
 This metric is [recommended][MetricRecommended].
-This metric is obtained from [`AppDomain.CurrentDomain.FirstChanceException`](https://learn.microsoft.com/en-us/dotnet/api/system.appdomain.firstchanceexception).
 
 <!-- semconv metric.clr.exceptions.count(metric_table) -->
 <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
@@ -650,7 +633,7 @@ This metric is obtained from [`AppDomain.CurrentDomain.FirstChanceException`](ht
 
 | Name     | Instrument Type | Unit (UCUM) | Description    | Stability |
 | -------- | --------------- | ----------- | -------------- | --------- |
-| `clr.exceptions.count` | Counter | `{exception}` | Count of exceptions that have been thrown in managed code. | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `clr.exceptions.count` | Counter | `{exception}` | The number of exceptions that have been thrown in managed code. | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 
 
 <!-- markdownlint-restore -->

diff --git a/model/metrics/clr-metrics.yaml b/model/metrics/clr-metrics.yaml
@@ -2,7 +2,7 @@ groups:
   - id: metric.clr.gc.collections.count
     type: metric
     metric_name: clr.gc.collections.count
-    brief: "Number of garbage collections that have occurred since the process started."
+    brief: "Number of garbage collections that have occurred since the process has started."
     instrument: counter
     unit: "{collection}"
     stability: experimental
@@ -22,7 +22,7 @@ groups:
     type: metric
     metric_name: clr.gc.allocations.size
     brief: >
-      The number of bytes allocated on the managed GC heap since the process
+      The number of bytes allocated on the managed GC heap since the process has
       started. The returned value does not include any native allocations.
     instrument: counter
     unit: "By"
@@ -68,17 +68,18 @@ groups:
       - ref: clr.gc.generation
         requirement_level: required
 
-  - id: metric.clr.gc.duration
+  - id: metric.clr.gc.pause.time
     type: metric
-    metric_name: clr.gc.duration
-    brief: "The total amount of time paused in GC since the process started."
+    metric_name: clr.gc.pause.time
+    brief: "The total amount of time paused in GC since the process has started."
     instrument: counter
-    unit: "ns"
+    unit: "s"
     stability: experimental
+
   - id: metric.clr.jit.il_compiled.size
     type: metric
     metric_name: clr.jit.il_compiled.size
-    brief: "Count of bytes of intermediate language that have been compiled since the process start."
+    brief: "Count of bytes of intermediate language that have been compiled since the process has started."
     instrument: counter
     unit: "By"
     stability: experimental
@@ -88,27 +89,27 @@ groups:
     metric_name: clr.jit.methods_compiled.count
     brief: >
       The number of times the JIT compiler (re)compiled methods since the
-      process start.
+      process has started.
     instrument: counter
     unit: "{method}"
     stability: experimental
 
-  - id: metric.clr.jit.compilation_time
+  - id: metric.clr.jit.compilation.time
     type: metric
-    metric_name: clr.jit.compilation_time
+    metric_name: clr.jit.compilation.time
     brief: >
       The amount of time the JIT compiler has spent compiling methods since the
-      process start.
+      process has started.
     instrument: counter
-    unit: "ns"
+    unit: "s"
     stability: experimental
 
   - id: metric.clr.monitor.lock_contention.count
     type: metric
     metric_name: clr.monitor.lock_contention.count
     brief: >
       The number of times there was contention when trying to acquire a monitor
-      lock since the process start.
+      lock since the process has started.
     instrument: counter
     unit: "{contention}"
     stability: experimental
@@ -125,8 +126,8 @@ groups:
     type: metric
     metric_name: clr.thread_pool.work_items.count
     brief: >
-      The number of work items that the thread pool has processed since
-      the process start.
+      The number of work items that the thread pool has completed since
+      the process has started.
     instrument: counter
     unit: "{work_item}"
     stability: experimental