Back to Netdata

Active Directory

src/collectors/windows.plugin/integrations/active_directory.md

2.10.33.7 KB
Original Source
<!--startmeta custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/integrations/active_directory.md" meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/windows.plugin/metadata.yaml" sidebar_label: "Active Directory" learn_status: "Published" learn_rel_path: "Collecting Metrics/Collectors/Applications" keywords: ['windows', 'microsoft', 'active directory', 'ad'] message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE" endmeta-->

Active Directory

Plugin: windows.plugin Module: PerflibAD

Overview

This collector monitors Active Directory IO and queries.

It queries DirectoryServices object from Perflib in order to gather the metrics.

This collector is only supported on the following platforms:

  • windows

This collector only supports collecting metrics from a single instance of this integration.

Default Behavior

Auto-Detection

The collector automatically detects all of the metrics, no further configuration is required.

Limits

The default configuration for this integration does not impose any limits on data collection.

Performance Impact

The default configuration for this integration is not expected to impose a significant performance impact on the system.

Setup

Prerequisites

No action required.

Configuration

Options

OptionDescriptionDefaultRequired
update everyData collection frequency.10no

via File

The configuration file name for this integration is netdata.conf. Configuration for this specific integration is located in the [plugin:windows:PerflibAD] section within that file.

The file format is a modified INI syntax. The general structure is:

ini
[section1]
    option1 = some value
    option2 = some other value

[section2]
    option3 = some third value

You can edit the configuration file using the edit-config script from the Netdata config directory.

bash
cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config netdata.conf
Examples

There are no configuration examples.

Alerts

There are no alerts configured by default for this integration.

Metrics

Metrics grouped by scope.

The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.

Per Active Directory

These metrics refer to Active Directory.

This scope has no labels.

Metrics:

MetricDimensionsUnit
ad.directory_operationsread, write, searchoperations/s
ad.name_cache_lookupslookupslookups/s
ad.dra_replication_properties_updatedinboundproperties/s
ad.dra_replication_properties_filteredinboundproperties/s
ad.dra_replication_intersite_compressed_trafficinbound, outboundbytes/s
ad.dra_replication_intrasite_compressed_trafficinbound, outboundbytes/s
ad.dra_replication_pending_syncspendingsyncs
ad.dra_replication_pending_syncspendingsyncs
ad.dra_replication_sync_requestsrequestrequests/s
ad.name_cache_hitshitshits/s
ad.ds_threadsthreadthreads
ad.ldap_last_bind_timelast_bindseconds
ad.ldap_searchessearchessearches/s
ad.atq_average_request_latencytimeseconds