Active Directory Domain Services receiver

The Active Directory Domain Services receiver scrapes metrics relating to an Active Directory domain controller using the Windows Performance Counters.

Note: Out-of-the-box dashboards and navigators aren't supported for the Active Directory Domain Services receiver.

Deploy the collector

See Install the Collector for Windows with the installer script.

Configure the receiver

Edit your OpenTelemetry Collector configuration file as follows.

  1. Add active_directory_ds to the receivers section of your configuration file.

    The following settings are optional:

    • collection_interval. 10s by default. Sets the interval this receiver collects metrics on.

      • This value must be a string readable by Golang's time.ParseDuration. Learn more at Go's official documentation ParseDuration function .

      • Valid time units are ns, us (or µs), ms, s, m, h

    • initial_delay. 1s by default. Determines how long this receiver waits before collecting metrics for the first time.

    Example:

    YAML 
    receivers:
      active_directory_ds:
        collection_interval: 10s

  2. Configure other settings.

  3. Include the receiver in the metrics pipeline of the service section of your configuration file:

    YAML 
    service:
      pipelines:
        metrics:
          receivers: [active_directory_ds]

Restart the collector

The restart command varies depending on what platform you deployed the collector on and what tool you used to deploy it. Here are general examples of the restart command:

Linux

Linux with installer script:

BASH 
sudo systemctl restart splunk-otel-collector
Windows

Windows with installer script:

BASH 
stop-service splunk-otel-collector
start-service splunk-otel-collector
Kubernetes

Kubernetes with Helm:

BASH 
helm upgrade your-splunk-otel-collector splunk-otel-collector-chart/splunk-otel-collector -f your-override-values.yaml

where splunk-otel-collector-chart is the name you gave to the Helm chart in the helm repo add command.

Settings reference

The following table shows the configuration options for the Active Directory Domain Services receiver:

included

https://raw.githubusercontent.com/splunk/collector-config-tools/main/cfg-metadata/receiver/active_directory_ds.yaml

Troubleshooting

See Troubleshoot the Splunk OpenTelemetry Collector.