New announcements for Serverless, Network, RUM, and more from Dash! New announcements from Dash!

Active Directory

Agent Check Agent Check

Supported OS: Windows

Overview

Get metrics and logs from Microsoft Active Directory to visualize and monitor its performances.

Setup

Installation

The Agent’s Active Directory check is included in the Datadog Agent package, so you don’t need to install anything else on your servers.

Configuration

  1. Edit the active_directory.d/conf.yaml file, in the conf.d/ folder at the root of your Agent’s configuration directory to start collecting your Active Directory performance data.

Metric collection

The default setup should already collect metrics for the localhost. See the sample active_directory.d/conf.yaml for all available configuration options.

  1. Restart the Agent

Log collection

Available for Agent >6.0

  1. Collecting logs is disabled by default in the Datadog Agent, you need to enable it in datadog.yaml:

      logs_enabled: true
  2. Add this configuration block to your active_directory.d/conf.yaml file to start collecting your Active Directory Logs:

      logs:
        - type: file
          path: /path/to/my/directory/file.log
          source: ruby
          service: <MY_SERVICE>
    

    Change the path and service parameter values and configure them for your environment. See the sample active_directory.d/conf.yaml for all available configuration options.

  3. This integration is intended for the Active Directory Module for Ruby. If you are not using the Ruby module, change the below source value to active_directory and configure the path for your environment.

  4. Restart the Agent.

Validation

Run the Agent’s status subcommand and look for active_directory under the Checks section.

Data Collected

Metrics

active_directory.dra.inbound.bytes.after_compression
(gauge)
The compressed size (in bytes) of compressed replication data inbound from directory system agents (DSAs) in other sites (per second).
Shown as byte
active_directory.dra.inbound.bytes.before_compression
(gauge)
The uncompressed size (in bytes) of compressed replication data inbound from DSAs in other sites (per second).
Shown as byte
active_directory.dra.inbound.bytes.not_compressed
(gauge)
The uncompressed size (in bytes) of replication data that was not compressed at the source — that is, inbound from other DSAs in the same site (per second).
Shown as byte
active_directory.dra.inbound.bytes.total
(gauge)
The total number of bytes (per second) received through replication. It is the sum of the number of bytes of uncompressed data (never compressed) and compressed data (after compression).
Shown as byte
active_directory.dra.inbound.objects.remaining
(gauge)
The number of objects remaining until the full synchronization process is completed.
Shown as object
active_directory.dra.inbound.objects.persec
(gauge)
The number of objects received (per second) through inbound replication from replication partners.
Shown as object
active_directory.dra.inbound.objects.applied_persec
(gauge)
The number of objects received (per second) from replication partners and applied by the local directory service. This counter excludes changes that are received but not applied (for example, when the update is already made). This counter indicates how many replication updates are occurring on the server as a result of changes generated on other servers.
Shown as object
active_directory.dra.inbound.objects.filtered_persec
(gauge)
The number of objects received (per second) from replication partners that contained no updates that needed to be applied.
Shown as object
active_directory.dra.inbound.objects.remaining_in_packet
(gauge)
The number of object updates received in the current directory replication update packet that have not yet been applied to the local server. This counter tells you whether the monitored server is receiving changes, but is taking a long time applying them to the database.
Shown as object
active_directory.dra.inbound.properties.applied_persec
(gauge)
The number of changes (per second) to object properties that are applied through inbound replication as a result of reconciliation logic.
active_directory.dra.inbound.properties.filtered_persec
(gauge)
The number of changes (per second) to object properties received during the replication that are already made.
active_directory.dra.inbound.properties.total_persec
(gauge)
The total number of changes (per second) to object properties received from replication partners.
active_directory.dra.inbound.values.dns_persec
(gauge)
The number of values of object properties received (per second) from replication partners in which the values are for object properties that belong to distinguished names. This number includes objects that reference other objects. A high number from this counter might explain why inbound changes are slow to be applied to the database.
active_directory.dra.inbound.values.total_persec
(gauge)
The total number of values of object properties received (per second) from replication partners. Each inbound object has one or more properties, and each property has zero or more values. A value of zero indicates that the property is to be removed.
active_directory.dra.outbound.bytes.after_compression
(gauge)
The compressed size (in bytes) of compressed replication data that is outbound to DSAs in other sites (per second).
Shown as byte
active_directory.dra.outbound.bytes.before_compression
(gauge)
The uncompressed size (in bytes) of compressed replication data outbound to DSAs in other sites (per second).
Shown as byte
active_directory.dra.outbound.bytes.not_compressed
(gauge)
The uncompressed size (in bytes) of outbound replication data that was not compressed — that is, outbound to DSAs in the same site — per second.
Shown as byte
active_directory.dra.outbound.bytes.total
(gauge)
The total number of bytes sent per second. It is the sum of the number of bytes of uncompressed data (never compressed) and compressed data (after compression).
Shown as byte
active_directory.dra.outbound.objects.filtered_persec
(gauge)
The number of objects (per second) acknowledged by outbound replication partners that required no updates. This counter includes objects that the outbound partner did not already have.
Shown as object
active_directory.dra.outbound.objects.persec
(gauge)
The number of objects sent (per second) though outbound replication to replication partners.
Shown as object
active_directory.dra.outbound.properties.persec
(gauge)
The number of properties sent per second. This counter tells you whether a source server is returning objects or not. Sometimes, the server might stop working correctly and not return objects quickly or at all.
active_directory.dra.outbound.values.dns_persec
(gauge)
The number values of object properties sent (per second), to replication partners in which the values are for object properties that belong to distinguished names.
active_directory.dra.outbound.values.total_persec
(gauge)
The total number of values of object properties sent (per second), to replication partners.
active_directory.dra.replication.pending_synchronizations
(gauge)
The number of directory synchronizations that are queued for this server that are not yet processed. This counter helps in determining replication backlog — the larger the number, the larger the backlog.
active_directory.dra.sync_requests_made
(gauge)
The number of synchronization requests made to replication partners since computer was last restarted.
Shown as request
active_directory.ds.threads_in_use
(gauge)
The current number of threads in use by the directory service (different from the number of threads in the directory service process). This counter represents the number of threads currently servicing API calls by clients, and you can use it to determine whether additional CPUs would be beneficial.
Shown as thread
active_directory.ldap.client_sessions
(gauge)
The number of sessions of connected LDAP clients.
Shown as session
active_directory.ldap.bind_time
(gauge)
The time (in milliseconds) required for the completion of the last successful LDAP binding.
Shown as millisecond
active_directory.ldap.successful_binds_persec
(gauge)
The number LDAP bindings (per second) that occurred successfully.
active_directory.ldap.searches_persec
(gauge)
The number of search operations per second performed by LDAP clients.

Events

The Active Directory check does not include any events.

Service Checks

The Active Directory check does not include any service checks.

Troubleshooting

Need help? Contact Datadog support.


Mistake in the docs? Feel free to contribute!