1+ display_name : Active Directory Domain Services Receiver
12type : active_directory_ds
23
4+ description : |
5+ The Active Directory Domain Services Receiver scrapes metrics relating to an Active Directory domain controller using
6+ the Windows Performance Counters.
7+
38status :
49 class : receiver
510 stability :
@@ -10,31 +15,37 @@ status:
1015 seeking_new : true
1116 unsupported_platforms : [darwin, linux]
1217
18+ reaggregation_enabled : true
19+
1320attributes :
21+ bind_type :
22+ name_override : type
23+ description : The type of bind to the domain server.
24+ type : string
25+ requirement_level : recommended
26+ enum :
27+ - server
28+ - client
1429 direction :
1530 description : The direction of data flow.
1631 type : string
32+ requirement_level : recommended
1733 enum :
1834 - sent
1935 - received
2036 network_data_type :
2137 name_override : type
2238 description : The type of network data sent.
2339 type : string
40+ requirement_level : recommended
2441 enum :
2542 - compressed
2643 - uncompressed
27- value_type :
28- name_override : type
29- description : The type of value sent.
30- type : string
31- enum :
32- - distinguished_names
33- - other
3444 operation_type :
3545 name_override : type
3646 description : The type of operation.
3747 type : string
48+ requirement_level : recommended
3849 enum :
3950 - read
4051 - write
@@ -43,86 +54,88 @@ attributes:
4354 name_override : type
4455 description : The type of suboperation.
4556 type : string
57+ requirement_level : recommended
4658 enum :
4759 - security_descriptor_propagations_event
4860 - search
4961 sync_result :
5062 name_override : result
5163 description : The result status of the sync request.
5264 type : string
65+ requirement_level : recommended
5366 enum :
5467 - success
5568 - schema_mismatch
5669 - other
57- bind_type :
70+ value_type :
5871 name_override : type
59- description : The type of bind to the domain server .
72+ description : The type of value sent .
6073 type : string
74+ requirement_level : recommended
6175 enum :
62- - server
63- - client
76+ - distinguished_names
77+ - other
6478metrics :
65- active_directory.ds.replication.network.io :
66- description : " The amount of network data transmitted by the Directory Replication Agent."
67- unit : By
68- sum :
69- monotonic : true
70- aggregation_temporality : cumulative
71- value_type : int
72- attributes : [direction, network_data_type]
73- enabled : true
74- active_directory.ds.replication.sync.object.pending :
75- description : " The number of objects remaining until the full sync completes for the Directory Replication Agent."
76- unit : " {objects}"
79+ active_directory.ds.bind.rate :
80+ description : " The number of binds per second serviced by this domain controller."
81+ unit : " {binds}/s"
7782 sum :
7883 monotonic : false
7984 aggregation_temporality : cumulative
80- value_type : int
85+ value_type : double
86+ attributes : [bind_type]
8187 enabled : true
82- active_directory.ds.replication.sync.request.count :
83- description : " The number of sync requests made by the Directory Replication Agent."
84- unit : " {requests}"
85- sum :
86- monotonic : true
87- aggregation_temporality : cumulative
88+ stability : development
89+ active_directory.ds.ldap.bind.last_successful.time :
90+ description : " The amount of time taken for the last successful LDAP bind."
91+ unit : " ms"
92+ gauge :
8893 value_type : int
89- attributes : [sync_result]
9094 enabled : true
91- active_directory.ds.replication.object.rate :
92- description : " The number of objects transmitted by the Directory Replication Agent per second."
93- unit : " {objects}/s"
95+ stability : development
96+ active_directory.ds.ldap.bind.rate :
97+ description : " The number of successful LDAP binds per second."
98+ unit : " {binds}/s"
9499 sum :
95100 monotonic : false
96101 aggregation_temporality : cumulative
97102 value_type : double
98- attributes : [direction]
99103 enabled : true
100- active_directory.ds.replication.property.rate :
101- description : " The number of properties transmitted by the Directory Replication Agent per second."
102- unit : " {properties}/s"
104+ stability : development
105+ active_directory.ds.ldap.client.session.count :
106+ description : " The number of connected LDAP client sessions."
107+ unit : " {sessions}"
103108 sum :
104109 monotonic : false
105110 aggregation_temporality : cumulative
106- value_type : double
107- attributes : [direction]
111+ value_type : int
108112 enabled : true
109- active_directory.ds.replication.value.rate :
110- description : " The number of values transmitted by the Directory Replication Agent per second."
111- unit : " {values}/s"
113+ stability : development
114+ active_directory.ds.ldap.search.rate :
115+ description : " The number of LDAP searches per second."
116+ unit : " {searches}/s"
112117 sum :
113118 monotonic : false
114119 aggregation_temporality : cumulative
115120 value_type : double
116- attributes : [direction, value_type]
117121 enabled : true
118- active_directory.ds.replication.operation.pending :
119- description : " The number of pending replication operations for the Directory Replication Agent."
120- unit : " {operations}"
122+ stability : development
123+ active_directory.ds.name_cache.hit_rate :
124+ description : " The percentage of directory object name component lookups that are satisfied by the Directory System Agent's name cache."
125+ unit : " %"
126+ gauge :
127+ value_type : double
128+ enabled : true
129+ stability : development
130+ active_directory.ds.notification.queued :
131+ description : " The number of pending update notifications that have been queued to push to clients."
132+ unit : " {notifications}"
121133 sum :
122134 monotonic : false
123135 aggregation_temporality : cumulative
124136 value_type : int
125137 enabled : true
138+ stability : development
126139 active_directory.ds.operation.rate :
127140 description : " The number of operations performed per second."
128141 unit : " {operations}/s"
@@ -132,84 +145,103 @@ metrics:
132145 value_type : double
133146 attributes : [operation_type]
134147 enabled : true
135- active_directory.ds.name_cache.hit_rate :
136- description : " The percentage of directory object name component lookups that are satisfied by the Directory System Agent's name cache."
137- unit : " %"
138- gauge :
139- value_type : double
148+ stability : development
149+ active_directory.ds.replication.network.io :
150+ description : " The amount of network data transmitted by the Directory Replication Agent."
151+ unit : By
152+ sum :
153+ monotonic : true
154+ aggregation_temporality : cumulative
155+ value_type : int
156+ attributes : [direction, network_data_type]
140157 enabled : true
141- active_directory.ds.notification.queued :
142- description : " The number of pending update notifications that have been queued to push to clients."
143- unit : " {notifications}"
158+ stability : development
159+ active_directory.ds.replication.object.rate :
160+ description : " The number of objects transmitted by the Directory Replication Agent per second."
161+ unit : " {objects}/s"
144162 sum :
145163 monotonic : false
146164 aggregation_temporality : cumulative
147- value_type : int
165+ value_type : double
166+ attributes : [direction]
148167 enabled : true
149- active_directory.ds.security_descriptor_propagations_event.queued :
150- description : " The number of security descriptor propagation events that are queued for processing."
151- unit : " {events}"
168+ stability : development
169+ active_directory.ds.replication.operation.pending :
170+ description : " The number of pending replication operations for the Directory Replication Agent."
171+ unit : " {operations}"
152172 sum :
153173 monotonic : false
154174 aggregation_temporality : cumulative
155175 value_type : int
156176 enabled : true
157- active_directory.ds.suboperation.rate :
158- description : " The rate of sub-operations performed."
159- unit : " {suboperations}/s"
177+ stability : development
178+ active_directory.ds.replication.property.rate :
179+ description : " The number of properties transmitted by the Directory Replication Agent per second."
180+ unit : " {properties}/s"
160181 sum :
161182 monotonic : false
162183 aggregation_temporality : cumulative
163184 value_type : double
164- attributes : [suboperation_type ]
185+ attributes : [direction ]
165186 enabled : true
166- active_directory.ds.bind.rate :
167- description : " The number of binds per second serviced by this domain controller."
168- unit : " {binds}/s"
187+ stability : development
188+ active_directory.ds.replication.sync.object.pending :
189+ description : " The number of objects remaining until the full sync completes for the Directory Replication Agent."
190+ unit : " {objects}"
169191 sum :
170192 monotonic : false
171193 aggregation_temporality : cumulative
172- value_type : double
173- attributes : [bind_type]
194+ value_type : int
174195 enabled : true
175- active_directory.ds.thread.count :
176- description : " The number of threads in use by the directory service."
177- unit : " {threads}"
196+ stability : development
197+ active_directory.ds.replication.sync.request.count :
198+ description : " The number of sync requests made by the Directory Replication Agent."
199+ unit : " {requests}"
178200 sum :
179- monotonic : false
201+ monotonic : true
180202 aggregation_temporality : cumulative
181203 value_type : int
204+ attributes : [sync_result]
182205 enabled : true
183- active_directory.ds.ldap.client.session.count :
184- description : " The number of connected LDAP client sessions."
185- unit : " {sessions}"
206+ stability : development
207+ active_directory.ds.replication.value.rate :
208+ description : " The number of values transmitted by the Directory Replication Agent per second."
209+ unit : " {values}/s"
186210 sum :
187211 monotonic : false
188212 aggregation_temporality : cumulative
189- value_type : int
213+ value_type : double
214+ attributes : [direction, value_type]
190215 enabled : true
191- active_directory.ds.ldap.bind.last_successful.time :
192- description : " The amount of time taken for the last successful LDAP bind."
193- unit : " ms"
194- gauge :
216+ stability : development
217+ active_directory.ds.security_descriptor_propagations_event.queued :
218+ description : " The number of security descriptor propagation events that are queued for processing."
219+ unit : " {events}"
220+ sum :
221+ monotonic : false
222+ aggregation_temporality : cumulative
195223 value_type : int
196224 enabled : true
197- active_directory.ds.ldap.bind.rate :
198- description : " The number of successful LDAP binds per second."
199- unit : " {binds}/s"
225+ stability : development
226+ active_directory.ds.suboperation.rate :
227+ description : " The rate of sub-operations performed."
228+ unit : " {suboperations}/s"
200229 sum :
201230 monotonic : false
202231 aggregation_temporality : cumulative
203232 value_type : double
233+ attributes : [suboperation_type]
204234 enabled : true
205- active_directory.ds.ldap.search.rate :
206- description : " The number of LDAP searches per second."
207- unit : " {searches}/s"
235+ stability : development
236+ active_directory.ds.thread.count :
237+ description : " The number of threads in use by the directory service."
238+ unit : " {threads}"
208239 sum :
209240 monotonic : false
210241 aggregation_temporality : cumulative
211- value_type : double
242+ value_type : int
212243 enabled : true
244+ stability : development
213245
214246# TODO: Update the receiver to pass the tests
215247tests :
0 commit comments