> ## Documentation Index
> Fetch the complete documentation index at: https://otel.fyi/llms.txt
> Use this file to discover all available pages before exploring further.

# Activedirectoryds

> OpenTelemetry receiver for Activedirectoryds

# Activedirectoryds Receiver

![Status](https://img.shields.io/badge/status-beta-yellow)

**Available in:** `contrib`

**Maintainers:** [@pjanotti](https://github.com/pjanotti)

**Source:** [opentelemetry-collector-contrib](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/activedirectorydsreceiver)

## Supported Telemetry

![Metrics](https://img.shields.io/badge/metrics-beta-green)

## Overview

## Configuration

The following settings are optional:

* `metrics` (default: see [`DefaultMetricsSettings`](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/activedirectorydsreceiver/internal/metadata/generated_metrics.go)): Allows enabling and disabling specific metrics from being collected in this receiver.
* `collection_interval` (default = `10s`): The interval at which metrics are emitted by this receiver.
* `initial_delay` (default = `1s`): defines how long this receiver waits before starting.

Example:

```yaml theme={null}
receivers:
  active_directory_ds:
    collection_interval: 10s
    metrics:
      # Disable the active_directory.ds.replication.network.io metric from being emitted
      active_directory.ds.replication.network.io:
        enabled: false
```

The full list of settings exposed for this receiver is documented in [config.go](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/activedirectorydsreceiver/config.go), along with detailed sample configurations [here](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/activedirectorydsreceiver/testdata/config.yaml).

## Metrics

Details about the metrics produced by this receiver can be found in [metadata.yaml](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/activedirectorydsreceiver/metadata.yaml)

## Metrics

| Metric Name                                                           | Description                                                                                                              | Unit               | Type          | Attributes                     |
| --------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | ------------------ | ------------- | ------------------------------ |
| ✅ `active_directory.ds.bind.rate`                                     | The number of binds per second serviced by this domain controller.                                                       | \{binds}/s         | UpDownCounter | bind\_type                     |
| ✅ `active_directory.ds.ldap.bind.last_successful.time`                | The amount of time taken for the last successful LDAP bind.                                                              | ms                 | Gauge         |                                |
| ✅ `active_directory.ds.ldap.bind.rate`                                | The number of successful LDAP binds per second.                                                                          | \{binds}/s         | UpDownCounter |                                |
| ✅ `active_directory.ds.ldap.client.session.count`                     | The number of connected LDAP client sessions.                                                                            | \{sessions}        | UpDownCounter |                                |
| ✅ `active_directory.ds.ldap.search.rate`                              | The number of LDAP searches per second.                                                                                  | \{searches}/s      | UpDownCounter |                                |
| ✅ `active_directory.ds.name_cache.hit_rate`                           | The percentage of directory object name component lookups that are satisfied by the Directory System Agent's name cache. | %                  | Gauge         |                                |
| ✅ `active_directory.ds.notification.queued`                           | The number of pending update notifications that have been queued to push to clients.                                     | \{notifications}   | UpDownCounter |                                |
| ✅ `active_directory.ds.operation.rate`                                | The number of operations performed per second.                                                                           | \{operations}/s    | UpDownCounter | operation\_type                |
| ✅ `active_directory.ds.replication.network.io`                        | The amount of network data transmitted by the Directory Replication Agent.                                               | By                 | Counter       | direction, network\_data\_type |
| ✅ `active_directory.ds.replication.object.rate`                       | The number of objects transmitted by the Directory Replication Agent per second.                                         | \{objects}/s       | UpDownCounter | direction                      |
| ✅ `active_directory.ds.replication.operation.pending`                 | The number of pending replication operations for the Directory Replication Agent.                                        | \{operations}      | UpDownCounter |                                |
| ✅ `active_directory.ds.replication.property.rate`                     | The number of properties transmitted by the Directory Replication Agent per second.                                      | \{properties}/s    | UpDownCounter | direction                      |
| ✅ `active_directory.ds.replication.sync.object.pending`               | The number of objects remaining until the full sync completes for the Directory Replication Agent.                       | \{objects}         | UpDownCounter |                                |
| ✅ `active_directory.ds.replication.sync.request.count`                | The number of sync requests made by the Directory Replication Agent.                                                     | \{requests}        | Counter       | sync\_result                   |
| ✅ `active_directory.ds.replication.value.rate`                        | The number of values transmitted by the Directory Replication Agent per second.                                          | \{values}/s        | UpDownCounter | direction, value\_type         |
| ✅ `active_directory.ds.security_descriptor_propagations_event.queued` | The number of security descriptor propagation events that are queued for processing.                                     | \{events}          | UpDownCounter |                                |
| ✅ `active_directory.ds.suboperation.rate`                             | The rate of sub-operations performed.                                                                                    | \{suboperations}/s | UpDownCounter | suboperation\_type             |
| ✅ `active_directory.ds.thread.count`                                  | The number of threads in use by the directory service.                                                                   | \{threads}         | UpDownCounter |                                |

## Attributes

| Attribute Name | Description                            | Type   | Values                                             |
| -------------- | -------------------------------------- | ------ | -------------------------------------------------- |
| `type`         | The type of bind to the domain server. | string | `server`, `client`                                 |
| `direction`    | The direction of data flow.            | string | `sent`, `received`                                 |
| `type`         | The type of network data sent.         | string | `compressed`, `uncompressed`                       |
| `type`         | The type of operation.                 | string | `read`, `write`, `search`                          |
| `type`         | The type of suboperation.              | string | `security_descriptor_propagations_event`, `search` |
| `result`       | The result status of the sync request. | string | `success`, `schema_mismatch`, `other`              |
| `type`         | The type of value sent.                | string | `distinguished_names`, `other`                     |

## Configuration

### Example Configuration

```yaml theme={null}
active_directory_ds:
  collection_interval: 2m
  metrics:
    active_directory.ds.replication.object.rate:
      enabled: false
active_directory_ds/defaults:
```

***

*Last generated: 2026-07-06*
