Skip to content

Commit f1b1d72

Browse files
authored
Fix metric.v8js.memory.heap.space.physical_size and metric.v8js.memory.heap.space.available_size metric names (#2856)
1 parent d66109f commit f1b1d72

File tree

4 files changed

+64
-12
lines changed

4 files changed

+64
-12
lines changed

.chloggen/update-v8js-metrics.yaml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Use this changelog template to create an entry for release notes.
2+
#
3+
# If your change doesn't affect end users you should instead start
4+
# your pull request title with [chore] or use the "Skip Changelog" label.
5+
6+
# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
7+
change_type: breaking
8+
9+
# The name of the area of concern in the attributes-registry, (e.g. http, cloud, db)
10+
component: v8js
11+
12+
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
13+
note: |
14+
Rename metric `v8js.heap.space.available_size` to `v8js.memory.heap.space.available_size`.
15+
Rename metric `v8js.heap.space.physical_size` to `v8js.memory.heap.space.physical_size`.
16+
17+
# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
18+
# The values here must be integers.
19+
issues: [2856]

docs/runtime/v8js-metrics.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ This document describes semantic conventions for V8 JS Engine Runtime metrics in
1313
- [Metric: `v8js.gc.duration`](#metric-v8jsgcduration)
1414
- [Metric: `v8js.memory.heap.limit`](#metric-v8jsmemoryheaplimit)
1515
- [Metric: `v8js.memory.heap.used`](#metric-v8jsmemoryheapused)
16-
- [Metric: `v8js.heap.space.available_size`](#metric-v8jsheapspaceavailable_size)
17-
- [Metric: `v8js.heap.space.physical_size`](#metric-v8jsheapspacephysical_size)
16+
- [Metric: `v8js.memory.heap.space.available_size`](#metric-v8jsmemoryheapspaceavailable_size)
17+
- [Metric: `v8js.memory.heap.space.physical_size`](#metric-v8jsmemoryheapspacephysical_size)
1818

1919
<!-- tocstop -->
2020

@@ -141,11 +141,11 @@ This metric is [recommended][MetricRecommended].
141141
<!-- END AUTOGENERATED TEXT -->
142142
<!-- endsemconv -->
143143

144-
## Metric: `v8js.heap.space.available_size`
144+
## Metric: `v8js.memory.heap.space.available_size`
145145

146146
This metric is [recommended][MetricRecommended].
147147

148-
<!-- semconv metric.v8js.heap.space.available_size -->
148+
<!-- semconv metric.v8js.memory.heap.space.available_size -->
149149
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
150150
<!-- see templates/registry/markdown/snippet.md.j2 -->
151151
<!-- prettier-ignore-start -->
@@ -154,7 +154,7 @@ This metric is [recommended][MetricRecommended].
154154

155155
| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
156156
| -------- | --------------- | ----------- | -------------- | --------- | ------ |
157-
| `v8js.heap.space.available_size` | UpDownCounter | `By` | Heap space available size. [1] | ![Development](https://img.shields.io/badge/-development-blue) | |
157+
| `v8js.memory.heap.space.available_size` | UpDownCounter | `By` | Heap space available size. [1] | ![Development](https://img.shields.io/badge/-development-blue) | |
158158

159159
**[1]:** Value can be retrieved from value `space_available_size` of [`v8.getHeapSpaceStatistics()`](https://nodejs.org/api/v8.html#v8getheapspacestatistics)
160160

@@ -181,11 +181,11 @@ This metric is [recommended][MetricRecommended].
181181
<!-- END AUTOGENERATED TEXT -->
182182
<!-- endsemconv -->
183183

184-
## Metric: `v8js.heap.space.physical_size`
184+
## Metric: `v8js.memory.heap.space.physical_size`
185185

186186
This metric is [recommended][MetricRecommended].
187187

188-
<!-- semconv metric.v8js.heap.space.physical_size -->
188+
<!-- semconv metric.v8js.memory.heap.space.physical_size -->
189189
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
190190
<!-- see templates/registry/markdown/snippet.md.j2 -->
191191
<!-- prettier-ignore-start -->
@@ -194,7 +194,7 @@ This metric is [recommended][MetricRecommended].
194194

195195
| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
196196
| -------- | --------------- | ----------- | -------------- | --------- | ------ |
197-
| `v8js.heap.space.physical_size` | UpDownCounter | `By` | Committed size of a heap space. [1] | ![Development](https://img.shields.io/badge/-development-blue) | |
197+
| `v8js.memory.heap.space.physical_size` | UpDownCounter | `By` | Committed size of a heap space. [1] | ![Development](https://img.shields.io/badge/-development-blue) | |
198198

199199
**[1]:** Value can be retrieved from value `physical_space_size` of [`v8.getHeapSpaceStatistics()`](https://nodejs.org/api/v8.html#v8getheapspacestatistics)
200200

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
groups:
2+
- id: metric.v8js.heap.space.available_size
3+
type: metric
4+
metric_name: v8js.heap.space.available_size
5+
deprecated:
6+
reason: renamed
7+
renamed_to: v8js.memory.heap.space.available_size
8+
annotations:
9+
code_generation:
10+
metric_value_type: int
11+
brief: "Deprecated, use `v8js.memory.heap.space.available_size` instead."
12+
instrument: updowncounter
13+
unit: "By"
14+
stability: development
15+
attributes:
16+
- ref: v8js.heap.space.name
17+
requirement_level: required
18+
- id: metric.v8js.heap.space.physical_size
19+
type: metric
20+
metric_name: v8js.heap.space.physical_size
21+
deprecated:
22+
reason: renamed
23+
renamed_to: v8js.memory.heap.space.physical_size
24+
annotations:
25+
code_generation:
26+
metric_value_type: int
27+
brief: "Deprecated, use `v8js.memory.heap.space.physical_size` instead."
28+
instrument: updowncounter
29+
unit: "By"
30+
stability: development
31+
attributes:
32+
- ref: v8js.heap.space.name
33+
requirement_level: required

model/v8js/metrics.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,9 @@ groups:
4949
The value can be retrieved from value `space_used_size` of
5050
[`v8.getHeapSpaceStatistics()`](https://nodejs.org/api/v8.html#v8getheapspacestatistics)
5151
52-
- id: metric.v8js.heap.space.available_size
52+
- id: metric.v8js.memory.heap.space.available_size
5353
type: metric
54-
metric_name: v8js.heap.space.available_size
54+
metric_name: v8js.memory.heap.space.available_size
5555
annotations:
5656
code_generation:
5757
metric_value_type: int
@@ -65,9 +65,9 @@ groups:
6565
note: >
6666
Value can be retrieved from value `space_available_size` of [`v8.getHeapSpaceStatistics()`](https://nodejs.org/api/v8.html#v8getheapspacestatistics)
6767
68-
- id: metric.v8js.heap.space.physical_size
68+
- id: metric.v8js.memory.heap.space.physical_size
6969
type: metric
70-
metric_name: v8js.heap.space.physical_size
70+
metric_name: v8js.memory.heap.space.physical_size
7171
annotations:
7272
code_generation:
7373
metric_value_type: int

0 commit comments

Comments
 (0)