LDAP Metrics Reference
LDAP metrics are exposed as LDAP attributes on entries under cn=monitor. Metrics entry object class names start with ds-monitor. Metrics attribute names start with ds-mon. For details, see the LDAP Schema Reference.
Note
Some ds-mon-jvm-* metrics depend on the JVM version and configuration. In particular, GC-related metrics depend on the garbage collector that the server uses. The GC metric names are unstable, and can change even in a minor JVM release.
| Name | Syntax | Description |
|---|---|---|
ds-mon-abandoned-requests | Counter metric | Total number of abandoned operations since startup |
ds-mon-active-connections-count | Integer | Number of active client connections |
ds-mon-active-persistent-searches | Integer | Number of active persistent searches |
ds-mon-admin-hostport | Host port | The administrative host and port |
ds-mon-alive | Boolean | Indicates whether the server is alive |
ds-mon-alive-errors | Directory String | Lists server errors preventing the server from operating correctly that require administrative action |
ds-mon-backend-degraded-index-count | Integer | Number of degraded indexes in the backend |
ds-mon-backend-degraded-index | Directory String | Backend degraded index |
ds-mon-backend-entry-count | Integer | Number of entries contained in the backend |
ds-mon-backend-filter-use-indexed | Integer | Number of indexed searches performed against the backend |
ds-mon-backend-filter-use-start-time | Generalized Time | Time when recording started for statistical information about the simple search filters processed against the backend |
ds-mon-backend-filter-use-unindexed | Integer | Number of unindexed searches performed against the backend |
ds-mon-backend-filter-use | Json | Information about the simple search filter processed against the backend |
ds-mon-backend-is-private | Boolean | Whether the base DNs of this backend should be considered public or private |
ds-mon-backend-proxy-base-dn | DN | Base DNs routed to remote LDAP servers by the proxy backend |
ds-mon-backend-proxy-shard | Summary metric | Remote LDAP servers that the proxy backend forwards requests to |
ds-mon-backend-ttl-entries-deleted | Summary metric | Summary for entries purged by time-to-live |
ds-mon-backend-ttl-is-running | Boolean | Indicates whether time-to-live is in the process of purging expired entries |
ds-mon-backend-ttl-last-run-time | Generalized Time | Last date and time when time-to-live finished purging expired entries |
ds-mon-backend-ttl-queue-size | Integer | Number of entries queued for purging by the time-to-live service |
ds-mon-backend-ttl-thread-count | Integer | Number of active time-to-live threads |
ds-mon-backend-writability-mode | Directory String | Current backend behavior when processing write operations, can either be "disabled", "enabled" or "internal-only" |
ds-mon-base-dn-entry-count | Integer | Number of subordinate entries of the base DN, including the base DN |
ds-mon-base-dn | DN | Base DN handled by a backend |
ds-mon-build-number | Integer | Build number of the Directory Server |
ds-mon-build-time | Generalized Time | Build date and time of the Directory Server |
ds-mon-bytes-read | Summary metric | Network bytes read summary |
ds-mon-bytes-written | Summary metric | Network bytes written summary |
ds-mon-cache-entry-count | Integer | Current number of entries held in this cache |
ds-mon-cache-max-entry-count | Integer | Maximum number of entries allowed in this cache |
ds-mon-cache-max-size-bytes | Size in bytes | Memory limit for this cache |
ds-mon-cache-misses | Summary metric | Number of attempts to retrieve an entry that was not held in this cache |
ds-mon-cache-total-tries | Summary metric | Number of attempts to retrieve an entry from this cache |
ds-mon-certificate-expires-at | Generalized Time | Certificate expiration date and time |
ds-mon-certificate-issuer-dn | DN | Certificate issuer DN |
ds-mon-certificate-serial-number | Integer | Certificate serial number |
ds-mon-certificate-subject-dn | DN | Certificate subject DN |
ds-mon-changelog-id | Directory String | Changelog identifier |
ds-mon-changelog-hostport | Host port | The host and port of the changelog server |
ds-mon-changelog-purge-delay | Duration in milli-seconds | The purge delay of the changelog |
ds-mon-compact-version | Directory String | Compact version of the Directory Server |
ds-mon-config-dn | DN | DN of the configuration entry |
ds-mon-connected-to-server-hostport | Host port | Host and replication port of the server that this server is connected to |
ds-mon-connected-to-server-id | Integer | Identifier of the server that this server is connected to |
ds-mon-connection | Json | Client connection summary information |
ds-mon-connections | Summary metric | Connection summary |
ds-mon-current-connections | Integer | Number of client connections currently established with the Directory Server |
ds-mon-current-delay | Duration in milli-seconds | Current local delay in receiving replicated operations |
ds-mon-current-receive-window | Integer | Current replication window size for receiving messages, indicating the number of replication messages a remote server can send before waiting on acknowledgement from this server. This does not depend on the TCP window size |
ds-mon-current-send-window | Integer | Current replication window size for sending messages, indicating the number of replication messages this server can send before waiting on acknowledgement from the receiving server. This does not depend on the TCP window size |
ds-mon-current-time | Generalized Time | Current date and time |
ds-mon-db-cache-evict-internal-nodes-count | Integer | Number of internal nodes evicted from the database cache |
ds-mon-db-cache-evict-leaf-nodes-count | Integer | Number of leaf nodes (data records) evicted from the database cache |
ds-mon-db-cache-leaf-nodes | Boolean | Whether leaf nodes are cached |
ds-mon-db-cache-misses-internal-nodes | Integer | Number of internal nodes requested by btree operations that were not in the database cache |
ds-mon-db-cache-misses-leaf-nodes | Integer | Number of leaf nodes (data records) requested by btree operations that were not in the database cache |
ds-mon-db-cache-size-active | Size in bytes | Size of the database cache |
ds-mon-db-cache-size-total | Size in bytes | Maximum size of the database cache |
ds-mon-db-cache-total-tries-internal-nodes | Integer | Number of internal nodes requested by btree operations |
ds-mon-db-cache-total-tries-leaf-nodes | Integer | Number of leaf nodes (data records) requested by btree operations |
ds-mon-db-checkpoint-count | Integer | Number of checkpoints run so far |
ds-mon-db-log-cleaner-file-deletion-count | Integer | Number of cleaner file deletions |
ds-mon-db-log-files-open | Integer | Number of files currently open in the database file cache |
ds-mon-db-log-files-opened | Integer | Number of times a log file has been opened |
ds-mon-db-log-size-active | Size in bytes | Estimate of the amount in bytes of live data in all data files (i.e., the size of the DB, ignoring garbage) |
ds-mon-db-log-size-total | Size in bytes | Size used by all data files on disk |
ds-mon-db-log-utilization-max | Integer | Current maximum (upper bound) log utilization as a percentage |
ds-mon-db-log-utilization-min | Integer | Current minimum (lower bound) log utilization as a percentage |
ds-mon-db-version | Directory String | Database version used by the backend |
ds-mon-disk-dir | Filesystem path | A monitored directory containing data that may change over time |
ds-mon-disk-free | Size in bytes | Amount of free disk space |
ds-mon-disk-full-threshold | Size in bytes | Effective full disk space threshold |
ds-mon-disk-low-threshold | Size in bytes | Effective low disk space threshold |
ds-mon-disk-root | Filesystem path | Monitored disk root |
ds-mon-disk-state | Directory String | Current disk state, can be either "normal", "low" or "full" |
ds-mon-domain-generation-id | Integer | Replication domain generation identifier |
ds-mon-domain-name | DN | Replication domain name |
ds-mon-entries-awaiting-updates-count | Duration in milli-seconds | Number of entries for which an update operation has been received but not replayed yet by this replica |
ds-mon-fix-ids | Directory String | IDs of issues that have been fixed in this Directory Server build |
ds-mon-full-version | Directory String | Full version of the Directory Server |
ds-mon-group-id | Directory String | Unique identifier of the group in which the directory server belongs |
ds-mon-healthy | Boolean | Indicates whether the server is able to handle requests |
ds-mon-healthy-errors | Directory String | Lists transient server errors preventing the server from temporarily handling requests |
ds-mon-install-path | Filesystem path | Directory Server root installation path |
ds-mon-instance-path | Filesystem path | Directory Server instance path |
ds-mon-jvm-architecture | Directory String | Java virtual machine architecture (e.g. 32-bit, 64-bit) |
ds-mon-jvm-arguments | Directory String | Input arguments passed to the Java virtual machine |
ds-mon-jvm-available-cpus | Integer | Number of processors available to the Java virtual machine |
ds-mon-jvm-class-path | Filesystem path | Path used to find directories and JAR archives containing Java class files |
ds-mon-jvm-classes-loaded | Integer | Number of classes loaded since the Java virtual machine started |
ds-mon-jvm-classes-unloaded | Integer | Number of classes unloaded since the Java virtual machine started |
ds-mon-jvm-java-home | Filesystem path | Installation directory for Java runtime environment (JRE) |
ds-mon-jvm-java-vendor | Directory String | Java runtime environment (JRE) vendor |
ds-mon-jvm-java-version | Directory String | Java runtime environment (JRE) version |
ds-mon-jvm-memory-heap-init | Size in bytes | Amount of heap memory that the Java virtual machine initially requested from the operating system |
ds-mon-jvm-memory-heap-max | Size in bytes | Maximum amount of heap memory that the Java virtual machine will attempt to use |
ds-mon-jvm-memory-heap-reserved | Size in bytes | Amount of heap memory that is committed for the Java virtual machine to use |
ds-mon-jvm-memory-heap-used | Size in bytes | Amount of heap memory used by the Java virtual machine |
ds-mon-jvm-memory-init | Size in bytes | Amount of memory that the Java virtual machine initially requested from the operating system |
ds-mon-jvm-memory-max | Size in bytes | Maximum amount of memory that the Java virtual machine will attempt to use |
ds-mon-jvm-memory-non-heap-init | Size in bytes | Amount of non-heap memory that the Java virtual machine initially requested from the operating system |
ds-mon-jvm-memory-non-heap-max | Size in bytes | Maximum amount of non-heap memory that the Java virtual machine will attempt to use |
ds-mon-jvm-memory-non-heap-reserved | Size in bytes | Amount of non-heap memory that is committed for the Java virtual machine to use |
ds-mon-jvm-memory-non-heap-used | Size in bytes | Amount of non-heap memory used by the Java virtual machine |
ds-mon-jvm-memory-reserved | Size in bytes | Amount of memory that is committed for the Java virtual machine to use |
ds-mon-jvm-memory-used | Size in bytes | Amount of memory used by the Java virtual machine |
ds-mon-jvm-supported-tls-ciphers | Directory String | Transport Layer Security (TLS) cipher suites supported by this Directory Server |
ds-mon-jvm-supported-tls-protocols | Directory String | Transport Layer Security (TLS) protocols supported by this Directory Server |
ds-mon-jvm-threads-blocked-count | Integer | Number of threads in the BLOCKED state |
ds-mon-jvm-threads-count | Integer | Number of live threads including both daemon and non-daemon threads |
ds-mon-jvm-threads-daemon-count | Integer | Number of live daemon threads |
ds-mon-jvm-threads-deadlock-count | Integer | Number of deadlocked threads |
ds-mon-jvm-threads-deadlocks | Directory String | Diagnostic stack traces for deadlocked threads |
ds-mon-jvm-threads-new-count | Integer | Number of threads in the NEW state |
ds-mon-jvm-threads-runnable-count | Integer | Number of threads in the RUNNABLE state |
ds-mon-jvm-threads-terminated-count | Integer | Number of threads in the TERMINATED state |
ds-mon-jvm-threads-timed-waiting-count | Integer | Number of threads in the TIMED_WAITING state |
ds-mon-jvm-threads-waiting-count | Integer | Number of threads in the WAITING state |
ds-mon-jvm-vendor | Directory String | Java virtual machine vendor |
ds-mon-jvm-version | Directory String | Java virtual machine version |
ds-mon-last-seen | Generalized Time | Time that this server was last seen |
ds-mon-ldap-hostport | Host port | The host and port to connect using LDAP (no support for start TLS) |
ds-mon-ldap-starttls-hostport | Host port | The host and port to connect using LDAP (with support for start TLS) |
ds-mon-ldaps-hostport | Host port | The host and port to connect using LDAPS |
ds-mon-listen-address | Directory String | Host and port |
ds-mon-lost-connections | Duration in milli-seconds | Number of times the replica lost its connection to the replication server |
ds-mon-major-version | Integer | Major version number of the Directory Server |
ds-mon-max-connections | Integer | Maximum number of simultaneous client connections that have been established with the Directory Server |
ds-mon-max-receive-window | Integer | Maximum replication window size for receiving messages, indicating the number of replication messages a remote server can send before waiting on acknowledgement from this server. This does not depend on the TCP window size |
ds-mon-max-send-window | Integer | Maximum replication window size for sending messages, indicating the number of replication messages this server can send before waiting on acknowledgement from the receiving server. This does not depend on the TCP window size |
ds-mon-minor-version | Integer | Minor version number of the Directory Server |
ds-mon-newest-change-number | Integer | Newest change number present in the change number index database |
ds-mon-newest-csn-timestamp | Generalized Time | Timestamp of the newest CSN present in the replica database |
ds-mon-newest-csn | CSN (Change Sequence Number) | Newest CSN present in the replica database |
ds-mon-oldest-change-number | Integer | Oldest change number present in the change number index database |
ds-mon-oldest-csn-timestamp | Generalized Time | Timestamp of the oldest CSN present in the replica database |
ds-mon-oldest-csn | CSN (Change Sequence Number) | Oldest CSN present in the replica database |
ds-mon-os-architecture | Directory String | Operating system architecture |
ds-mon-os-name | Directory String | Operating system name |
ds-mon-os-version | Directory String | Operating system version |
ds-mon-point-version | Integer | Point version number of the Directory Server |
ds-mon-process-id | UUID | Process ID of the running directory server |
ds-mon-product-name | Directory String | Full name of the Directory Server |
ds-mon-protocol | Directory String | Network protocol |
ds-mon-receive-delay | Duration in milli-seconds | Current local delay in receiving replicated operations |
ds-mon-replay-delay | Duration in milli-seconds | Current local delay in replaying replicated operations |
ds-mon-replayed-updates-conflicts-resolved | Counter metric | Number of updates replayed on this replica for which replication naming conflicts have been resolved |
ds-mon-replayed-updates-conflicts-unresolved | Counter metric | Number of updates replayed on this replica for which replication naming conflicts have not been resolved |
ds-mon-replayed-updates | Timer metric | Timer for updates that have been replayed on this replica |
ds-mon-replica-hostport | Host port | Host and port of a replica server |
ds-mon-replication-domain | DN | The replication domain |
ds-mon-replication-protocol-version | Integer | The protocol version used for replication |
ds-mon-requests-abandon | Timer metric | Abandon request timer |
ds-mon-requests-add | Timer metric | Add request timer |
ds-mon-requests-bind | Timer metric | Bind request timer |
ds-mon-requests-compare | Timer metric | Compare request timer |
ds-mon-requests-delete | Timer metric | Delete request timer |
ds-mon-requests-extended | Timer metric | Extended request timer |
ds-mon-requests-failure-client-invalid-request | Timer metric | Timer for requests that failed because there was a problem while attempting to perform the associated operation (associated LDAP result codes: 1, 2, 12, 15, 16, 17, 18, 19, 20, 21, 23, 34, 35, 36, 37, 38, 39; associated HTTP status codes: client error (4xx) except 401 and 403) |
ds-mon-requests-failure-client-redirect | Timer metric | Timer for requests that could not complete because further action is required (associated HTTP status codes: redirection (3xx)) |
ds-mon-requests-failure-client-referral | Timer metric | Timer for requests that failed because the server did not hold the request targeted entry (but was able to provide alternative servers that may) (associated LDAP result code: 10) |
ds-mon-requests-failure-client-resource-limit | Timer metric | Timer for requests that failed because they were trying to exceed the resource limits allocated to the associated clients (associated LDAP result codes: time, size and admin limit exceeded (respectively 4, 5 and 11) |
ds-mon-requests-failure-client-security | Timer metric | Timer for requests that failed for security reasons (associated LDAP result codes: 8, 9, 13, 25, 26, 27; associated HTTP status codes: unauthorized (401) and forbidden (403)) |
ds-mon-requests-failure-server | Timer metric | Timer for apparently valid requests that failed because the server was not able to process them (associated LDAP result codes: busy (51), unavailable (52), unwilling to perform (53) and other (80); associated HTTP status codes: server error (5xx)) |
ds-mon-requests-failure-uncategorized | Timer metric | Timer for requests that failed due to uncategorized reasons |
ds-mon-requests-get | Timer metric | GET request timer |
ds-mon-requests-in-queue | Integer | Number of requests in the work queue that have not yet been picked up for processing |
ds-mon-requests-modify-dn | Timer metric | Modify DN request timer |
ds-mon-requests-modify | Timer metric | Modify request timer |
ds-mon-requests-patch | Timer metric | PATCH request timer |
ds-mon-requests-post | Timer metric | POST request timer |
ds-mon-requests-put | Timer metric | PUT request timer |
ds-mon-requests-rejected-queue-full | Summary metric | Summary for operations that have been rejected because the work queue was already at its maximum capacity |
ds-mon-requests-search-base | Timer metric | Base object search request timer |
ds-mon-requests-search-one | Timer metric | One level search request timer |
ds-mon-requests-search-sub | Timer metric | Subtree search request timer |
ds-mon-requests-submitted | Summary metric | Summary for operations that have been successfully submitted to the work queue |
ds-mon-requests-unbind | Timer metric | Unbind request timer |
ds-mon-requests-uncategorized | Timer metric | Uncategorized request timer |
ds-mon-revision | Directory String | Revision ID in the source repository from which the Directory Server is build |
ds-mon-sent-updates | Counter metric | Number of replication updates sent by this replica |
ds-mon-server-hostport | Host port | Host and port of a server |
ds-mon-server-id | Integer | Server identifier |
ds-mon-server-is-local | Boolean | Indicates whether this is the topology server that has handled the monitoring request |
ds-mon-server-state | CSN (Change Sequence Number) | Replication server state |
ds-mon-short-name | Directory String | Short name of the Directory Server |
ds-mon-ssl-encryption | Boolean | Whether SSL encryption is used when exchanging messages with this server |
ds-mon-start-time | Generalized Time | Start date and time for the Directory Server |
ds-mon-status-last-changed | Generalized Time | Last date and time the replication status of the local replica changed |
ds-mon-status | Directory String | Replication status of the local replica, can either be "Invalid", "Not connected", "Normal", "Degraded", "Full update", "Bad generation id" |
ds-mon-system-name | Directory String | Fully qualified domain name of the system where the Directory Server is running |
ds-mon-total-connections | Integer | Total number of client connections that have been established with the Directory Server since it started |
ds-mon-updates-inbound-queue | Integer | Number of remote updates received from the replication server but not replayed yet on this replica |
ds-mon-updates-outbound-queue | Integer | Number of local updates that are waiting to be sent to the replication server once they complete |
ds-mon-updates-totals-per-replay-thread | Json | JSON array of the number of updates replayed per replay thread |
ds-mon-vendor-name | Directory String | Vendor name of the Directory Server |
ds-mon-version-qualifier | Directory String | Version qualifier of the Directory Server |
ds-mon-working-directory | Filesystem path | Current working directory of the user running the Directory Server |