Skip to content

Commit 3b64cb3

Browse files
author
Liudmila Molkova
authored
Add metric value type everywhere (as code-generation annotation) (#2444)
1 parent 4b2c0e6 commit 3b64cb3

34 files changed

+978
-2
lines changed

.chloggen/2444.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
change_type: enhancement
2+
component: all
3+
note: Add `metric_value_type` code-generation annotation to all metric definitions.
4+
issues: [2444, 591]

model/aspnetcore/metrics.yaml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ groups:
1111
- id: metric.aspnetcore.routing.match_attempts
1212
type: metric
1313
metric_name: aspnetcore.routing.match_attempts
14+
annotations:
15+
code_generation:
16+
metric_value_type: int
1417
stability: stable
1518
brief: Number of requests that were attempted to be matched to an endpoint.
1619
instrument: counter
@@ -31,6 +34,9 @@ groups:
3134
- id: metric.aspnetcore.diagnostics.exceptions
3235
type: metric
3336
metric_name: aspnetcore.diagnostics.exceptions
37+
annotations:
38+
code_generation:
39+
metric_value_type: int
3440
stability: stable
3541
brief: Number of exceptions caught by exception handling middleware.
3642
instrument: counter
@@ -52,6 +58,9 @@ groups:
5258
- id: metric.aspnetcore.rate_limiting.active_request_leases
5359
type: metric
5460
metric_name: aspnetcore.rate_limiting.active_request_leases
61+
annotations:
62+
code_generation:
63+
metric_value_type: int
5564
stability: stable
5665
brief: Number of requests that are currently active on the server that hold a rate limiting lease.
5766
instrument: updowncounter
@@ -63,6 +72,9 @@ groups:
6372
- id: metric.aspnetcore.rate_limiting.request_lease.duration
6473
type: metric
6574
metric_name: aspnetcore.rate_limiting.request_lease.duration
75+
annotations:
76+
code_generation:
77+
metric_value_type: double
6678
stability: stable
6779
brief: The duration of rate limiting lease held by requests on the server.
6880
instrument: histogram
@@ -74,6 +86,9 @@ groups:
7486
- id: metric.aspnetcore.rate_limiting.request.time_in_queue
7587
type: metric
7688
metric_name: aspnetcore.rate_limiting.request.time_in_queue
89+
annotations:
90+
code_generation:
91+
metric_value_type: double
7792
stability: stable
7893
brief: The time the request spent in a queue waiting to acquire a rate limiting lease.
7994
instrument: histogram
@@ -88,6 +103,9 @@ groups:
88103
- id: metric.aspnetcore.rate_limiting.queued_requests
89104
type: metric
90105
metric_name: aspnetcore.rate_limiting.queued_requests
106+
annotations:
107+
code_generation:
108+
metric_value_type: int
91109
stability: stable
92110
brief: Number of requests that are currently queued, waiting to acquire a rate limiting lease.
93111
instrument: updowncounter
@@ -99,6 +117,9 @@ groups:
99117
- id: metric.aspnetcore.rate_limiting.requests
100118
type: metric
101119
metric_name: aspnetcore.rate_limiting.requests
120+
annotations:
121+
code_generation:
122+
metric_value_type: int
102123
stability: stable
103124
brief: Number of requests that tried to acquire a rate limiting lease.
104125
instrument: counter

model/azure/cosmosdb-metrics.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@ groups:
22
- id: metric.azure.cosmosdb.client.operation.request_charge
33
type: metric
44
metric_name: azure.cosmosdb.client.operation.request_charge
5+
annotations:
6+
code_generation:
7+
metric_value_type: double
58
brief: "[Request units](https://learn.microsoft.com/azure/cosmos-db/request-units) consumed by the operation"
69
instrument: histogram
710
unit: "{request_unit}"
@@ -20,6 +23,9 @@ groups:
2023
- id: metric.azure.cosmosdb.client.active_instance.count
2124
type: metric
2225
metric_name: azure.cosmosdb.client.active_instance.count
26+
annotations:
27+
code_generation:
28+
metric_value_type: int
2329
brief: "Number of active client instances"
2430
instrument: updowncounter
2531
unit: "{instance}"

model/cicd/metrics.yaml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@ groups:
22
- id: metric.cicd.pipeline.run.duration
33
type: metric
44
metric_name: cicd.pipeline.run.duration
5+
annotations:
6+
code_generation:
7+
metric_value_type: double
58
brief: 'Duration of a pipeline run grouped by pipeline, state and result.'
69
instrument: histogram
710
unit: "s"
@@ -22,6 +25,9 @@ groups:
2225
- id: metric.cicd.pipeline.run.active
2326
type: metric
2427
metric_name: cicd.pipeline.run.active
28+
annotations:
29+
code_generation:
30+
metric_value_type: int
2531
brief: 'The number of pipeline runs currently active in the system by state.'
2632
instrument: updowncounter
2733
unit: "{run}"
@@ -36,6 +42,9 @@ groups:
3642
- id: metric.cicd.worker.count
3743
type: metric
3844
metric_name: cicd.worker.count
45+
annotations:
46+
code_generation:
47+
metric_value_type: int
3948
brief: 'The number of workers on the CICD system by state.'
4049
instrument: updowncounter
4150
unit: "{count}"
@@ -46,6 +55,9 @@ groups:
4655
- id: metric.cicd.pipeline.run.errors
4756
type: metric
4857
metric_name: cicd.pipeline.run.errors
58+
annotations:
59+
code_generation:
60+
metric_value_type: int
4961
brief: 'The number of errors encountered in pipeline runs (eg. compile, test failures).'
5062
note: |
5163
There might be errors in a pipeline run that are non fatal (eg. they are suppressed) or in a parallel stage multiple stages could have a fatal error.
@@ -63,6 +75,9 @@ groups:
6375
- id: metric.cicd.system.errors
6476
type: metric
6577
metric_name: cicd.system.errors
78+
annotations:
79+
code_generation:
80+
metric_value_type: int
6681
brief: 'The number of errors in a component of the CICD system (eg. controller, scheduler, agent).'
6782
note: 'Errors in pipeline run execution are explicitly excluded. Ie a test failure is not counted in this metric.'
6883
instrument: counter

model/container/metrics.yaml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ groups:
33
- id: metric.container.uptime
44
type: metric
55
metric_name: container.uptime
6+
annotations:
7+
code_generation:
8+
metric_value_type: double
69
stability: development
710
brief: "The time the container has been running"
811
note: |
@@ -14,6 +17,9 @@ groups:
1417
- id: metric.container.cpu.time
1518
type: metric
1619
metric_name: container.cpu.time
20+
annotations:
21+
code_generation:
22+
metric_value_type: double
1723
stability: development
1824
brief: "Total CPU time consumed"
1925
note: >
@@ -30,6 +36,9 @@ groups:
3036
- id: metric.container.cpu.usage
3137
type: metric
3238
metric_name: container.cpu.usage
39+
annotations:
40+
code_generation:
41+
metric_value_type: double
3342
stability: development
3443
brief: "Container's CPU usage, measured in cpus. Range from 0 to the number of allocatable CPUs"
3544
note: >
@@ -47,6 +56,9 @@ groups:
4756
- id: metric.container.memory.usage
4857
type: metric
4958
metric_name: container.memory.usage
59+
annotations:
60+
code_generation:
61+
metric_value_type: int
5062
stability: development
5163
brief: "Memory usage of the container."
5264
note: >
@@ -58,6 +70,9 @@ groups:
5870
- id: metric.container.disk.io
5971
type: metric
6072
metric_name: container.disk.io
73+
annotations:
74+
code_generation:
75+
metric_value_type: int
6176
stability: development
6277
brief: "Disk bytes for the container."
6378
note: >
@@ -73,6 +88,9 @@ groups:
7388
- id: metric.container.network.io
7489
type: metric
7590
metric_name: container.network.io
91+
annotations:
92+
code_generation:
93+
metric_value_type: int
7694
stability: development
7795
brief: "Network bytes for the container."
7896
note: >

model/cpu/deprecated.yaml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@ groups:
22
- id: metric.cpu.time
33
type: metric
44
metric_name: cpu.time
5+
annotations:
6+
code_generation:
7+
metric_value_type: double
58
brief: "Deprecated. Use `system.cpu.time` instead."
69
deprecated:
710
reason: renamed
@@ -17,6 +20,9 @@ groups:
1720
- id: metric.cpu.utilization
1821
type: metric
1922
metric_name: cpu.utilization
23+
annotations:
24+
code_generation:
25+
metric_value_type: double
2026
brief: "Deprecated. Use `system.cpu.utilization` instead."
2127
deprecated:
2228
reason: renamed
@@ -32,6 +38,9 @@ groups:
3238
- id: metric.cpu.frequency
3339
type: metric
3440
metric_name: cpu.frequency
41+
annotations:
42+
code_generation:
43+
metric_value_type: int
3544
brief: "Deprecated. Use `system.cpu.frequency` instead."
3645
deprecated:
3746
reason: renamed

model/cpython/metrics.yaml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@ groups:
22
- id: metric.cpython.gc.collections
33
type: metric
44
metric_name: cpython.gc.collections
5+
annotations:
6+
code_generation:
7+
metric_value_type: int
58
brief: "The number of times a generation was collected since interpreter start."
69
note: >
710
This metric reports data from [`gc.stats()`](https://docs.python.org/3/library/gc.html#gc.get_stats).
@@ -15,6 +18,9 @@ groups:
1518
- id: metric.cpython.gc.collected_objects
1619
type: metric
1720
metric_name: cpython.gc.collected_objects
21+
annotations:
22+
code_generation:
23+
metric_value_type: int
1824
brief: "The total number of objects collected inside a generation since interpreter start."
1925
note: >
2026
This metric reports data from [`gc.stats()`](https://docs.python.org/3/library/gc.html#gc.get_stats).
@@ -28,6 +34,9 @@ groups:
2834
- id: metric.cpython.gc.uncollectable_objects
2935
type: metric
3036
metric_name: cpython.gc.uncollectable_objects
37+
annotations:
38+
code_generation:
39+
metric_value_type: int
3140
brief: "The total number of objects which were found to be uncollectable inside a generation since interpreter start."
3241
note: >
3342
This metric reports data from [`gc.stats()`](https://docs.python.org/3/library/gc.html#gc.get_stats).

model/database/deprecated/metrics-deprecated.yaml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@ groups:
22
- id: metric.db.client.connections.usage
33
type: metric
44
metric_name: db.client.connections.usage
5+
annotations:
6+
code_generation:
7+
metric_value_type: int
58
stability: development
69
deprecated:
710
reason: renamed
@@ -18,6 +21,9 @@ groups:
1821
- id: metric.db.client.connections.idle.max
1922
type: metric
2023
metric_name: db.client.connections.idle.max
24+
annotations:
25+
code_generation:
26+
metric_value_type: int
2127
stability: development
2228
deprecated:
2329
reason: renamed
@@ -32,6 +38,9 @@ groups:
3238
- id: metric.db.client.connections.idle.min
3339
type: metric
3440
metric_name: db.client.connections.idle.min
41+
annotations:
42+
code_generation:
43+
metric_value_type: int
3544
stability: development
3645
deprecated:
3746
reason: renamed
@@ -46,6 +55,9 @@ groups:
4655
- id: metric.db.client.connections.max
4756
type: metric
4857
metric_name: db.client.connections.max
58+
annotations:
59+
code_generation:
60+
metric_value_type: int
4961
stability: development
5062
deprecated:
5163
reason: renamed
@@ -60,6 +72,9 @@ groups:
6072
- id: metric.db.client.connections.pending_requests
6173
type: metric
6274
metric_name: db.client.connections.pending_requests
75+
annotations:
76+
code_generation:
77+
metric_value_type: int
6378
stability: development
6479
deprecated:
6580
reason: renamed
@@ -74,6 +89,9 @@ groups:
7489
- id: metric.db.client.connections.timeouts
7590
type: metric
7691
metric_name: db.client.connections.timeouts
92+
annotations:
93+
code_generation:
94+
metric_value_type: int
7795
stability: development
7896
deprecated:
7997
reason: renamed
@@ -88,6 +106,9 @@ groups:
88106
- id: metric.db.client.connections.create_time
89107
type: metric
90108
metric_name: db.client.connections.create_time
109+
annotations:
110+
code_generation:
111+
metric_value_type: double
91112
stability: development
92113
deprecated:
93114
reason: uncategorized
@@ -102,6 +123,9 @@ groups:
102123
- id: metric.db.client.connections.wait_time
103124
type: metric
104125
metric_name: db.client.connections.wait_time
126+
annotations:
127+
code_generation:
128+
metric_value_type: double
105129
stability: development
106130
deprecated:
107131
reason: uncategorized
@@ -116,6 +140,9 @@ groups:
116140
- id: metric.db.client.connections.use_time
117141
type: metric
118142
metric_name: db.client.connections.use_time
143+
annotations:
144+
code_generation:
145+
metric_value_type: double
119146
stability: development
120147
deprecated:
121148
reason: uncategorized
@@ -130,6 +157,9 @@ groups:
130157
- id: metric.db.client.cosmosdb.operation.request_charge
131158
type: metric
132159
metric_name: db.client.cosmosdb.operation.request_charge
160+
annotations:
161+
code_generation:
162+
metric_value_type: double
133163
brief: "Deprecated, use `azure.cosmosdb.client.operation.request_charge` instead."
134164
deprecated:
135165
reason: renamed
@@ -165,6 +195,9 @@ groups:
165195
- id: metric.db.client.cosmosdb.active_instance.count
166196
type: metric
167197
metric_name: db.client.cosmosdb.active_instance.count
198+
annotations:
199+
code_generation:
200+
metric_value_type: int
168201
brief: "Deprecated, use `azure.cosmosdb.client.active_instance.count` instead."
169202
deprecated:
170203
reason: renamed

0 commit comments

Comments
 (0)