| 1 | <!--startmeta |
| 2 | custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/integrations/active_directory.md" |
| 3 | meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/metadata.yaml" |
| 4 | sidebar_label: "Active Directory" |
| 5 | learn_status: "Published" |
| 6 | learn_rel_path: "Collecting Metrics/Collectors/Applications" |
| 7 | keywords: ['windows', 'microsoft', 'active directory', 'ad'] |
| 8 | message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE" |
| 9 | endmeta--> |
| 10 | |
| 11 | # Active Directory |
| 12 | |
| 13 | |
| 14 | <img src="https://netdata.cloud/img/windows.svg" width="150"/> |
| 15 | |
| 16 | |
| 17 | Plugin: windows.plugin |
| 18 | Module: PerflibAD |
| 19 | |
| 20 | <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> |
| 21 | |
| 22 | ## Overview |
| 23 | |
| 24 | This collector monitors Active Directory directory operations, replication, LDAP activity, binds, queueing, database, cleanup, security descriptor propagation, and SAM metrics. |
| 25 | |
| 26 | |
| 27 | It queries DirectoryServices object from Perflib in order to gather the metrics. |
| 28 | |
| 29 | |
| 30 | This collector is only supported on the following platforms: |
| 31 | |
| 32 | - windows |
| 33 | |
| 34 | This collector only supports collecting metrics from a single instance of this integration. |
| 35 | |
| 36 | |
| 37 | ### Default Behavior |
| 38 | |
| 39 | #### Auto-Detection |
| 40 | |
| 41 | The collector automatically detects all of the metrics, no further configuration is required. |
| 42 | |
| 43 | |
| 44 | #### Limits |
| 45 | |
| 46 | The default configuration for this integration does not impose any limits on data collection. |
| 47 | |
| 48 | #### Performance Impact |
| 49 | |
| 50 | The default configuration for this integration is not expected to impose a significant performance impact on the system. |
| 51 | |
| 52 | ## Setup |
| 53 | |
| 54 | |
| 55 | ### Prerequisites |
| 56 | |
| 57 | No action required. |
| 58 | |
| 59 | ### Configuration |
| 60 | |
| 61 | #### Options |
| 62 | |
| 63 | |
| 64 | |
| 65 | |
| 66 | |
| 67 | | Option | Description | Default | Required | |
| 68 | |:-----|:------------|:--------|:---------:| |
| 69 | | update every | Data collection frequency. | 10 | no | |
| 70 | |
| 71 | |
| 72 | |
| 73 | |
| 74 | #### via File |
| 75 | |
| 76 | The configuration file name for this integration is `netdata.conf`. |
| 77 | Configuration for this specific integration is located in the `[plugin:windows:PerflibAD]` section within that file. |
| 78 | |
| 79 | The file format is a modified INI syntax. The general structure is: |
| 80 | |
| 81 | ```ini |
| 82 | [section1] |
| 83 | option1 = some value |
| 84 | option2 = some other value |
| 85 | |
| 86 | [section2] |
| 87 | option3 = some third value |
| 88 | ``` |
| 89 | You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-configuration-files) script from the |
| 90 | Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#locate-your-config-directory). |
| 91 | |
| 92 | ```bash |
| 93 | cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata |
| 94 | sudo ./edit-config netdata.conf |
| 95 | ``` |
| 96 | |
| 97 | ##### Examples |
| 98 | There are no configuration examples. |
| 99 | |
| 100 | |
| 101 | |
| 102 | ## Alerts |
| 103 | |
| 104 | There are no alerts configured by default for this integration. |
| 105 | |
| 106 | |
| 107 | ## Metrics |
| 108 | |
| 109 | Metrics grouped by *scope*. |
| 110 | |
| 111 | The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels. |
| 112 | |
| 113 | |
| 114 | |
| 115 | ### Per Active Directory |
| 116 | |
| 117 | These metrics refer to Active Directory. |
| 118 | |
| 119 | This scope has no labels. |
| 120 | |
| 121 | Metrics: |
| 122 | |
| 123 | | Metric | Dimensions | Unit | |
| 124 | |:------|:----------|:----| |
| 125 | | ad.address_book_ambiguous_name_resolution | ambiguous_name_resolution | operations/s | |
| 126 | | ad.address_book_browse | browse | operations/s | |
| 127 | | ad.address_book_find | find | operations/s | |
| 128 | | ad.address_book_property_read | property_read | operations/s | |
| 129 | | ad.address_book_search | search | operations/s | |
| 130 | | ad.address_book_proxy_search | proxy_search | operations/s | |
| 131 | | ad.address_book_client_sessions | sessions | sessions | |
| 132 | | ad.approximate_highest_dnt | dnt | dnt | |
| 133 | | ad.directory_operations | read, write, search | operations/s | |
| 134 | | ad.searches_base | base | searches/s | |
| 135 | | ad.searches_subtree | subtree | searches/s | |
| 136 | | ad.searches_one_level | one_level | searches/s | |
| 137 | | ad.name_cache_lookups | lookups | lookups/s | |
| 138 | | ad.name_cache_hits | hits | hits/s | |
| 139 | | ad.ldap_searches | searches | searches/s | |
| 140 | | ad.dra_replication_properties_updated | inbound | properties/s | |
| 141 | | ad.dra_replication_properties_filtered | inbound | properties/s | |
| 142 | | ad.dra_replication_intersite_compressed_traffic | inbound, outbound | bytes/s | |
| 143 | | ad.dra_replication_intrasite_uncompressed_traffic | inbound, outbound | bytes/s | |
| 144 | | ad.replication_highest_usn_committed | committed | usn/s | |
| 145 | | ad.replication_highest_usn_issued | issued | usn/s | |
| 146 | | ad.replication_inbound_sync_objects_remaining | remaining | objects | |
| 147 | | ad.replication_inbound_link_value_updates_remaining | remaining | updates | |
| 148 | | ad.replication_inbound_objects_updated | updated | objects/s | |
| 149 | | ad.replication_inbound_objects_filtered | filtered | objects/s | |
| 150 | | ad.dra_replication_pending_syncs | pending | syncs | |
| 151 | | ad.dra_replication_sync_requests | request | requests/s | |
| 152 | | ad.replication_pending_operations | pending | operations | |
| 153 | | ad.replication_sync_requests_success | success | requests/s | |
| 154 | | ad.replication_sync_requests_schema_mismatch_failure | failure | requests/s | |
| 155 | | ad.name_translations_client | client | translations/s | |
| 156 | | ad.name_translations_server | server | translations/s | |
| 157 | | ad.change_monitors_registered | registered | monitors | |
| 158 | | ad.change_monitor_updates_pending | pending | updates | |
| 159 | | ad.directory_search_suboperations | suboperations | operations/s | |
| 160 | | ad.security_descriptor_propagation_events | events | events/s | |
| 161 | | ad.security_descriptor_propagation_events_queued | queued | events | |
| 162 | | ad.security_descriptor_propagation_access_wait | wait | seconds | |
| 163 | | ad.security_descriptor_propagation_items_queued | queued | items | |
| 164 | | ad.ds_threads | thread | threads | |
| 165 | | ad.ldap_last_bind_time | last_bind | seconds | |
| 166 | | ad.binds_digest | digest | binds/s | |
| 167 | | ad.binds_ds_client | ds_client | binds/s | |
| 168 | | ad.binds_ds_server | ds_server | binds/s | |
| 169 | | ad.binds_external | external | binds/s | |
| 170 | | ad.binds_fast | fast | binds/s | |
| 171 | | ad.binds_negotiate | negotiate | binds/s | |
| 172 | | ad.binds_ntlm | ntlm | binds/s | |
| 173 | | ad.binds_simple | simple | binds/s | |
| 174 | | ad.binds_ldap | ldap | binds/s | |
| 175 | | ad.ldap_closed_connections | closed | connections/s | |
| 176 | | ad.ldap_opened_connections_ldap | ldap | connections/s | |
| 177 | | ad.ldap_opened_connections_ldaps | ldaps | connections/s | |
| 178 | | ad.ldap_active_threads | active | threads | |
| 179 | | ad.ldap_udp_operations | udp | operations/s | |
| 180 | | ad.ldap_writes | writes | writes/s | |
| 181 | | ad.ldap_client_sessions | sessions | sessions | |
| 182 | | ad.atq_outstanding_requests | outstanding | requests | |
| 183 | | ad.atq_estimated_delay | delay | seconds | |
| 184 | | ad.atq_average_request_latency | time | seconds | |
| 185 | | ad.atq_current_threads_ldap | ldap | threads | |
| 186 | | ad.atq_current_threads_other | other | threads | |
| 187 | | ad.atq_current_threads_total | total | threads | |
| 188 | | ad.database_operations | add, delete, modify, recycle | operations/s | |
| 189 | | ad.directory_reads | read | reads/s | |
| 190 | | ad.directory_searches | search | searches/s | |
| 191 | | ad.directory_writes | write | writes/s | |
| 192 | | ad.replication_inbound_object_updates_remaining | remaining | updates | |
| 193 | | ad.replication_inbound_values_dns_only | dns_only | values/s | |
| 194 | | ad.replication_inbound_values_total | total | values/s | |
| 195 | | ad.replication_outbound_objects_filtered | filtered | objects/s | |
| 196 | | ad.replication_outbound_objects | objects | objects/s | |
| 197 | | ad.replication_outbound_properties | properties | properties/s | |
| 198 | | ad.replication_outbound_values_dns_only | dns_only | values/s | |
| 199 | | ad.replication_outbound_values_total | total | values/s | |
| 200 | | ad.replication_threads_getting_nc_changes | threads | threads | |
| 201 | | ad.replication_threads_getting_nc_changes_holding_semaphore | threads | threads | |
| 202 | | ad.transitive_operations | operations | operations/s | |
| 203 | | ad.transitive_suboperations | suboperations | suboperations/s | |
| 204 | | ad.replication_inbound_bytes_total | inbound | bytes/s | |
| 205 | | ad.replication_outbound_bytes_total | outbound | bytes/s | |
| 206 | | ad.link_values_cleaned | cleaned | values/s | |
| 207 | | ad.phantom_objects_cleaned | cleaned | objects/s | |
| 208 | | ad.phantom_objects_visited | visited | objects/s | |
| 209 | | ad.tombstoned_objects_collected | collected | objects/s | |
| 210 | | ad.tombstoned_objects_visited | visited | objects/s | |
| 211 | | ad.sam_group_membership_evaluations | global, domain_local, universal | evaluations/s | |
| 212 | | ad.sam_group_membership_global_catalog_evaluations | global_catalog | evaluations/s | |
| 213 | | ad.sam_group_membership_evaluations_nontransitive | nontransitive | evaluations/s | |
| 214 | | ad.sam_group_membership_evaluations_transitive | transitive | evaluations/s | |
| 215 | | ad.sam_group_evaluation_latency | account_group, resource_group | latency | |
| 216 | | ad.sam_computer_creation_requests | request | requests/s | |
| 217 | | ad.sam_computer_creation_successful_requests | success | requests/s | |
| 218 | | ad.sam_user_creation_requests | request | requests/s | |
| 219 | | ad.sam_user_creation_successful_requests | success | requests/s | |
| 220 | | ad.sam_query_display_requests | query | requests/s | |
| 221 | | ad.sam_enumerations | enumeration | enumerations/s | |
| 222 | | ad.sam_membership_changes | change | changes/s | |
| 223 | | ad.sam_password_changes | change | changes/s | |
| 224 | |
| 225 |