Add node.js runtime metrics semantic conventions #991

maryliag · 2024-05-01T13:34:37Z

Part Of #990

Changes

Adding semantic conventions for Node.js runtime metrics

Merge requirement checklist

CONTRIBUTING.md guidelines followed.
Change log entry added, according to the guidelines in When to add a changelog entry.
- If your PR does not need a change log, start the PR title with [chore]
schema-next.yaml updated with changes to existing conventions.

maryliag · 2024-05-01T13:39:10Z

I wasn't sure if I need to update something on the next, since there was no changes to existing semantic. This is a new one.

trask · 2024-05-01T14:41:57Z

cc @open-telemetry/javascript-approvers

docs/runtime/nodejs-metrics.md

model/registry/nodejs.yaml

model/metrics/nodejs-metrics.yaml

Netail · 2024-05-02T20:06:39Z

I am wondering whether or not it should be called NodeJS. What if someone uses Deno or Bun?

maryliag · 2024-05-03T12:50:21Z

I am wondering whether or not it should be called NodeJS. What if someone uses Deno or Bun?

what about just js ?

Netail · 2024-05-03T12:54:37Z

I am wondering whether or not it should be called NodeJS. What if someone uses Deno or Bun?

what about just js ?

I mean I guess, but also feel like it can be confused with the language instead of the runtime environment

maryliag · 2024-05-03T12:58:11Z

I mean I guess, but also feel like it can be confused with the language instead of the runtime environment

if we want to go be definition, it would be runtimejs

Netail · 2024-05-03T13:10:03Z

I mean I guess, but also feel like it can be confused with the language instead of the runtime environment

if we want to go be definition, it would be runtimejs

jsruntime sounds maybe better? idk, might need some extra opinions

Netail · 2024-05-03T14:07:38Z

.chloggen/jsruntime-metrics.yaml

+component: jsruntime
+
+# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Introducing semantic conventions for Runtime Javascript (e.g. NodeJS, DenoJS, BunJS) runtime metrics.


I don't believe Deno and Bun use the JS suffix

pikalovArtemN · 2024-05-03T18:25:02Z

For my opinion different runtimes need to have diferent preffix.
For example:
node - nodejs
bun - bun
deno - denojs
etc...
Or some attribute that specify what runtime is currently run.
Or metric idk.

Also i think for version we need to set metric like it does in the prom-client library. Attribute in all metrics with version, for my opinion, it's not a good solution.

… into nodejs-metrics

maryliag · 2024-05-08T20:43:33Z

New updates:

Metrics separated in 2: node.js (containing only the node.js specific metrics), v8 js engine metrics (that can be used by other js runtime, such as deno)
replaced metrics where I was using type attributes to define the type, now they're separate metrics (for example, heap size and eventloop delay)

pikalovArtemN · 2024-05-17T06:52:53Z

docs/runtime/v8jsengineruntime-metrics.md

+<!-- semconv metric.veightjsengineruntime.memory.size(metric_table) -->
+| Name     | Instrument Type | Unit (UCUM) | Description    | Stability |
+| -------- | --------------- | ----------- | -------------- | --------- |
+| `v8jsengineruntime.memory.size` | UpDownCounter | `By` | External memory size. | ![Experimental](https://img.shields.io/badge/-experimental-blue) |


I think it's Gauge. like in prom-client library

… into nodejs-metrics

maryliag · 2024-05-23T18:37:47Z

From the discussion on the SIG meeting, keeping this PR just for node and created a new one for the v8 on #1066

docs/attributes-registry/nodejs.md

… into nodejs-metrics

trisch-me · 2024-06-04T13:55:11Z

docs/attributes-registry/nodejs.md

+
+## NodeJS Attributes
+
+Describes Node.js Runtime related attributes.


are those always only runtime attributes? I wonder if registry as agnostic entity should have runtime word

Suggested change

Describes Node.js Runtime related attributes.

Describes Node.js related attributes.

good point, removed!

… into nodejs-metrics

maryliag force-pushed the nodejs-metrics branch 2 times, most recently from 0415b17 to 8b98001 Compare May 1, 2024 13:38

maryliag force-pushed the nodejs-metrics branch from 8b98001 to 3dca0cb Compare May 1, 2024 13:43

dyladan mentioned this pull request May 1, 2024

feat(instrumentation-runtime-node): add prom-client-metrics open-telemetry/opentelemetry-js-contrib#2136

Open

maryliag force-pushed the nodejs-metrics branch 4 times, most recently from e103e60 to 42c6ce3 Compare May 1, 2024 22:14

Flarna reviewed May 2, 2024

View reviewed changes

docs/runtime/nodejs-metrics.md Outdated Show resolved Hide resolved

Flarna reviewed May 2, 2024

View reviewed changes

model/registry/nodejs.yaml Show resolved Hide resolved

Flarna reviewed May 2, 2024

View reviewed changes

model/registry/nodejs.yaml Outdated Show resolved Hide resolved

Flarna reviewed May 2, 2024

View reviewed changes

model/metrics/nodejs-metrics.yaml Outdated Show resolved Hide resolved

maryliag marked this pull request as ready for review May 2, 2024 15:16

maryliag requested review from a team as code owners May 2, 2024 15:16

github-actions bot assigned arminru May 2, 2024

maryliag force-pushed the nodejs-metrics branch 2 times, most recently from 50b741f to 5eb9c53 Compare May 2, 2024 20:39

maryliag force-pushed the nodejs-metrics branch 2 times, most recently from 12a8c9f to ce06636 Compare May 3, 2024 13:50

Netail reviewed May 3, 2024

View reviewed changes

maryliag force-pushed the nodejs-metrics branch from ce06636 to b0754ec Compare May 3, 2024 14:33

use histogram for gc.duration

f311e2b

maryliag force-pushed the nodejs-metrics branch from b0754ec to f311e2b Compare May 8, 2024 15:16

maryliag added 8 commits May 8, 2024 11:40

rename from jsruntime to nodejsruntime

5c1720c

add note on range for eventloop utilization

90a3ecc

rename eventoloop.lag to eventloop.delay

3388767

Merge branch 'main' of github.com:open-telemetry/semantic-conventions…

fb9eeee

… into nodejs-metrics

split between nodejs and v8 js engine metrics

46608a6

Merge branch 'main' of github.com:open-telemetry/semantic-conventions…

a68fca6

… into nodejs-metrics

split heap size memory

1272060

separate metric for heap size on eventloop delay

5037304

maryliag changed the title ~~Add node.js runtime metrics semantic conventions~~ Add node.js and v8 js engine runtime metrics semantic conventions May 8, 2024

add note on v8

2f771ed

pikalovArtemN suggested changes May 17, 2024

View reviewed changes

maryliag added 5 commits May 21, 2024 12:15

shorten the names, removing "runtime"

c97935e

Merge branch 'main' of github.com:open-telemetry/semantic-conventions…

0b31be3

… into nodejs-metrics

shorten v8 name

d345f67

regenerate docs

ca46bf0

change to gauge

3970c94

maryliag changed the title ~~Add node.js and v8 js engine runtime metrics semantic conventions~~ Add node.js runtime metrics semantic conventions May 23, 2024

maryliag added 2 commits May 23, 2024 14:34

remove v8 metrics to be added to another pr

fbeb7e0

Merge branch 'main' of github.com:open-telemetry/semantic-conventions…

44cd8eb

… into nodejs-metrics

trisch-me reviewed Jun 4, 2024

View reviewed changes

docs/attributes-registry/nodejs.md Outdated Show resolved Hide resolved

maryliag added 2 commits June 4, 2024 09:33

add nodeJS acronym

bf0a6c8

Merge branch 'main' of github.com:open-telemetry/semantic-conventions…

244b197

… into nodejs-metrics

trisch-me reviewed Jun 4, 2024

View reviewed changes

trisch-me approved these changes Jun 4, 2024

View reviewed changes

maryliag added 2 commits June 4, 2024 10:09

remove "runtime" from attributes model, which is generic

2291eea

Merge branch 'main' of github.com:open-telemetry/semantic-conventions…

b99aaf9

… into nodejs-metrics

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add node.js runtime metrics semantic conventions #991

Add node.js runtime metrics semantic conventions #991

maryliag commented May 1, 2024 •

edited

maryliag commented May 1, 2024

trask commented May 1, 2024

Netail commented May 2, 2024 •

edited

maryliag commented May 3, 2024

Netail commented May 3, 2024 •

edited

maryliag commented May 3, 2024

Netail commented May 3, 2024 •

edited

Netail May 3, 2024

maryliag May 3, 2024

pikalovArtemN commented May 3, 2024 •

edited

maryliag commented May 8, 2024

pikalovArtemN May 17, 2024

maryliag commented May 23, 2024

trisch-me Jun 4, 2024

maryliag Jun 4, 2024


		## NodeJS Attributes

		Describes Node.js Runtime related attributes.

	Describes Node.js Runtime related attributes.
	Describes Node.js related attributes.

Add node.js runtime metrics semantic conventions #991

Are you sure you want to change the base?

Add node.js runtime metrics semantic conventions #991

Conversation

maryliag commented May 1, 2024 • edited

Changes

Merge requirement checklist

maryliag commented May 1, 2024

trask commented May 1, 2024

Netail commented May 2, 2024 • edited

maryliag commented May 3, 2024

Netail commented May 3, 2024 • edited

maryliag commented May 3, 2024

Netail commented May 3, 2024 • edited

Netail May 3, 2024

Choose a reason for hiding this comment

maryliag May 3, 2024

Choose a reason for hiding this comment

pikalovArtemN commented May 3, 2024 • edited

maryliag commented May 8, 2024

pikalovArtemN May 17, 2024

Choose a reason for hiding this comment

maryliag commented May 23, 2024

trisch-me Jun 4, 2024

Choose a reason for hiding this comment

maryliag Jun 4, 2024

Choose a reason for hiding this comment

maryliag commented May 1, 2024 •

edited

Netail commented May 2, 2024 •

edited

Netail commented May 3, 2024 •

edited

Netail commented May 3, 2024 •

edited

pikalovArtemN commented May 3, 2024 •

edited