Skip to content

Commit 1d67e2f

Browse files
ChrsMarktommyers-elastic
ChrsMark
authored and
tommyers-elastic
committed
[chore][flinkmetricsreceiver] Add stability level per metric (open-telemetry#42989)
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue. Ex. Adding a feature - Explain what this achieves.--> #### Description open-telemetry/opentelemetry-collector#13756 added support for exposing metrics' stability level in the generated documentation. This PR makes use of this functionality. We start by setting the stability of all metrics to `development`. More info about levels can be found at https://github.com/open-telemetry/opentelemetry-specification/blob/v1.49.0/oteps/0232-maturity-of-otel.md#maturity-levels. Related to: - open-telemetry/opentelemetry-collector#11878 - open-telemetry/opentelemetry-collector#13297 - open-telemetry#35325 - open-telemetry#42809 <!-- Issue number (e.g. open-telemetry#1234) or full URL to issue, if applicable. --> #### Link to tracking issue Fixes ~ <!--Describe what testing was performed and which tests were added.--> #### Testing ~ <!--Describe the documentation added.--> #### Documentation Updated <!--Please delete paragraphs that you did not use before submitting.--> Signed-off-by: ChrsMark <[email protected]>
1 parent 2cecf8b commit 1d67e2f

File tree

2 files changed

+145
-87
lines changed

2 files changed

+145
-87
lines changed

‎receiver/flinkmetricsreceiver/documentation.md‎

Lines changed: 87 additions & 87 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ metrics:
1616
1717
The number of checkpoints completed or failed.
1818
19-
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
20-
| ---- | ----------- | ---------- | ----------------------- | --------- |
21-
| {checkpoints} | Sum | Int | Cumulative | true |
19+
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
20+
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
21+
| {checkpoints} | Sum | Int | Cumulative | true | development |
2222
2323
#### Attributes
2424
@@ -30,65 +30,65 @@ The number of checkpoints completed or failed.
3030
3131
The number of checkpoints in progress.
3232
33-
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
34-
| ---- | ----------- | ---------- | ----------------------- | --------- |
35-
| {checkpoints} | Sum | Int | Cumulative | false |
33+
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
34+
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
35+
| {checkpoints} | Sum | Int | Cumulative | false | development |
3636
3737
### flink.job.last_checkpoint.size
3838
3939
The total size of the last checkpoint.
4040
41-
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
42-
| ---- | ----------- | ---------- | ----------------------- | --------- |
43-
| By | Sum | Int | Cumulative | false |
41+
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
42+
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
43+
| By | Sum | Int | Cumulative | false | development |
4444
4545
### flink.job.last_checkpoint.time
4646
4747
The end to end duration of the last checkpoint.
4848
49-
| Unit | Metric Type | Value Type |
50-
| ---- | ----------- | ---------- |
51-
| ms | Gauge | Int |
49+
| Unit | Metric Type | Value Type | Stability |
50+
| ---- | ----------- | ---------- | --------- |
51+
| ms | Gauge | Int | development |
5252
5353
### flink.job.restart.count
5454
5555
The total number of restarts since this job was submitted, including full restarts and fine-grained restarts.
5656
57-
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
58-
| ---- | ----------- | ---------- | ----------------------- | --------- |
59-
| {restarts} | Sum | Int | Cumulative | true |
57+
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
58+
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
59+
| {restarts} | Sum | Int | Cumulative | true | development |
6060
6161
### flink.jvm.class_loader.classes_loaded
6262
6363
The total number of classes loaded since the start of the JVM.
6464
65-
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
66-
| ---- | ----------- | ---------- | ----------------------- | --------- |
67-
| {classes} | Sum | Int | Cumulative | true |
65+
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
66+
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
67+
| {classes} | Sum | Int | Cumulative | true | development |
6868
6969
### flink.jvm.cpu.load
7070
7171
The CPU usage of the JVM for a jobmanager or taskmanager.
7272
73-
| Unit | Metric Type | Value Type |
74-
| ---- | ----------- | ---------- |
75-
| % | Gauge | Double |
73+
| Unit | Metric Type | Value Type | Stability |
74+
| ---- | ----------- | ---------- | --------- |
75+
| % | Gauge | Double | development |
7676
7777
### flink.jvm.cpu.time
7878
7979
The CPU time used by the JVM for a jobmanager or taskmanager.
8080
81-
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
82-
| ---- | ----------- | ---------- | ----------------------- | --------- |
83-
| ns | Sum | Int | Cumulative | true |
81+
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
82+
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
83+
| ns | Sum | Int | Cumulative | true | development |
8484
8585
### flink.jvm.gc.collections.count
8686
8787
The total number of collections that have occurred.
8888
89-
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
90-
| ---- | ----------- | ---------- | ----------------------- | --------- |
91-
| {collections} | Sum | Int | Cumulative | true |
89+
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
90+
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
91+
| {collections} | Sum | Int | Cumulative | true | development |
9292
9393
#### Attributes
9494
@@ -100,9 +100,9 @@ The total number of collections that have occurred.
100100
101101
The total time spent performing garbage collection.
102102
103-
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
104-
| ---- | ----------- | ---------- | ----------------------- | --------- |
105-
| ms | Sum | Int | Cumulative | true |
103+
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
104+
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
105+
| ms | Sum | Int | Cumulative | true | development |
106106
107107
#### Attributes
108108
@@ -114,137 +114,137 @@ The total time spent performing garbage collection.
114114
115115
The total capacity of all buffers in the direct buffer pool.
116116
117-
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
118-
| ---- | ----------- | ---------- | ----------------------- | --------- |
119-
| By | Sum | Int | Cumulative | false |
117+
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
118+
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
119+
| By | Sum | Int | Cumulative | false | development |
120120
121121
### flink.jvm.memory.direct.used
122122
123123
The amount of memory used by the JVM for the direct buffer pool.
124124
125-
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
126-
| ---- | ----------- | ---------- | ----------------------- | --------- |
127-
| By | Sum | Int | Cumulative | false |
125+
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
126+
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
127+
| By | Sum | Int | Cumulative | false | development |
128128
129129
### flink.jvm.memory.heap.committed
130130
131131
The amount of heap memory guaranteed to be available to the JVM.
132132
133-
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
134-
| ---- | ----------- | ---------- | ----------------------- | --------- |
135-
| By | Sum | Int | Cumulative | false |
133+
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
134+
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
135+
| By | Sum | Int | Cumulative | false | development |
136136
137137
### flink.jvm.memory.heap.max
138138
139139
The maximum amount of heap memory that can be used for memory management.
140140
141-
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
142-
| ---- | ----------- | ---------- | ----------------------- | --------- |
143-
| By | Sum | Int | Cumulative | false |
141+
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
142+
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
143+
| By | Sum | Int | Cumulative | false | development |
144144
145145
### flink.jvm.memory.heap.used
146146
147147
The amount of heap memory currently used.
148148
149-
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
150-
| ---- | ----------- | ---------- | ----------------------- | --------- |
151-
| By | Sum | Int | Cumulative | false |
149+
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
150+
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
151+
| By | Sum | Int | Cumulative | false | development |
152152
153153
### flink.jvm.memory.mapped.total_capacity
154154
155155
The number of buffers in the mapped buffer pool.
156156
157-
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
158-
| ---- | ----------- | ---------- | ----------------------- | --------- |
159-
| By | Sum | Int | Cumulative | false |
157+
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
158+
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
159+
| By | Sum | Int | Cumulative | false | development |
160160
161161
### flink.jvm.memory.mapped.used
162162
163163
The amount of memory used by the JVM for the mapped buffer pool.
164164
165-
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
166-
| ---- | ----------- | ---------- | ----------------------- | --------- |
167-
| By | Sum | Int | Cumulative | false |
165+
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
166+
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
167+
| By | Sum | Int | Cumulative | false | development |
168168
169169
### flink.jvm.memory.metaspace.committed
170170
171171
The amount of memory guaranteed to be available to the JVM in the Metaspace memory pool.
172172
173-
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
174-
| ---- | ----------- | ---------- | ----------------------- | --------- |
175-
| By | Sum | Int | Cumulative | false |
173+
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
174+
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
175+
| By | Sum | Int | Cumulative | false | development |
176176
177177
### flink.jvm.memory.metaspace.max
178178
179179
The maximum amount of memory that can be used in the Metaspace memory pool.
180180
181-
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
182-
| ---- | ----------- | ---------- | ----------------------- | --------- |
183-
| By | Sum | Int | Cumulative | false |
181+
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
182+
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
183+
| By | Sum | Int | Cumulative | false | development |
184184
185185
### flink.jvm.memory.metaspace.used
186186
187187
The amount of memory currently used in the Metaspace memory pool.
188188
189-
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
190-
| ---- | ----------- | ---------- | ----------------------- | --------- |
191-
| By | Sum | Int | Cumulative | false |
189+
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
190+
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
191+
| By | Sum | Int | Cumulative | false | development |
192192
193193
### flink.jvm.memory.nonheap.committed
194194
195195
The amount of non-heap memory guaranteed to be available to the JVM.
196196
197-
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
198-
| ---- | ----------- | ---------- | ----------------------- | --------- |
199-
| By | Sum | Int | Cumulative | false |
197+
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
198+
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
199+
| By | Sum | Int | Cumulative | false | development |
200200
201201
### flink.jvm.memory.nonheap.max
202202
203203
The maximum amount of non-heap memory that can be used for memory management.
204204
205-
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
206-
| ---- | ----------- | ---------- | ----------------------- | --------- |
207-
| By | Sum | Int | Cumulative | false |
205+
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
206+
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
207+
| By | Sum | Int | Cumulative | false | development |
208208
209209
### flink.jvm.memory.nonheap.used
210210
211211
The amount of non-heap memory currently used.
212212
213-
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
214-
| ---- | ----------- | ---------- | ----------------------- | --------- |
215-
| By | Sum | Int | Cumulative | false |
213+
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
214+
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
215+
| By | Sum | Int | Cumulative | false | development |
216216
217217
### flink.jvm.threads.count
218218
219219
The total number of live threads.
220220
221-
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
222-
| ---- | ----------- | ---------- | ----------------------- | --------- |
223-
| {threads} | Sum | Int | Cumulative | false |
221+
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
222+
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
223+
| {threads} | Sum | Int | Cumulative | false | development |
224224
225225
### flink.memory.managed.total
226226
227227
The total amount of managed memory.
228228
229-
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
230-
| ---- | ----------- | ---------- | ----------------------- | --------- |
231-
| By | Sum | Int | Cumulative | false |
229+
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
230+
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
231+
| By | Sum | Int | Cumulative | false | development |
232232
233233
### flink.memory.managed.used
234234
235235
The amount of managed memory currently used.
236236
237-
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
238-
| ---- | ----------- | ---------- | ----------------------- | --------- |
239-
| By | Sum | Int | Cumulative | false |
237+
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
238+
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
239+
| By | Sum | Int | Cumulative | false | development |
240240
241241
### flink.operator.record.count
242242
243243
The number of records an operator has.
244244
245-
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
246-
| ---- | ----------- | ---------- | ----------------------- | --------- |
247-
| {records} | Sum | Int | Cumulative | true |
245+
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
246+
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
247+
| {records} | Sum | Int | Cumulative | true | development |
248248
249249
#### Attributes
250250
@@ -257,9 +257,9 @@ The number of records an operator has.
257257
258258
The last watermark this operator has emitted.
259259
260-
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
261-
| ---- | ----------- | ---------- | ----------------------- | --------- |
262-
| ms | Sum | Int | Cumulative | false |
260+
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
261+
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
262+
| ms | Sum | Int | Cumulative | false | development |
263263
264264
#### Attributes
265265
@@ -271,9 +271,9 @@ The last watermark this operator has emitted.
271271
272272
The number of records a task has.
273273
274-
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
275-
| ---- | ----------- | ---------- | ----------------------- | --------- |
276-
| {records} | Sum | Int | Cumulative | true |
274+
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
275+
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
276+
| {records} | Sum | Int | Cumulative | true | development |
277277
278278
#### Attributes
279279

0 commit comments

Comments
 (0)