For the complete documentation index, see llms.txt. This page is also available as Markdown.

Active Directory

The Active Directory source collects telemetry from a Microsoft Active Directory Domain Services (AD DS) domain controller. It gathers AD DS metrics from Windows performance counters (replication, LDAP, and directory service activity) and reads AD DS-related event logs for DNS Server, DFS Replication, and File Replication. This source runs only on the Windows domain controller itself.

Supported Telemetry Types

Platform
Metrics
Logs
Traces

Windows

Prerequisites

  • A Windows host that is a promoted Active Directory Domain Services domain controller. The metrics receiver reads AD DS performance counters that only exist on a domain controller.

  • The Bindplane collector must run on the domain controller. This source cannot collect AD DS data remotely.

  • The collector service account needs permission to read the relevant Windows Event Log channels (DNS Server, DFS Replication, and File Replication Service) for the log types you enable.

  • DNS Server, DFS Replication, and File Replication logs are only present when those roles or services are installed and running on the domain controller. Disable the corresponding log toggle for any role that is not installed.

For background on AD DS performance counters and monitoring, see Troubleshoot Active Directory Domain Services performance on Microsoft Learn.

Configuration

Bindplane docs - Active Directory - image 1

Telemetry

Parameter
Type
Required
Default
Description

Choose Telemetry Type

Telemetry Selector

No

Logs, Metrics

Which signals this source collects. Valid values are Logs and Metrics. Metrics parameters apply only when Metrics is selected; log parameters apply only when Logs is selected.

Logs

Parameter
Type
Required
Default
Description

DNS Server Logs

Boolean

No

true

Collect AD DS DNS Server event logs.

DFS Replication Logs

Boolean

No

true

Collect DFS Replication event logs.

File Replication Logs

Boolean

No

false

Collect File Replication Service event logs.

Advanced

Parameter
Type
Required
Default
Description

Collection Interval

Integer

No

60

How often, in seconds, to scrape metrics. Applies when Metrics is selected.

Start At

Enum

No

end

Where to begin reading logs: beginning reads existing log records, end reads only new records. Applies when Logs is selected.

Parse

Boolean

No

false

Parse the log fields into structured data. Applies when Logs is selected.

Examples

Metrics only, faster scrape

Collect AD DS performance-counter metrics every 30 seconds and skip log collection.

Logs only, DNS and DFS replication

Collect DNS Server and DFS Replication logs, leave File Replication off, and read only new records.

Configuration Tips

  • Turn off any log toggle for a role the domain controller does not run. Enabling File Replication Logs on a server using DFS Replication (the modern default) produces no records.

  • Set Start At to beginning only for a one-time backfill. Leaving it at end avoids re-ingesting historical events on every collector restart.

  • Enable Parse to get structured fields from the AD DS log records instead of a single raw message body.

Troubleshooting

No metrics appear

Symptoms: the source reports no AD DS metrics.

Solutions:

  1. Confirm the collector runs on a promoted domain controller. The active_directory_ds performance counters do not exist on member servers or non-AD hosts.

  2. Confirm Metrics is selected in Choose Telemetry Type.

No logs for an enabled type

Symptoms: a log toggle is on but no records arrive.

Solutions:

  1. Verify the corresponding role or service is installed and writing to its event channel (DNS Server, DFS Replication, or File Replication Service).

  2. Set Start At to beginning to confirm whether any historical records exist, then return it to end.

  3. Confirm the collector service account can read the relevant Windows Event Log channels.

Standalone Source

Last updated

Was this helpful?