Skip to content

Commit

Permalink
PR renaming feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
stevejgordon committed Aug 5, 2024
1 parent aa4eb33 commit 1aefc29
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 33 deletions.
44 changes: 22 additions & 22 deletions docs/runtime/dotnet-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This document describes semantic conventions for .NET CLR runtime metrics in Ope
<!-- toc -->

- [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)
Expand All @@ -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)

<!-- tocstop -->
Expand All @@ -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].

<!-- semconv metric.dotnet.gc.collections.count(metric_table) -->
<!-- semconv metric.dotnet.gc.collections(metric_table) -->
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
<!-- see templates/registry/markdown/snippet.md.j2 -->
<!-- prettier-ignore-start -->
Expand All @@ -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).
Expand All @@ -67,7 +67,7 @@ This metric is [recommended][MetricRecommended].
<!-- END AUTOGENERATED TEXT -->
<!-- endsemconv -->

<!-- semconv metric.dotnet.gc.collections.count(full) -->
<!-- semconv metric.dotnet.gc.collections(full) -->
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
<!-- see templates/registry/markdown/snippet.md.j2 -->
<!-- prettier-ignore-start -->
Expand Down Expand Up @@ -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).
Expand Down Expand Up @@ -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).
Expand Down Expand Up @@ -397,11 +397,11 @@ This metric is [recommended][MetricRecommended].
<!-- END AUTOGENERATED TEXT -->
<!-- endsemconv -->

### Metric: `dotnet.jit.compiled_method.count`
### Metric: `dotnet.jit.compiled_methods`

This metric is [recommended][MetricRecommended].

<!-- semconv metric.dotnet.jit.compiled_method.count(metric_table) -->
<!-- semconv metric.dotnet.jit.compiled_methods(metric_table) -->
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
<!-- see templates/registry/markdown/snippet.md.j2 -->
<!-- prettier-ignore-start -->
Expand All @@ -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).
Expand All @@ -422,7 +422,7 @@ This metric is [recommended][MetricRecommended].
<!-- END AUTOGENERATED TEXT -->
<!-- endsemconv -->

<!-- semconv metric.dotnet.jit.compiled_method.count(full) -->
<!-- semconv metric.dotnet.jit.compiled_methods(full) -->
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
<!-- see templates/registry/markdown/snippet.md.j2 -->
<!-- prettier-ignore-start -->
Expand Down Expand Up @@ -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].

<!-- semconv metric.dotnet.monitor.lock_contention.count(metric_table) -->
<!-- semconv metric.dotnet.monitor.lock_contentions(metric_table) -->
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
<!-- see templates/registry/markdown/snippet.md.j2 -->
<!-- prettier-ignore-start -->
Expand All @@ -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).
Expand All @@ -624,7 +624,7 @@ This metric is [recommended][MetricRecommended].
<!-- END AUTOGENERATED TEXT -->
<!-- endsemconv -->

<!-- semconv metric.dotnet.monitor.lock_contention.count(full) -->
<!-- semconv metric.dotnet.monitor.lock_contentions(full) -->
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
<!-- see templates/registry/markdown/snippet.md.j2 -->
<!-- prettier-ignore-start -->
Expand Down Expand Up @@ -675,11 +675,11 @@ This metric is [recommended][MetricRecommended].
<!-- END AUTOGENERATED TEXT -->
<!-- endsemconv -->

### Metric: `dotnet.assemblies.count`
### Metric: `dotnet.assembly.count`

This metric is [recommended][MetricRecommended].

<!-- semconv metric.dotnet.assemblies.count(metric_table) -->
<!-- semconv metric.dotnet.assembly.count(metric_table) -->
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
<!-- see templates/registry/markdown/snippet.md.j2 -->
<!-- prettier-ignore-start -->
Expand All @@ -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).
Expand All @@ -700,7 +700,7 @@ This metric is [recommended][MetricRecommended].
<!-- END AUTOGENERATED TEXT -->
<!-- endsemconv -->

<!-- semconv metric.dotnet.assemblies.count(full) -->
<!-- semconv metric.dotnet.assembly.count(full) -->
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
<!-- see templates/registry/markdown/snippet.md.j2 -->
<!-- prettier-ignore-start -->
Expand Down
22 changes: 11 additions & 11 deletions model/metrics/dotnet-metrics.yaml
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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"
Expand Down Expand Up @@ -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.
Expand All @@ -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.
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 1aefc29

Please sign in to comment.