Skip to content

Commit 8b5f202

Browse files
ChrsMarkChrsMark
authored
[chore][activedirectorydsreceiver] Add stability level per metric (#42977)
<!--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 - #35325 - #42809 <!-- Issue number (e.g. #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 <chrismarkou92@gmail.com>
1 parent baa65bd commit 8b5f202

File tree

2 files changed

+90
-54
lines changed

2 files changed

+90
-54
lines changed

‎receiver/activedirectorydsreceiver/documentation.md‎

Lines changed: 54 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ metrics:
1616
1717
The number of binds per second serviced by this domain controller.
1818
19-
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
20-
| ---- | ----------- | ---------- | ----------------------- | --------- |
21-
| {binds}/s | Sum | Double | Cumulative | false |
19+
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
20+
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
21+
| {binds}/s | Sum | Double | Cumulative | false | development |
2222
2323
#### Attributes
2424
@@ -30,57 +30,57 @@ The number of binds per second serviced by this domain controller.
3030
3131
The amount of time taken for the last successful LDAP bind.
3232
33-
| Unit | Metric Type | Value Type |
34-
| ---- | ----------- | ---------- |
35-
| ms | Gauge | Int |
33+
| Unit | Metric Type | Value Type | Stability |
34+
| ---- | ----------- | ---------- | --------- |
35+
| ms | Gauge | Int | development |
3636
3737
### active_directory.ds.ldap.bind.rate
3838
3939
The number of successful LDAP binds per second.
4040
41-
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
42-
| ---- | ----------- | ---------- | ----------------------- | --------- |
43-
| {binds}/s | Sum | Double | Cumulative | false |
41+
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
42+
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
43+
| {binds}/s | Sum | Double | Cumulative | false | development |
4444
4545
### active_directory.ds.ldap.client.session.count
4646
4747
The number of connected LDAP client sessions.
4848
49-
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
50-
| ---- | ----------- | ---------- | ----------------------- | --------- |
51-
| {sessions} | Sum | Int | Cumulative | false |
49+
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
50+
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
51+
| {sessions} | Sum | Int | Cumulative | false | development |
5252
5353
### active_directory.ds.ldap.search.rate
5454
5555
The number of LDAP searches per second.
5656
57-
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
58-
| ---- | ----------- | ---------- | ----------------------- | --------- |
59-
| {searches}/s | Sum | Double | Cumulative | false |
57+
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
58+
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
59+
| {searches}/s | Sum | Double | Cumulative | false | development |
6060
6161
### active_directory.ds.name_cache.hit_rate
6262
6363
The percentage of directory object name component lookups that are satisfied by the Directory System Agent's name cache.
6464
65-
| Unit | Metric Type | Value Type |
66-
| ---- | ----------- | ---------- |
67-
| % | Gauge | Double |
65+
| Unit | Metric Type | Value Type | Stability |
66+
| ---- | ----------- | ---------- | --------- |
67+
| % | Gauge | Double | development |
6868
6969
### active_directory.ds.notification.queued
7070
7171
The number of pending update notifications that have been queued to push to clients.
7272
73-
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
74-
| ---- | ----------- | ---------- | ----------------------- | --------- |
75-
| {notifications} | Sum | Int | Cumulative | false |
73+
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
74+
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
75+
| {notifications} | Sum | Int | Cumulative | false | development |
7676
7777
### active_directory.ds.operation.rate
7878
7979
The number of operations performed per second.
8080
81-
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
82-
| ---- | ----------- | ---------- | ----------------------- | --------- |
83-
| {operations}/s | Sum | Double | Cumulative | false |
81+
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
82+
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
83+
| {operations}/s | Sum | Double | Cumulative | false | development |
8484
8585
#### Attributes
8686
@@ -92,9 +92,9 @@ The number of operations performed per second.
9292
9393
The amount of network data transmitted by the Directory Replication Agent.
9494
95-
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
96-
| ---- | ----------- | ---------- | ----------------------- | --------- |
97-
| By | Sum | Int | Cumulative | true |
95+
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
96+
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
97+
| By | Sum | Int | Cumulative | true | development |
9898
9999
#### Attributes
100100
@@ -107,9 +107,9 @@ The amount of network data transmitted by the Directory Replication Agent.
107107
108108
The number of objects transmitted by the Directory Replication Agent per second.
109109
110-
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
111-
| ---- | ----------- | ---------- | ----------------------- | --------- |
112-
| {objects}/s | Sum | Double | Cumulative | false |
110+
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
111+
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
112+
| {objects}/s | Sum | Double | Cumulative | false | development |
113113
114114
#### Attributes
115115
@@ -121,17 +121,17 @@ The number of objects transmitted by the Directory Replication Agent per second.
121121
122122
The number of pending replication operations for the Directory Replication Agent.
123123
124-
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
125-
| ---- | ----------- | ---------- | ----------------------- | --------- |
126-
| {operations} | Sum | Int | Cumulative | false |
124+
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
125+
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
126+
| {operations} | Sum | Int | Cumulative | false | development |
127127
128128
### active_directory.ds.replication.property.rate
129129
130130
The number of properties transmitted by the Directory Replication Agent per second.
131131
132-
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
133-
| ---- | ----------- | ---------- | ----------------------- | --------- |
134-
| {properties}/s | Sum | Double | Cumulative | false |
132+
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
133+
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
134+
| {properties}/s | Sum | Double | Cumulative | false | development |
135135
136136
#### Attributes
137137
@@ -143,17 +143,17 @@ The number of properties transmitted by the Directory Replication Agent per seco
143143
144144
The number of objects remaining until the full sync completes for the Directory Replication Agent.
145145
146-
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
147-
| ---- | ----------- | ---------- | ----------------------- | --------- |
148-
| {objects} | Sum | Int | Cumulative | false |
146+
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
147+
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
148+
| {objects} | Sum | Int | Cumulative | false | development |
149149
150150
### active_directory.ds.replication.sync.request.count
151151
152152
The number of sync requests made by the Directory Replication Agent.
153153
154-
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
155-
| ---- | ----------- | ---------- | ----------------------- | --------- |
156-
| {requests} | Sum | Int | Cumulative | true |
154+
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
155+
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
156+
| {requests} | Sum | Int | Cumulative | true | development |
157157
158158
#### Attributes
159159
@@ -165,9 +165,9 @@ The number of sync requests made by the Directory Replication Agent.
165165
166166
The number of values transmitted by the Directory Replication Agent per second.
167167
168-
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
169-
| ---- | ----------- | ---------- | ----------------------- | --------- |
170-
| {values}/s | Sum | Double | Cumulative | false |
168+
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
169+
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
170+
| {values}/s | Sum | Double | Cumulative | false | development |
171171
172172
#### Attributes
173173
@@ -180,17 +180,17 @@ The number of values transmitted by the Directory Replication Agent per second.
180180
181181
The number of security descriptor propagation events that are queued for processing.
182182
183-
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
184-
| ---- | ----------- | ---------- | ----------------------- | --------- |
185-
| {events} | Sum | Int | Cumulative | false |
183+
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
184+
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
185+
| {events} | Sum | Int | Cumulative | false | development |
186186
187187
### active_directory.ds.suboperation.rate
188188
189189
The rate of sub-operations performed.
190190
191-
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
192-
| ---- | ----------- | ---------- | ----------------------- | --------- |
193-
| {suboperations}/s | Sum | Double | Cumulative | false |
191+
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
192+
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
193+
| {suboperations}/s | Sum | Double | Cumulative | false | development |
194194
195195
#### Attributes
196196
@@ -202,6 +202,6 @@ The rate of sub-operations performed.
202202
203203
The number of threads in use by the directory service.
204204
205-
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
206-
| ---- | ----------- | ---------- | ----------------------- | --------- |
207-
| {threads} | Sum | Int | Cumulative | false |
205+
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
206+
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
207+
| {threads} | Sum | Int | Cumulative | false | development |

‎receiver/activedirectorydsreceiver/metadata.yaml‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,8 @@ metrics:
7171
value_type: int
7272
attributes: [direction, network_data_type]
7373
enabled: true
74+
stability:
75+
level: development
7476
active_directory.ds.replication.sync.object.pending:
7577
description: "The number of objects remaining until the full sync completes for the Directory Replication Agent."
7678
unit: "{objects}"
@@ -79,6 +81,8 @@ metrics:
7981
aggregation_temporality: cumulative
8082
value_type: int
8183
enabled: true
84+
stability:
85+
level: development
8286
active_directory.ds.replication.sync.request.count:
8387
description: "The number of sync requests made by the Directory Replication Agent."
8488
unit: "{requests}"
@@ -88,6 +92,8 @@ metrics:
8892
value_type: int
8993
attributes: [sync_result]
9094
enabled: true
95+
stability:
96+
level: development
9197
active_directory.ds.replication.object.rate:
9298
description: "The number of objects transmitted by the Directory Replication Agent per second."
9399
unit: "{objects}/s"
@@ -97,6 +103,8 @@ metrics:
97103
value_type: double
98104
attributes: [direction]
99105
enabled: true
106+
stability:
107+
level: development
100108
active_directory.ds.replication.property.rate:
101109
description: "The number of properties transmitted by the Directory Replication Agent per second."
102110
unit: "{properties}/s"
@@ -106,6 +114,8 @@ metrics:
106114
value_type: double
107115
attributes: [direction]
108116
enabled: true
117+
stability:
118+
level: development
109119
active_directory.ds.replication.value.rate:
110120
description: "The number of values transmitted by the Directory Replication Agent per second."
111121
unit: "{values}/s"
@@ -115,6 +125,8 @@ metrics:
115125
value_type: double
116126
attributes: [direction, value_type]
117127
enabled: true
128+
stability:
129+
level: development
118130
active_directory.ds.replication.operation.pending:
119131
description: "The number of pending replication operations for the Directory Replication Agent."
120132
unit: "{operations}"
@@ -123,6 +135,8 @@ metrics:
123135
aggregation_temporality: cumulative
124136
value_type: int
125137
enabled: true
138+
stability:
139+
level: development
126140
active_directory.ds.operation.rate:
127141
description: "The number of operations performed per second."
128142
unit: "{operations}/s"
@@ -132,12 +146,16 @@ metrics:
132146
value_type: double
133147
attributes: [operation_type]
134148
enabled: true
149+
stability:
150+
level: development
135151
active_directory.ds.name_cache.hit_rate:
136152
description: "The percentage of directory object name component lookups that are satisfied by the Directory System Agent's name cache."
137153
unit: "%"
138154
gauge:
139155
value_type: double
140156
enabled: true
157+
stability:
158+
level: development
141159
active_directory.ds.notification.queued:
142160
description: "The number of pending update notifications that have been queued to push to clients."
143161
unit: "{notifications}"
@@ -146,6 +164,8 @@ metrics:
146164
aggregation_temporality: cumulative
147165
value_type: int
148166
enabled: true
167+
stability:
168+
level: development
149169
active_directory.ds.security_descriptor_propagations_event.queued:
150170
description: "The number of security descriptor propagation events that are queued for processing."
151171
unit: "{events}"
@@ -154,6 +174,8 @@ metrics:
154174
aggregation_temporality: cumulative
155175
value_type: int
156176
enabled: true
177+
stability:
178+
level: development
157179
active_directory.ds.suboperation.rate:
158180
description: "The rate of sub-operations performed."
159181
unit: "{suboperations}/s"
@@ -163,6 +185,8 @@ metrics:
163185
value_type: double
164186
attributes: [suboperation_type]
165187
enabled: true
188+
stability:
189+
level: development
166190
active_directory.ds.bind.rate:
167191
description: "The number of binds per second serviced by this domain controller."
168192
unit: "{binds}/s"
@@ -172,6 +196,8 @@ metrics:
172196
value_type: double
173197
attributes: [bind_type]
174198
enabled: true
199+
stability:
200+
level: development
175201
active_directory.ds.thread.count:
176202
description: "The number of threads in use by the directory service."
177203
unit: "{threads}"
@@ -180,6 +206,8 @@ metrics:
180206
aggregation_temporality: cumulative
181207
value_type: int
182208
enabled: true
209+
stability:
210+
level: development
183211
active_directory.ds.ldap.client.session.count:
184212
description: "The number of connected LDAP client sessions."
185213
unit: "{sessions}"
@@ -188,12 +216,16 @@ metrics:
188216
aggregation_temporality: cumulative
189217
value_type: int
190218
enabled: true
219+
stability:
220+
level: development
191221
active_directory.ds.ldap.bind.last_successful.time:
192222
description: "The amount of time taken for the last successful LDAP bind."
193223
unit: "ms"
194224
gauge:
195225
value_type: int
196226
enabled: true
227+
stability:
228+
level: development
197229
active_directory.ds.ldap.bind.rate:
198230
description: "The number of successful LDAP binds per second."
199231
unit: "{binds}/s"
@@ -202,6 +234,8 @@ metrics:
202234
aggregation_temporality: cumulative
203235
value_type: double
204236
enabled: true
237+
stability:
238+
level: development
205239
active_directory.ds.ldap.search.rate:
206240
description: "The number of LDAP searches per second."
207241
unit: "{searches}/s"
@@ -210,6 +244,8 @@ metrics:
210244
aggregation_temporality: cumulative
211245
value_type: double
212246
enabled: true
247+
stability:
248+
level: development
213249

214250
# TODO: Update the receiver to pass the tests
215251
tests:

0 commit comments

Comments
 (0)