Add v8 js engine runtime metrics semantic conventions (#1066)

Signed-off-by: maryliag <[email protected]> Co-authored-by: Liudmila Molkova <[email protected]> Co-authored-by: Joao Grassi <[email protected]>
open-telemetry · Jul 8, 2024 · b1ad9ae · b1ad9ae
1 parent 5971366
commit b1ad9ae
Show file tree

Hide file tree

Showing 10 changed files with 497 additions and 0 deletions.
diff --git a/.chloggen/v8js-metrics.yaml b/.chloggen/v8js-metrics.yaml
@@ -0,0 +1,17 @@
+# 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: v8js
+
+# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Introducing semantic conventions for V8 JS Engine runtime metrics.
+
+# 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: [990]
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml
@@ -72,6 +72,7 @@ body:
         - area:url
         - area:user-agent
         - area:user
+        - area:v8js
         - area:webengine
         # End semconv area list
   - type: textarea

diff --git a/.github/ISSUE_TEMPLATE/change_proposal.yaml b/.github/ISSUE_TEMPLATE/change_proposal.yaml
@@ -65,6 +65,7 @@ body:
         - area:url
         - area:user-agent
         - area:user
+        - area:v8js
         - area:webengine
         # End semconv area list
   - type: textarea

diff --git a/.github/ISSUE_TEMPLATE/new-conventions.yaml b/.github/ISSUE_TEMPLATE/new-conventions.yaml
@@ -74,6 +74,7 @@ body:
         - area:url
         - area:user-agent
         - area:user
+        - area:v8js
         - area:webengine
         # End semconv area list
   - type: textarea

diff --git a/docs/attributes-registry/README.md b/docs/attributes-registry/README.md
@@ -86,6 +86,7 @@ Currently, the following namespaces exist:
 - [URL](url.md)
 - [User](user.md)
 - [User Agent](user-agent.md)
+- [V8js](v8js.md)
 - [Webengine](webengine.md)
 
 [developers recommendations]: ../general/attribute-naming.md#recommendations-for-application-developers
diff --git a/docs/attributes-registry/v8js.md b/docs/attributes-registry/v8js.md
@@ -0,0 +1,37 @@
+<!--- 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 -->
+
+# V8js
+
+## V8js Attributes
+
+Describes V8 JS Engine Runtime related attributes.
+
+| Attribute              | Type   | Description                                    | Examples                               | Stability                                                        |
+| ---------------------- | ------ | ---------------------------------------------- | -------------------------------------- | ---------------------------------------------------------------- |
+| `v8js.gc.type`         | string | The type of garbage collection.                | `major`; `minor`; `incremental`        | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `v8js.heap.space.name` | string | The name of the space type of heap memory. [1] | `new_space`; `old_space`; `code_space` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+
+**[1]:** Value can be retrieved from value `space_name` of [`v8.getHeapSpaceStatistics()`](https://nodejs.org/api/v8.html#v8getheapspacestatistics)
+
+`v8js.gc.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
+
+| Value         | Description                              | Stability                                                        |
+| ------------- | ---------------------------------------- | ---------------------------------------------------------------- |
+| `incremental` | Incremental (Incremental Marking).       | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `major`       | Major (Mark Sweep Compact).              | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `minor`       | Minor (Scavenge).                        | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `weakcb`      | Weak Callbacks (Process Weak Callbacks). | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+
+`v8js.heap.space.name` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
+
+| Value                | Description                | Stability                                                        |
+| -------------------- | -------------------------- | ---------------------------------------------------------------- |
+| `code_space`         | Code memory space.         | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `large_object_space` | Large object memory space. | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `map_space`          | Map memory space.          | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `new_space`          | New memory space.          | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `old_space`          | Old memory space.          | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
diff --git a/docs/runtime/README.md b/docs/runtime/README.md
@@ -50,6 +50,7 @@ semantic conventions when instrumenting runtime environments.
 - [Go](go-metrics.md)
 - [JVM](jvm-metrics.md)
 - [Node.js](nodejs-metrics.md)
+- [V8 JS Engine](v8js-metrics.md)
 
 ### Attributes