Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add v8 js engine runtime metrics semantic conventions #1066

Merged
merged 27 commits into from
Jul 8, 2024
Merged
Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
426fe1a
Add v8 js engine runtime metrics semantic conventions
maryliag May 23, 2024
061f17c
fix lint
maryliag May 23, 2024
dcee9f9
Merge branch 'main' of github.com:open-telemetry/semantic-conventions…
maryliag Jun 10, 2024
3c6be24
fix order
maryliag Jun 10, 2024
594a273
regenerate md files
maryliag Jun 10, 2024
42bd6c4
split memory metrics
maryliag Jun 14, 2024
cdbff03
Merge branch 'main' of github.com:open-telemetry/semantic-conventions…
maryliag Jun 14, 2024
536d637
feedback changes
maryliag Jun 18, 2024
ba7e207
Merge branch 'main' of github.com:open-telemetry/semantic-conventions…
maryliag Jun 18, 2024
ea6ddb9
changed on metric name and add notes
maryliag Jun 20, 2024
afb7c04
Merge branch 'main' of github.com:open-telemetry/semantic-conventions…
maryliag Jun 20, 2024
4f7cc54
fix lint
maryliag Jun 20, 2024
3ed22ac
fix lint
maryliag Jun 20, 2024
ef98ddb
Apply suggestions from code review
maryliag Jun 21, 2024
845a8d1
remove heap size and used, update descriptions
maryliag Jun 21, 2024
e5a37da
add source for GC
maryliag Jun 24, 2024
e9d8e57
Merge branch 'main' of github.com:open-telemetry/semantic-conventions…
maryliag Jun 24, 2024
ec5e081
remove non heap memory metrics
maryliag Jun 25, 2024
a909864
Merge branch 'main' of github.com:open-telemetry/semantic-conventions…
maryliag Jun 25, 2024
9e8cd01
make heap name required
maryliag Jun 26, 2024
c3eeca8
Merge branch 'main' of github.com:open-telemetry/semantic-conventions…
maryliag Jun 26, 2024
d07ed3a
Merge branch 'main' into v8js-runtime-metrics
joaopgrassi Jun 27, 2024
c12f9e8
Remove unreleased section from the middle of the changelog (#1189)
lmolkova Jun 27, 2024
2bff257
Add node.js runtime metrics semantic conventions (#991)
maryliag Jun 28, 2024
67ab709
Merge branch 'main' of github.com:open-telemetry/semantic-conventions…
maryliag Jun 29, 2024
0824689
make gc type required
maryliag Jul 8, 2024
1cbd520
Merge branch 'main' of github.com:open-telemetry/semantic-conventions…
maryliag Jul 8, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions .chloggen/v8js-metrics.yaml
Original file line number Diff line number Diff line change
@@ -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]
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ body:
- area:url
- area:user-agent
- area:user
- area:v8js
- area:webengine
# End semconv area list
- type: textarea
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/change_proposal.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ body:
- area:url
- area:user-agent
- area:user
- area:v8js
- area:webengine
# End semconv area list
- type: textarea
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/new-conventions.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ body:
- area:url
- area:user-agent
- area:user
- area:v8js
- area:webengine
# End semconv area list
- type: textarea
Expand Down
1 change: 1 addition & 0 deletions docs/attributes-registry/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,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
43 changes: 43 additions & 0 deletions docs/attributes-registry/v8js.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
<!--- 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. Available only when memory type is heap. | `new_space`; `old_space`; `code_space` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `v8js.memory.type` | string | The type of memory. | `heap`; `non_heap` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |

`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) |

`v8js.memory.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 |
| ---------- | --------------- | ---------------------------------------------------------------- |
| `heap` | Heap memory. | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `non_heap` | Non-heap memory | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
3 changes: 2 additions & 1 deletion docs/runtime/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,9 @@ Also consider the
[OS process metrics](/docs/system/process-metrics.md)
semantic conventions when instrumenting runtime environments.

- [JVM](jvm-metrics.md)
- [Go](go-metrics.md)
- [JVM](jvm-metrics.md)
- [V8 JS Engine](v8js-metrics.md)

### Attributes

Expand Down
Loading
Loading