Skip to content

Commit

Permalink
Update with proposed renames
Browse files Browse the repository at this point in the history
  • Loading branch information
@stevejgordon
stevejgordon committed Aug 5, 2024
1 parent cdbef6a commit 3d14868
Show file tree
Hide file tree
Showing 2 changed files with 54 additions and 54 deletions.
78 changes: 39 additions & 39 deletions docs/runtime/dotnet-metrics.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,22 +15,22 @@ 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.objects.size`](#metric-dotnetgcobjectssize)
- [Metric: `dotnet.gc.allocations.size`](#metric-dotnetgcallocationssize)
- [Metric: `dotnet.gc.committed_memory.size`](#metric-dotnetgccommitted_memorysize)
- [Metric: `dotnet.gc.memory.total_allocated`](#metric-dotnetgcmemorytotal_allocated)
- [Metric: `dotnet.gc.memory.commited`](#metric-dotnetgcmemorycommited)
- [Metric: `dotnet.gc.heap.size`](#metric-dotnetgcheapsize)
- [Metric: `dotnet.gc.heap.fragmentation.size`](#metric-dotnetgcheapfragmentationsize)
- [Metric: `dotnet.gc.heap.fragmentation`](#metric-dotnetgcheapfragmentation)
- [Metric: `dotnet.gc.pause.time`](#metric-dotnetgcpausetime)
- [Just-In-Time (JIT) Compiler](#just-in-time-jit-compiler)
- [Metric: `dotnet.jit.il_compiled.size`](#metric-dotnetjitil_compiledsize)
- [Metric: `dotnet.jit.methods_compiled.count`](#metric-dotnetjitmethods_compiledcount)
- [Metric: `dotnet.jit.compiled_il.size`](#metric-dotnetjitcompiled_ilsize)
- [Metric: `dotnet.jit.compiled_method.count`](#metric-dotnetjitcompiled_methodcount)
- [Metric: `dotnet.jit.compilation.time`](#metric-dotnetjitcompilationtime)
- [Thread pool](#thread-pool)
- [Metric: `dotnet.thread_pool.threads.count`](#metric-dotnetthread_poolthreadscount)
- [Metric: `dotnet.thread_pool.work_items.count`](#metric-dotnetthread_poolwork_itemscount)
- [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.timers.count`](#metric-dotnettimerscount)
- [Metric: `dotnet.timer.count`](#metric-dotnettimercount)
- [Metric: `dotnet.assemblies.count`](#metric-dotnetassembliescount)
- [Metric: `dotnet.exceptions.count`](#metric-dotnetexceptionscount)

Expand Down Expand Up @@ -133,11 +133,11 @@ This metric is [recommended][MetricRecommended].
<!-- END AUTOGENERATED TEXT -->
<!-- endsemconv -->

### Metric: `dotnet.gc.allocations.size`
### Metric: `dotnet.gc.memory.total_allocated`

This metric is [recommended][MetricRecommended].

<!-- semconv metric.dotnet.gc.allocations.size(metric_table) -->
<!-- semconv metric.dotnet.gc.memory.total_allocated(metric_table) -->
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
<!-- see templates/registry/markdown/snippet.md.j2 -->
<!-- prettier-ignore-start -->
Expand All @@ -146,7 +146,7 @@ This metric is [recommended][MetricRecommended].

| Name | Instrument Type | Unit (UCUM) | Description | Stability |
| -------- | --------------- | ----------- | -------------- | --------- |
| `dotnet.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. [1] | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `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) |


**[1]:** This metric reports the same values as calling [`GC.GetTotalAllocatedBytes()`](https://learn.microsoft.com/dotnet/api/system.gc.gettotalallocatedbytes).
Expand All @@ -158,7 +158,7 @@ This metric is [recommended][MetricRecommended].
<!-- END AUTOGENERATED TEXT -->
<!-- endsemconv -->

<!-- semconv metric.dotnet.gc.allocations.size(full) -->
<!-- semconv metric.dotnet.gc.memory.total_allocated(full) -->
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
<!-- see templates/registry/markdown/snippet.md.j2 -->
<!-- prettier-ignore-start -->
Expand All @@ -171,11 +171,11 @@ This metric is [recommended][MetricRecommended].
<!-- END AUTOGENERATED TEXT -->
<!-- endsemconv -->

### Metric: `dotnet.gc.committed_memory.size`
### Metric: `dotnet.gc.memory.commited`

This metric is [recommended][MetricRecommended].

<!-- semconv metric.dotnet.gc.committed_memory.size(metric_table) -->
<!-- semconv metric.dotnet.gc.memory.commited(metric_table) -->
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
<!-- see templates/registry/markdown/snippet.md.j2 -->
<!-- prettier-ignore-start -->
Expand All @@ -184,7 +184,7 @@ This metric is [recommended][MetricRecommended].

| Name | Instrument Type | Unit (UCUM) | Description | Stability |
| -------- | --------------- | ----------- | -------------- | --------- |
| `dotnet.gc.committed_memory.size` | UpDownCounter | `By` | The amount of committed virtual memory for the managed GC heap, as observed during the latest garbage collection. [1] | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `dotnet.gc.memory.commited` | UpDownCounter | `By` | The amount of committed virtual memory for the managed GC heap, 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.
Expand All @@ -196,7 +196,7 @@ This metric is [recommended][MetricRecommended].
<!-- END AUTOGENERATED TEXT -->
<!-- endsemconv -->

<!-- semconv metric.dotnet.gc.committed_memory.size(full) -->
<!-- semconv metric.dotnet.gc.memory.commited(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 @@ -262,11 +262,11 @@ This metric is [recommended][MetricRecommended].
<!-- END AUTOGENERATED TEXT -->
<!-- endsemconv -->

### Metric: `dotnet.gc.heap.fragmentation.size`
### Metric: `dotnet.gc.heap.fragmentation`

This metric is [recommended][MetricRecommended].

<!-- semconv metric.dotnet.gc.heap.fragmentation.size(metric_table) -->
<!-- semconv metric.dotnet.gc.heap.fragmentation(metric_table) -->
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
<!-- see templates/registry/markdown/snippet.md.j2 -->
<!-- prettier-ignore-start -->
Expand All @@ -275,7 +275,7 @@ This metric is [recommended][MetricRecommended].

| Name | Instrument Type | Unit (UCUM) | Description | Stability |
| -------- | --------------- | ----------- | -------------- | --------- |
| `dotnet.gc.heap.fragmentation.size` | UpDownCounter | `By` | The heap fragmentation, as observed during the latest garbage collection. [1] | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `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) |


**[1]:** This metric reports the same values as calling [`GC.GetGCMemoryInfo().GenerationInfo.FragmentationAfterBytes`](https://learn.microsoft.com/dotnet/api/system.gcgenerationinfo.fragmentationafterbytes).
Expand All @@ -287,7 +287,7 @@ This metric is [recommended][MetricRecommended].
<!-- END AUTOGENERATED TEXT -->
<!-- endsemconv -->

<!-- semconv metric.dotnet.gc.heap.fragmentation.size(full) -->
<!-- semconv metric.dotnet.gc.heap.fragmentation(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 @@ -359,11 +359,11 @@ This metric is [recommended][MetricRecommended].

**Description:** .NET Common Language Runtime (CLR) metrics relating to the Just-In-Time compiler, captured under the namespace `dotnet.jit.*`.

### Metric: `dotnet.jit.il_compiled.size`
### Metric: `dotnet.jit.compiled_il.size`

This metric is [recommended][MetricRecommended].

<!-- semconv metric.dotnet.jit.il_compiled.size(metric_table) -->
<!-- semconv metric.dotnet.jit.compiled_il.size(metric_table) -->
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
<!-- see templates/registry/markdown/snippet.md.j2 -->
<!-- prettier-ignore-start -->
Expand All @@ -372,7 +372,7 @@ This metric is [recommended][MetricRecommended].

| Name | Instrument Type | Unit (UCUM) | Description | Stability |
| -------- | --------------- | ----------- | -------------- | --------- |
| `dotnet.jit.il_compiled.size` | Counter | `By` | Count of bytes of intermediate language that have been compiled since the process has started. [1] | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `dotnet.jit.compiled_il.size` | Counter | `By` | Count of bytes of intermediate language that have been compiled since the process has started. [1] | ![Experimental](https://img.shields.io/badge/-experimental-blue) |


**[1]:** This metric reports the same values as calling [`JitInfo.GetCompiledILBytes()`](https://learn.microsoft.com/dotnet/api/system.runtime.jitinfo.getcompiledilbytes).
Expand All @@ -384,7 +384,7 @@ This metric is [recommended][MetricRecommended].
<!-- END AUTOGENERATED TEXT -->
<!-- endsemconv -->

<!-- semconv metric.dotnet.jit.il_compiled.size(full) -->
<!-- semconv metric.dotnet.jit.compiled_il.size(full) -->
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
<!-- see templates/registry/markdown/snippet.md.j2 -->
<!-- prettier-ignore-start -->
Expand All @@ -397,11 +397,11 @@ This metric is [recommended][MetricRecommended].
<!-- END AUTOGENERATED TEXT -->
<!-- endsemconv -->

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

This metric is [recommended][MetricRecommended].

<!-- semconv metric.dotnet.jit.methods_compiled.count(metric_table) -->
<!-- semconv metric.dotnet.jit.compiled_method.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 @@ -410,7 +410,7 @@ This metric is [recommended][MetricRecommended].

| Name | Instrument Type | Unit (UCUM) | Description | Stability |
| -------- | --------------- | ----------- | -------------- | --------- |
| `dotnet.jit.methods_compiled.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_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) |


**[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.methods_compiled.count(full) -->
<!-- semconv metric.dotnet.jit.compiled_method.count(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 @@ -479,11 +479,11 @@ This metric is [recommended][MetricRecommended].

**Description:** .NET Common Language Runtime (CLR) metrics relating to the thread pool, captured under the namespace `dotnet.thread_pool.*`.

### Metric: `dotnet.thread_pool.threads.count`
### Metric: `dotnet.thread_pool.thread.count`

This metric is [recommended][MetricRecommended].

<!-- semconv metric.dotnet.thread_pool.threads.count(metric_table) -->
<!-- semconv metric.dotnet.thread_pool.thread.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 @@ -492,7 +492,7 @@ This metric is [recommended][MetricRecommended].

| Name | Instrument Type | Unit (UCUM) | Description | Stability |
| -------- | --------------- | ----------- | -------------- | --------- |
| `dotnet.thread_pool.threads.count` | UpDownCounter | `{thread}` | The number of thread pool threads that currently exist. [1] | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `dotnet.thread_pool.thread.count` | UpDownCounter | `{thread}` | The number of thread pool threads that currently exist. [1] | ![Experimental](https://img.shields.io/badge/-experimental-blue) |


**[1]:** This metric reports the same values as calling [`ThreadPool.ThreadCount`](https://learn.microsoft.com/dotnet/api/system.threading.threadpool.threadcount).
Expand All @@ -504,7 +504,7 @@ This metric is [recommended][MetricRecommended].
<!-- END AUTOGENERATED TEXT -->
<!-- endsemconv -->

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

### Metric: `dotnet.thread_pool.work_items.count`
### Metric: `dotnet.thread_pool.work_item.count`

This metric is [recommended][MetricRecommended].

<!-- semconv metric.dotnet.thread_pool.work_items.count(metric_table) -->
<!-- semconv metric.dotnet.thread_pool.work_item.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 @@ -530,7 +530,7 @@ This metric is [recommended][MetricRecommended].

| Name | Instrument Type | Unit (UCUM) | Description | Stability |
| -------- | --------------- | ----------- | -------------- | --------- |
| `dotnet.thread_pool.work_items.count` | Counter | `{work_item}` | The number of work items that the thread pool has completed since the process has started. [1] | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `dotnet.thread_pool.work_item.count` | Counter | `{work_item}` | The number of work items that the thread pool has completed since the process has started. [1] | ![Experimental](https://img.shields.io/badge/-experimental-blue) |


**[1]:** This metric reports the same values as calling [`ThreadPool.CompletedWorkItemCount`](https://learn.microsoft.com/dotnet/api/system.threading.threadpool.completedworkitemcount).
Expand All @@ -542,7 +542,7 @@ This metric is [recommended][MetricRecommended].
<!-- END AUTOGENERATED TEXT -->
<!-- endsemconv -->

<!-- semconv metric.dotnet.thread_pool.work_items.count(full) -->
<!-- semconv metric.dotnet.thread_pool.work_item.count(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 @@ -637,11 +637,11 @@ This metric is [recommended][MetricRecommended].
<!-- END AUTOGENERATED TEXT -->
<!-- endsemconv -->

### Metric: `dotnet.timers.count`
### Metric: `dotnet.timer.count`

This metric is [recommended][MetricRecommended].

<!-- semconv metric.dotnet.timers.count(metric_table) -->
<!-- semconv metric.dotnet.timer.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 @@ -662,7 +662,7 @@ This metric is [recommended][MetricRecommended].
<!-- END AUTOGENERATED TEXT -->
<!-- endsemconv -->

<!-- semconv metric.dotnet.timers.count(full) -->
<!-- semconv metric.dotnet.timer.count(full) -->
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
<!-- see templates/registry/markdown/snippet.md.j2 -->
<!-- prettier-ignore-start -->
Expand Down
30 changes: 15 additions & 15 deletions model/metrics/dotnet-metrics.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ groups:
unit: "By"
stability: experimental

- id: metric.dotnet.gc.allocations.size
- id: metric.dotnet.gc.memory.total_allocated
type: metric
metric_name: dotnet.gc.allocations.size
metric_name: dotnet.gc.memory.total_allocated
brief: >
The number of bytes allocated on the managed GC heap since the process has
started. The returned value does not include any native allocations.
Expand All @@ -31,9 +31,9 @@ groups:
unit: "By"
stability: experimental

- id: metric.dotnet.gc.committed_memory.size
- id: metric.dotnet.gc.memory.commited
type: metric
metric_name: dotnet.gc.committed_memory.size
metric_name: dotnet.gc.memory.commited
brief: >
The amount of committed virtual memory for the managed GC heap, as
observed during the latest garbage collection.
Expand Down Expand Up @@ -62,9 +62,9 @@ groups:
- ref: dotnet.gc.heap.generation
requirement_level: required

- id: metric.dotnet.gc.heap.fragmentation.size
- id: metric.dotnet.gc.heap.fragmentation
type: metric
metric_name: dotnet.gc.heap.fragmentation.size
metric_name: dotnet.gc.heap.fragmentation
brief: >
The heap fragmentation, as observed during the latest garbage collection.
note: "This metric reports the same values as calling [`GC.GetGCMemoryInfo().GenerationInfo.FragmentationAfterBytes`](https://learn.microsoft.com/dotnet/api/system.gcgenerationinfo.fragmentationafterbytes)."
Expand All @@ -84,18 +84,18 @@ groups:
unit: "s"
stability: experimental

- id: metric.dotnet.jit.il_compiled.size
- id: metric.dotnet.jit.compiled_il.size
type: metric
metric_name: dotnet.jit.il_compiled.size
metric_name: dotnet.jit.compiled_il.size
brief: "Count of bytes of intermediate language that have been compiled since the process has started."
note: "This metric reports the same values as calling [`JitInfo.GetCompiledILBytes()`](https://learn.microsoft.com/dotnet/api/system.runtime.jitinfo.getcompiledilbytes)."
instrument: counter
unit: "By"
stability: experimental

- id: metric.dotnet.jit.methods_compiled.count
- id: metric.dotnet.jit.compiled_method.count
type: metric
metric_name: dotnet.jit.methods_compiled.count
metric_name: dotnet.jit.compiled_method.count
brief: >
The number of times the JIT compiler (re)compiled methods since the
process has started.
Expand Down Expand Up @@ -126,18 +126,18 @@ groups:
unit: "{contention}"
stability: experimental

- id: metric.dotnet.thread_pool.threads.count
- id: metric.dotnet.thread_pool.thread.count
type: metric
metric_name: dotnet.thread_pool.threads.count
metric_name: dotnet.thread_pool.thread.count
brief: "The number of thread pool threads that currently exist."
note: "This metric reports the same values as calling [`ThreadPool.ThreadCount`](https://learn.microsoft.com/dotnet/api/system.threading.threadpool.threadcount)."
instrument: updowncounter
unit: "{thread}"
stability: experimental

- id: metric.dotnet.thread_pool.work_items.count
- id: metric.dotnet.thread_pool.work_item.count
type: metric
metric_name: dotnet.thread_pool.work_items.count
metric_name: dotnet.thread_pool.work_item.count
brief: >
The number of work items that the thread pool has completed since
the process has started.
Expand All @@ -157,7 +157,7 @@ groups:
unit: "{queue}"
stability: experimental

- id: metric.dotnet.timers.count
- id: metric.dotnet.timer.count
type: metric
metric_name: dotnet.timer.count
brief: "The number of timer instances that are currently active."
Expand Down

0 comments on commit 3d14868

Please sign in to comment.