Add initial experimental .NET CLR runtime metrics

.chloggen/clr-runtime.yaml

@@ -0,0 +1,22 @@
+# Use this changelog template to create an entry for release notes.
+#
+# If your change doesn't affect end users you should instead start
+# your pull request title with [chore] or use the "Skip Changelog" label.
+
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: new_component
+
+# The name of the area of concern in the attributes-registry, (e.g. http, cloud, db)
+component: clr
+
+# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Adds experimental metrics for the Common Language Runtime (CLR)."
+
+# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
+# The values here must be integers.
+issues: [956]
+
+# (Optional) One or more lines of additional information to render under the primary note.
+# These lines will be padded with 2 spaces and then inserted directly into the document.
+# Use pipe (|) for multiline entries.
+subtext:

docs/attributes-registry/README.md

@@ -41,6 +41,7 @@ Currently, the following namespaces exist:
 - [Client](client.md)
 - [Cloud](cloud.md)
 - [CloudEvents](cloudevents.md)
+- [CLR](clr.md)
 - [Code](code.md)
 - [Container](container.md)
 - [CPU](cpu.md)

docs/attributes-registry/clr.md

@@ -0,0 +1,15 @@
+<!--- Hugo front matter used to generate the website version of this page:
+--->
+
+<!-- NOTE: THIS FILE IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
+<!-- see templates/registry/markdown/attribute_namespace.md.j2 -->
+
+# CLR
+
+## Clr Attributes
+
+This document defines .NET Common Language Runtime (CLR) related attributes.
+
+| Attribute           | Type   | Description                                    | Examples                             | Stability                                                        |
+| ------------------- | ------ | ---------------------------------------------- | ------------------------------------ | ---------------------------------------------------------------- |
+| `clr.gc.generation` | string | Name of the garbage collector heap generation. | `gen0`; `gen1`; `gen2`; `loh`; `poh` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |

docs/runtime/README.md

@@ -51,6 +51,7 @@ semantic conventions when instrumenting runtime environments.
 - [JVM](jvm-metrics.md)
 - [Node.js](nodejs-metrics.md)
 - [V8 JS Engine](v8js-metrics.md)
+- [.NET](dotnet-metrics.md)
 
 ### Attributes
 

model/metrics/clr-metrics.yaml

@@ -0,0 +1,154 @@
+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.
+    instrument: counter
+    unit: "{collection}"
+    stability: experimental
+    attributes:
+      - ref: clr.gc.generation
+        requirement_level: required
+  - id: metric.clr.gc.objects.size
+    type: metric
+    metric_name: clr.gc.objects.size
+    brief: > 
+      The number of bytes currently allocated on the managed GC heap.
+      Fragmentation and other GC committed memory pools are excluded.
+    instrument: updowncounter
+    unit: "By"
+    stability: experimental
+  - id: metric.clr.gc.allocations.size
+    type: metric
+    metric_name: clr.gc.allocations.size
+    brief: > 
+      The number of bytes allocated on the managed GC heap since the process
+      started. The returned value does not include any native allocations.
+    instrument: counter
+    unit: "By"
+    stability: experimental
+  - id: metric.clr.gc.committed_memory.size
+    type: metric
+    metric_name: clr.gc.committed_memory.size
+    brief: > 
+      The amount of committed virtual memory for the managed GC heap, as
+      observed during the latest garbage collection.
+    note: >
+      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.
+    instrument: updowncounter
+    unit: "By"
+    stability: experimental
+  - id: metric.clr.gc.heap.size
+    type: metric
+    metric_name: clr.gc.heap.size
+    brief: >
+      The heap size (including fragmentation), as observed during the latest
+      garbage collection.
+    instrument: updowncounter
+    unit: "By"
+    stability: experimental
+    attributes:
+      - ref: clr.gc.generation
+        requirement_level: required
+  - id: metric.clr.gc.heap.fragmentation.size
+    type: metric
+    metric_name: clr.gc.heap.fragmentation.size
+    brief: >
+      The heap fragmentation, as observed during the latest garbage collection.
+    instrument: updowncounter
+    unit: "By"
+    stability: experimental
+    attributes:
+      - ref: clr.gc.generation
+        requirement_level: required
+  - id: metric.clr.gc.duration
+    type: metric
+    metric_name: clr.gc.duration
+    brief: "The total amount of time paused in GC since the process started."
+    instrument: counter
+    unit: "ns"
+    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."
+    instrument: counter
+    unit: "By"
+    stability: experimental
+  - id: metric.clr.jit.methods_compiled.count
+    type: metric
+    metric_name: clr.jit.methods_compiled.count
+    brief: >
+      The number of times the JIT compiler (re)compiled methods since the
+      process start.
+    instrument: counter
+    unit: "{method}"
+    stability: experimental
+  - id: metric.clr.jit.compilation_time
+    type: metric
+    metric_name: clr.jit.compilation_time
+    brief: >
+      The amount of time the JIT compiler has spent compiling methods since the
+      process start.
+    instrument: counter
+    unit: "ns"
+    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.
+    instrument: counter
+    unit: "{contention}"
+    stability: experimental
+  - id: metric.clr.thread_pool.threads.count
+    type: metric
+    metric_name: clr.thread_pool.threads.count
+    brief: "The number of thread pool threads that currently exist."
+    instrument: updowncounter
+    unit: "{thread}"
+    stability: experimental
+  - id: metric.clr.thread_pool.work_items.count
+    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.
+    instrument: counter
+    unit: "{work_item}"
+    stability: experimental
+  - id: metric.clr.thread_pool.queue.length
+    type: metric
+    metric_name: clr.thread_pool.queue.length
+    brief: > 
+      The number of work items that are currently queued to be processed by the
+      thread pool.
+    instrument: updowncounter
+    unit: "{queue}"
+    stability: experimental
+  - id: metric.clr.timer.count
+    type: metric
+    metric_name: clr.timer.count
+    brief: "The number of timer instances that are currently active."
+    instrument: updowncounter
+    unit: "{timer}"
+    stability: experimental
+  - id: metric.clr.assemblies.count
+    type: metric
+    metric_name: clr.assemblies.count
+    brief: "The number of .NET assemblies that are currently loaded."
+    instrument: updowncounter
+    unit: "{assembly}"
+    stability: experimental
+  - id: metric.clr.exceptions.count
+    type: metric
+    metric_name: clr.exceptions.count
+    brief: "Count of exceptions that have been thrown in managed code."
+    instrument: counter
+    unit: "{exception}"
+    stability: experimental

model/registry/clr.yaml

@@ -0,0 +1,12 @@
+groups:
+  - id: registry.clr
+    type: attribute_group
+    prefix: clr
+    brief: >
+      This document defines .NET Common Language Runtime (CLR) related attributes.
+    attributes:
+      - id: gc.generation
+        stability: experimental
+        type: string
+        brief: Name of the garbage collector heap generation.
+        examples: ["gen0", "gen1", "gen2", "loh", "poh"]

templates/registry/markdown/weaver.yaml

@@ -11,6 +11,7 @@ acronyms:
   - AWS
   - CICD
   - CloudEvents
+  - CLR
   - CPU
   - CosmosDB
   - DynamoDB