1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
|
# Copyright The OpenTelemetry Authors
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from typing import (
Callable,
Final,
Generator,
Iterable,
Optional,
Sequence,
Union,
)
from opentelemetry.metrics import (
CallbackOptions,
Meter,
ObservableGauge,
Observation,
UpDownCounter,
)
# pylint: disable=invalid-name
CallbackT = Union[
Callable[[CallbackOptions], Iterable[Observation]],
Generator[Iterable[Observation], CallbackOptions, None],
]
VCS_CHANGE_COUNT: Final = "vcs.change.count"
"""
The number of changes (pull requests/merge requests/changelists) in a repository, categorized by their state (e.g. open or merged)
Instrument: updowncounter
Unit: {change}
"""
def create_vcs_change_count(meter: Meter) -> UpDownCounter:
"""The number of changes (pull requests/merge requests/changelists) in a repository, categorized by their state (e.g. open or merged)"""
return meter.create_up_down_counter(
name=VCS_CHANGE_COUNT,
description="The number of changes (pull requests/merge requests/changelists) in a repository, categorized by their state (e.g. open or merged)",
unit="{change}",
)
VCS_CHANGE_DURATION: Final = "vcs.change.duration"
"""
The time duration a change (pull request/merge request/changelist) has been in a given state
Instrument: gauge
Unit: s
"""
def create_vcs_change_duration(
meter: Meter, callbacks: Optional[Sequence[CallbackT]]
) -> ObservableGauge:
"""The time duration a change (pull request/merge request/changelist) has been in a given state"""
return meter.create_observable_gauge(
name=VCS_CHANGE_DURATION,
callbacks=callbacks,
description="The time duration a change (pull request/merge request/changelist) has been in a given state.",
unit="s",
)
VCS_CHANGE_TIME_TO_APPROVAL: Final = "vcs.change.time_to_approval"
"""
The amount of time since its creation it took a change (pull request/merge request/changelist) to get the first approval
Instrument: gauge
Unit: s
"""
def create_vcs_change_time_to_approval(
meter: Meter, callbacks: Optional[Sequence[CallbackT]]
) -> ObservableGauge:
"""The amount of time since its creation it took a change (pull request/merge request/changelist) to get the first approval"""
return meter.create_observable_gauge(
name=VCS_CHANGE_TIME_TO_APPROVAL,
callbacks=callbacks,
description="The amount of time since its creation it took a change (pull request/merge request/changelist) to get the first approval.",
unit="s",
)
VCS_CHANGE_TIME_TO_MERGE: Final = "vcs.change.time_to_merge"
"""
The amount of time since its creation it took a change (pull request/merge request/changelist) to get merged into the target(base) ref
Instrument: gauge
Unit: s
"""
def create_vcs_change_time_to_merge(
meter: Meter, callbacks: Optional[Sequence[CallbackT]]
) -> ObservableGauge:
"""The amount of time since its creation it took a change (pull request/merge request/changelist) to get merged into the target(base) ref"""
return meter.create_observable_gauge(
name=VCS_CHANGE_TIME_TO_MERGE,
callbacks=callbacks,
description="The amount of time since its creation it took a change (pull request/merge request/changelist) to get merged into the target(base) ref.",
unit="s",
)
VCS_CONTRIBUTOR_COUNT: Final = "vcs.contributor.count"
"""
The number of unique contributors to a repository
Instrument: gauge
Unit: {contributor}
"""
def create_vcs_contributor_count(
meter: Meter, callbacks: Optional[Sequence[CallbackT]]
) -> ObservableGauge:
"""The number of unique contributors to a repository"""
return meter.create_observable_gauge(
name=VCS_CONTRIBUTOR_COUNT,
callbacks=callbacks,
description="The number of unique contributors to a repository",
unit="{contributor}",
)
VCS_REF_COUNT: Final = "vcs.ref.count"
"""
The number of refs of type branch or tag in a repository
Instrument: updowncounter
Unit: {ref}
"""
def create_vcs_ref_count(meter: Meter) -> UpDownCounter:
"""The number of refs of type branch or tag in a repository"""
return meter.create_up_down_counter(
name=VCS_REF_COUNT,
description="The number of refs of type branch or tag in a repository.",
unit="{ref}",
)
VCS_REF_LINES_DELTA: Final = "vcs.ref.lines_delta"
"""
The number of lines added/removed in a ref (branch) relative to the ref from the `vcs.ref.base.name` attribute
Instrument: gauge
Unit: {line}
Note: This metric should be reported for each `vcs.line_change.type` value. For example if a ref added 3 lines and removed 2 lines,
instrumentation SHOULD report two measurements: 3 and 2 (both positive numbers).
If number of lines added/removed should be calculated from the start of time, then `vcs.ref.base.name` SHOULD be set to an empty string.
"""
def create_vcs_ref_lines_delta(
meter: Meter, callbacks: Optional[Sequence[CallbackT]]
) -> ObservableGauge:
"""The number of lines added/removed in a ref (branch) relative to the ref from the `vcs.ref.base.name` attribute"""
return meter.create_observable_gauge(
name=VCS_REF_LINES_DELTA,
callbacks=callbacks,
description="The number of lines added/removed in a ref (branch) relative to the ref from the `vcs.ref.base.name` attribute.",
unit="{line}",
)
VCS_REF_REVISIONS_DELTA: Final = "vcs.ref.revisions_delta"
"""
The number of revisions (commits) a ref (branch) is ahead/behind the branch from the `vcs.ref.base.name` attribute
Instrument: gauge
Unit: {revision}
Note: This metric should be reported for each `vcs.revision_delta.direction` value. For example if branch `a` is 3 commits behind and 2 commits ahead of `trunk`,
instrumentation SHOULD report two measurements: 3 and 2 (both positive numbers) and `vcs.ref.base.name` is set to `trunk`.
"""
def create_vcs_ref_revisions_delta(
meter: Meter, callbacks: Optional[Sequence[CallbackT]]
) -> ObservableGauge:
"""The number of revisions (commits) a ref (branch) is ahead/behind the branch from the `vcs.ref.base.name` attribute"""
return meter.create_observable_gauge(
name=VCS_REF_REVISIONS_DELTA,
callbacks=callbacks,
description="The number of revisions (commits) a ref (branch) is ahead/behind the branch from the `vcs.ref.base.name` attribute",
unit="{revision}",
)
VCS_REF_TIME: Final = "vcs.ref.time"
"""
Time a ref (branch) created from the default branch (trunk) has existed. The `ref.type` attribute will always be `branch`
Instrument: gauge
Unit: s
"""
def create_vcs_ref_time(
meter: Meter, callbacks: Optional[Sequence[CallbackT]]
) -> ObservableGauge:
"""Time a ref (branch) created from the default branch (trunk) has existed. The `ref.type` attribute will always be `branch`"""
return meter.create_observable_gauge(
name=VCS_REF_TIME,
callbacks=callbacks,
description="Time a ref (branch) created from the default branch (trunk) has existed. The `ref.type` attribute will always be `branch`",
unit="s",
)
VCS_REPOSITORY_COUNT: Final = "vcs.repository.count"
"""
The number of repositories in an organization
Instrument: updowncounter
Unit: {repository}
"""
def create_vcs_repository_count(meter: Meter) -> UpDownCounter:
"""The number of repositories in an organization"""
return meter.create_up_down_counter(
name=VCS_REPOSITORY_COUNT,
description="The number of repositories in an organization.",
unit="{repository}",
)
|
