From 1aefc2939fc234939055c446af7151916920e2ec Mon Sep 17 00:00:00 2001 From: Steve Gordon Date: Fri, 28 Jun 2024 09:54:24 +0100 Subject: [PATCH] PR renaming feedback --- docs/runtime/dotnet-metrics.md | 44 +++++++++++++++---------------- model/metrics/dotnet-metrics.yaml | 22 ++++++++-------- 2 files changed, 33 insertions(+), 33 deletions(-) diff --git a/docs/runtime/dotnet-metrics.md b/docs/runtime/dotnet-metrics.md index 6759c487a2..2e92716082 100644 --- a/docs/runtime/dotnet-metrics.md +++ b/docs/runtime/dotnet-metrics.md @@ -13,7 +13,7 @@ This document describes semantic conventions for .NET CLR runtime metrics in Ope - [CLR Garbage Collection](#clr-garbage-collection) - - [Metric: `dotnet.gc.collections.count`](#metric-dotnetgccollectionscount) + - [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.commited`](#metric-dotnetgcmemorycommited) @@ -22,16 +22,16 @@ This document describes semantic conventions for .NET CLR runtime metrics in Ope - [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) - - [Metric: `dotnet.jit.compiled_method.count`](#metric-dotnetjitcompiled_methodcount) + - [Metric: `dotnet.jit.compiled_methods`](#metric-dotnetjitcompiled_methods) - [Metric: `dotnet.jit.compilation.time`](#metric-dotnetjitcompilationtime) - [Thread pool](#thread-pool) - [Metric: `dotnet.thread_pool.thread.count`](#metric-dotnetthread_poolthreadcount) - [Metric: `dotnet.thread_pool.work_item.count`](#metric-dotnetthread_poolwork_itemcount) - [Metric: `dotnet.thread_pool.queue.length`](#metric-dotnetthread_poolqueuelength) - [General](#general) - - [Metric: `dotnet.monitor.lock_contention.count`](#metric-dotnetmonitorlock_contentioncount) + - [Metric: `dotnet.monitor.lock_contentions`](#metric-dotnetmonitorlock_contentions) - [Metric: `dotnet.timer.count`](#metric-dotnettimercount) - - [Metric: `dotnet.assemblies.count`](#metric-dotnetassembliescount) + - [Metric: `dotnet.assembly.count`](#metric-dotnetassemblycount) - [Metric: `dotnet.exceptions.count`](#metric-dotnetexceptionscount) @@ -42,11 +42,11 @@ This document describes semantic conventions for .NET CLR runtime metrics in Ope **Description:** .NET Common Language Runtime (CLR) metrics relating to garbage collection, captured under the namespace `dotnet.gc.*`. -### Metric: `dotnet.gc.collections.count` +### Metric: `dotnet.gc.collections` This metric is [recommended][MetricRecommended]. - + @@ -55,7 +55,7 @@ This metric is [recommended][MetricRecommended]. | Name | Instrument Type | Unit (UCUM) | Description | Stability | | -------- | --------------- | ----------- | -------------- | --------- | -| `dotnet.gc.collections.count` | Counter | `{collection}` | Number of garbage collections that have occurred since the process has started. [1] | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `dotnet.gc.collections` | Counter | `{collection}` | Number of garbage collections that have occurred since the process has started. [1] | ![Experimental](https://img.shields.io/badge/-experimental-blue) | **[1]:** This metric reports the same values as calling [`GC.CollectionCount(int generation)`](https://learn.microsoft.com/dotnet/api/system.gc.collectioncount). @@ -67,7 +67,7 @@ This metric is [recommended][MetricRecommended]. - + @@ -146,7 +146,7 @@ This metric is [recommended][MetricRecommended]. | Name | Instrument Type | Unit (UCUM) | Description | Stability | | -------- | --------------- | ----------- | -------------- | --------- | -| `dotnet.gc.memory.total_allocated` | 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. [1] | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `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) | **[1]:** This metric reports the same values as calling [`GC.GetTotalAllocatedBytes()`](https://learn.microsoft.com/dotnet/api/system.gc.gettotalallocatedbytes). @@ -222,7 +222,7 @@ This metric is [recommended][MetricRecommended]. | Name | Instrument Type | Unit (UCUM) | Description | Stability | | -------- | --------------- | ----------- | -------------- | --------- | -| `dotnet.gc.heap.size` | UpDownCounter | `By` | The heap size (including fragmentation), as observed during the latest garbage collection. [1] | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `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) | **[1]:** This metric reports the same values as calling [`GC.GetGCMemoryInfo().GenerationInfo.SizeAfterBytes`](https://learn.microsoft.com/dotnet/api/system.gcgenerationinfo.sizeafterbytes). @@ -397,11 +397,11 @@ This metric is [recommended][MetricRecommended]. -### Metric: `dotnet.jit.compiled_method.count` +### Metric: `dotnet.jit.compiled_methods` This metric is [recommended][MetricRecommended]. - + @@ -410,7 +410,7 @@ This metric is [recommended][MetricRecommended]. | Name | Instrument Type | Unit (UCUM) | Description | Stability | | -------- | --------------- | ----------- | -------------- | --------- | -| `dotnet.jit.compiled_method.count` | Counter | `{method}` | The number of times the JIT compiler (re)compiled methods since the process has started. [1] | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `dotnet.jit.compiled_methods` | Counter | `{method}` | The number of times the JIT compiler (re)compiled methods since the process has started. [1] | ![Experimental](https://img.shields.io/badge/-experimental-blue) | **[1]:** This metric reports the same values as calling [`JitInfo.GetCompiledMethodCount()`](https://learn.microsoft.com/dotnet/api/system.runtime.jitinfo.getcompiledmethodcount). @@ -422,7 +422,7 @@ This metric is [recommended][MetricRecommended]. - + @@ -599,11 +599,11 @@ This metric is [recommended][MetricRecommended]. **Description:** Other useful .NET Common Language Runtime (CLR) metrics. -### Metric: `dotnet.monitor.lock_contention.count` +### Metric: `dotnet.monitor.lock_contentions` This metric is [recommended][MetricRecommended]. - + @@ -612,7 +612,7 @@ This metric is [recommended][MetricRecommended]. | Name | Instrument Type | Unit (UCUM) | Description | Stability | | -------- | --------------- | ----------- | -------------- | --------- | -| `dotnet.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. [1] | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `dotnet.monitor.lock_contentions` | Counter | `{contention}` | The number of times there was contention when trying to acquire a monitor lock since the process has started. [1] | ![Experimental](https://img.shields.io/badge/-experimental-blue) | **[1]:** This metric reports the same values as calling [`Monitor.LockContentionCount`](https://learn.microsoft.com/dotnet/api/system.threading.monitor.lockcontentioncount). @@ -624,7 +624,7 @@ This metric is [recommended][MetricRecommended]. - + @@ -675,11 +675,11 @@ This metric is [recommended][MetricRecommended]. -### Metric: `dotnet.assemblies.count` +### Metric: `dotnet.assembly.count` This metric is [recommended][MetricRecommended]. - + @@ -688,7 +688,7 @@ This metric is [recommended][MetricRecommended]. | Name | Instrument Type | Unit (UCUM) | Description | Stability | | -------- | --------------- | ----------- | -------------- | --------- | -| `dotnet.assemblies.count` | UpDownCounter | `{assembly}` | The number of .NET assemblies that are currently loaded. [1] | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `dotnet.assembly.count` | UpDownCounter | `{assembly}` | The number of .NET assemblies that are currently loaded. [1] | ![Experimental](https://img.shields.io/badge/-experimental-blue) | **[1]:** This metric reports the same values as calling [`AppDomain.CurrentDomain.GetAssemblies().Length`](https://learn.microsoft.com/dotnet/api/system.appdomain.getassemblies). @@ -700,7 +700,7 @@ This metric is [recommended][MetricRecommended]. - + diff --git a/model/metrics/dotnet-metrics.yaml b/model/metrics/dotnet-metrics.yaml index 485fa6ecde..4e95d7eaa0 100644 --- a/model/metrics/dotnet-metrics.yaml +++ b/model/metrics/dotnet-metrics.yaml @@ -1,7 +1,7 @@ groups: - - id: metric.dotnet.gc.collections.count + - id: metric.dotnet.gc.collections type: metric - metric_name: dotnet.gc.collections.count + metric_name: dotnet.gc.collections brief: "Number of garbage collections that have occurred since the process has started." note: "This metric reports the same values as calling [`GC.CollectionCount(int generation)`](https://learn.microsoft.com/dotnet/api/system.gc.collectioncount)." instrument: counter @@ -24,7 +24,7 @@ groups: type: metric metric_name: dotnet.gc.memory.total_allocated brief: > - The number of bytes allocated on the managed GC heap since the process has + 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. note: "This metric reports the same values as calling [`GC.GetTotalAllocatedBytes()`](https://learn.microsoft.com/dotnet/api/system.gc.gettotalallocatedbytes)." instrument: counter @@ -52,8 +52,8 @@ groups: type: metric metric_name: dotnet.gc.heap.size brief: > - The heap size (including fragmentation), as observed during the latest - garbage collection. + The managed GC heap size (including fragmentation), as observed during the + latest garbage collection. note: "This metric reports the same values as calling [`GC.GetGCMemoryInfo().GenerationInfo.SizeAfterBytes`](https://learn.microsoft.com/dotnet/api/system.gcgenerationinfo.sizeafterbytes)." instrument: updowncounter unit: "By" @@ -95,9 +95,9 @@ groups: unit: "By" stability: experimental - - id: metric.dotnet.jit.compiled_method.count + - id: metric.dotnet.jit.compiled_methods type: metric - metric_name: dotnet.jit.compiled_method.count + metric_name: dotnet.jit.compiled_methods brief: > The number of times the JIT compiler (re)compiled methods since the process has started. @@ -117,9 +117,9 @@ groups: unit: "s" stability: experimental - - id: metric.dotnet.monitor.lock_contention.count + - id: metric.dotnet.monitor.lock_contentions type: metric - metric_name: dotnet.monitor.lock_contention.count + metric_name: dotnet.monitor.lock_contentions brief: > The number of times there was contention when trying to acquire a monitor lock since the process has started. @@ -168,9 +168,9 @@ groups: unit: "{timer}" stability: experimental - - id: metric.dotnet.assemblies.count + - id: metric.dotnet.assembly.count type: metric - metric_name: dotnet.assemblies.count + metric_name: dotnet.assembly.count brief: "The number of .NET assemblies that are currently loaded." note: "This metric reports the same values as calling [`AppDomain.CurrentDomain.GetAssemblies().Length`](https://learn.microsoft.com/dotnet/api/system.appdomain.getassemblies)." instrument: updowncounter