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.

NameSyntaxDescription
ds-mon-abandoned-requestsCounter metric

Total number of abandoned operations since startup

ds-mon-active-connections-countInteger

Number of active client connections

ds-mon-active-persistent-searchesInteger

Number of active persistent searches

ds-mon-admin-hostportHost port

The administrative host and port

ds-mon-aliveBoolean

Indicates whether the server is alive

ds-mon-alive-errorsDirectory String

Lists server errors preventing the server from operating correctly that require administrative action

ds-mon-approx-oldest-change-not-synchronizedGeneralized Time

Approximate date and time of the oldest change not yet synchronized

ds-mon-approximate-delayDuration in milli-seconds

Approximate delay between this server and the connected replica

ds-mon-assured-sd-acknowledged-updatesCounter metric

Number of updates sent in the safe-data mode of assured replication that have been successfully acknowledged

ds-mon-assured-sd-received-updates-timeoutCounter metric

Number of updates received in the safe-data mode of assured replication that timed out

ds-mon-assured-sd-received-updatesInteger

Number of updates received in the safe-data mode of assured replication

ds-mon-assured-sd-sent-updates-timeoutCounter metric

Number of updates sent in the safe-data mode of assured replication that timed out

ds-mon-assured-sd-sent-updatesCounter metric

Number of updates sent in the safe-data mode of assured replication

ds-mon-assured-sd-server-timeout-updatesJson

Number of updates sent to other servers in the safe-data mode of assured replication that have not been acknowledged successfully due to timeout

ds-mon-assured-sd-timeout-updatesCounter metric

Number of updates sent in the safe-data mode of assured replication that have not been successfully acknowledged because of timeout

ds-mon-assured-sr-acknowledged-updatesCounter metric

Number of updates sent in the safe-read mode of assured replication that this server acknowledged successfully

ds-mon-assured-sr-not-acknowledged-updatesCounter metric

Number of updates sent in the safe-read mode of assured replication that have not been acknowledged successfully (due to timeout, incorrect status, or error during replay)

ds-mon-assured-sr-received-updates-ackedCounter metric

Number of updates received in the safe-read mode of assured replication that this server acknowledged without errors

ds-mon-assured-sr-received-updates-not-ackedCounter metric

Number of updates received in the safe-read mode of assured replication that this server acknowledged with errors

ds-mon-assured-sr-received-updates-timeoutCounter metric

Number of updates received in the safe-read mode of assured replication that timed out

ds-mon-assured-sr-received-updatesCounter metric

Number of updates received in the safe-read mode of assured replication

ds-mon-assured-sr-replay-error-updatesCounter metric

Number of updates sent in the safe-read mode of assured replication that have not been acknowledged successfully due to replay errors

ds-mon-assured-sr-sent-updates-timeoutCounter metric

Number of updates sent in the safe-read mode of assured replication that timed out

ds-mon-assured-sr-sent-updatesCounter metric

Number of updates sent in the safe-read mode of assured replication

ds-mon-assured-sr-server-not-acknowledged-updatesJson

Number of updates sent to other servers in the safe-read mode of assured replication that have not been acknowledged successfully (due to timeout, incorrect status, or error during replay)

ds-mon-assured-sr-timeout-updatesCounter metric

Number of updates sent in the safe-read mode of assured replication that have not been acknowledged successfully due to timeout

ds-mon-assured-sr-wrong-status-updatesCounter metric

Number of updates sent in the safe-read mode of assured replication that have not been acknowledged successfully due to incorrect status

ds-mon-backend-degraded-index-countInteger

Number of degraded indexes in the backend

ds-mon-backend-degraded-indexDirectory String

Backend degraded index

ds-mon-backend-entry-countInteger

Number of entries contained in the backend

ds-mon-backend-filter-use-indexedInteger

Number of indexed searches performed against the backend

ds-mon-backend-filter-use-start-timeGeneralized Time

Time when recording started for statistical information about the simple search filters processed against the backend

ds-mon-backend-filter-use-unindexedInteger

Number of unindexed searches performed against the backend

ds-mon-backend-filter-useJson

Information about the simple search filter processed against the backend

ds-mon-backend-is-privateBoolean

Whether the base DNs of this backend should be considered public or private

ds-mon-backend-proxy-base-dnDN

Base DNs routed to remote LDAP servers by the proxy backend

ds-mon-backend-proxy-shardSummary metric

Remote LDAP servers that the proxy backend forwards requests to

ds-mon-backend-ttl-entries-deletedSummary metric

Summary for entries purged by time-to-live

ds-mon-backend-ttl-is-runningBoolean

Indicates whether time-to-live is in the process of purging expired entries

ds-mon-backend-ttl-last-run-timeGeneralized Time

Last date and time when time-to-live finished purging expired entries

ds-mon-backend-ttl-queue-sizeInteger

Number of entries queued for purging by the time-to-live service

ds-mon-backend-ttl-thread-countInteger

Number of active time-to-live threads

ds-mon-backend-writability-modeDirectory String

Current backend behavior when processing write operations, can either be "disabled", "enabled" or "internal-only"

ds-mon-base-dn-entry-countInteger

Number of subordinate entries of the base DN, including the base DN

ds-mon-base-dnDN

Base DN handled by a backend

ds-mon-build-numberInteger

Build number of the Directory Server

ds-mon-build-timeGeneralized Time

Build date and time of the Directory Server

ds-mon-bytes-readSummary metric

Network bytes read summary

ds-mon-bytes-writtenSummary metric

Network bytes written summary

ds-mon-cache-entry-countInteger

Current number of entries held in this cache

ds-mon-cache-max-entry-countInteger

Maximum number of entries allowed in this cache

ds-mon-cache-max-size-bytesSize in bytes

Memory limit for this cache

ds-mon-cache-missesSummary metric

Number of attempts to retrieve an entry that was not held in this cache

ds-mon-cache-total-triesSummary metric

Number of attempts to retrieve an entry from this cache

ds-mon-certificate-expires-atGeneralized Time

Certificate expiration date and time

ds-mon-certificate-issuer-dnDN

Certificate issuer DN

ds-mon-certificate-serial-numberInteger

Certificate serial number

ds-mon-certificate-subject-dnDN

Certificate subject DN

ds-mon-changelog-idDirectory String

Changelog identifier

ds-mon-changelog-hostportHost port

The host and port of the changelog server

ds-mon-changelog-purge-delayDuration in milli-seconds

The purge delay of the changelog

ds-mon-compact-versionDirectory String

Compact version of the Directory Server

ds-mon-config-dnDN

DN of the configuration entry

ds-mon-connected-to-server-hostportHost port

Host and replication port of the server that this server is connected to

ds-mon-connected-to-server-idInteger

Identifier of the server that this server is connected to

ds-mon-connectionJson

Client connection summary information

ds-mon-connectionsSummary metric

Connection summary

ds-mon-current-connectionsInteger

Number of client connections currently established with the Directory Server

ds-mon-current-delayDuration in milli-seconds

Current local delay in receiving replicated operations

ds-mon-current-receive-windowInteger

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-windowInteger

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-timeGeneralized Time

Current date and time

ds-mon-db-cache-evict-internal-nodes-countInteger

Number of internal nodes evicted from the database cache

ds-mon-db-cache-evict-leaf-nodes-countInteger

Number of leaf nodes (data records) evicted from the database cache

ds-mon-db-cache-leaf-nodesBoolean

Whether leaf nodes are cached

ds-mon-db-cache-misses-internal-nodesInteger

Number of internal nodes requested by btree operations that were not in the database cache

ds-mon-db-cache-misses-leaf-nodesInteger

Number of leaf nodes (data records) requested by btree operations that were not in the database cache

ds-mon-db-cache-size-activeSize in bytes

Size of the database cache

ds-mon-db-cache-size-totalSize in bytes

Maximum size of the database cache

ds-mon-db-cache-total-tries-internal-nodesInteger

Number of internal nodes requested by btree operations

ds-mon-db-cache-total-tries-leaf-nodesInteger

Number of leaf nodes (data records) requested by btree operations

ds-mon-db-checkpoint-countInteger

Number of checkpoints run so far

ds-mon-db-log-cleaner-file-deletion-countInteger

Number of cleaner file deletions

ds-mon-db-log-files-openInteger

Number of files currently open in the database file cache

ds-mon-db-log-files-openedInteger

Number of times a log file has been opened

ds-mon-db-log-size-activeSize 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-totalSize in bytes

Size used by all data files on disk

ds-mon-db-log-utilization-maxInteger

Current maximum (upper bound) log utilization as a percentage

ds-mon-db-log-utilization-minInteger

Current minimum (lower bound) log utilization as a percentage

ds-mon-db-versionDirectory String

Database version used by the backend

ds-mon-disk-dirFilesystem path

A monitored directory containing data that may change over time

ds-mon-disk-freeSize in bytes

Amount of free disk space

ds-mon-disk-full-thresholdSize in bytes

Effective full disk space threshold

ds-mon-disk-low-thresholdSize in bytes

Effective low disk space threshold

ds-mon-disk-rootFilesystem path

Monitored disk root

ds-mon-disk-stateDirectory String

Current disk state, can be either "normal", "low" or "full"

ds-mon-domain-generation-idInteger

Replication domain generation identifier

ds-mon-domain-nameDN

Replication domain name

ds-mon-entries-awaiting-updates-countDuration in milli-seconds

Number of entries for which an update operation has been received but not replayed yet by this replica

ds-mon-fix-idsDirectory String

IDs of issues that have been fixed in this Directory Server build

ds-mon-full-versionDirectory String

Full version of the Directory Server

ds-mon-group-idDirectory String

Unique identifier of the group in which the directory server belongs

ds-mon-healthyBoolean

Indicates whether the server is able to handle requests

ds-mon-healthy-errorsDirectory String

Lists transient server errors preventing the server from temporarily handling requests

ds-mon-install-pathFilesystem path

Directory Server root installation path

ds-mon-instance-pathFilesystem path

Directory Server instance path

ds-mon-jvm-architectureDirectory String

Java virtual machine architecture (e.g. 32-bit, 64-bit)

ds-mon-jvm-argumentsDirectory String

Input arguments passed to the Java virtual machine

ds-mon-jvm-available-cpusInteger

Number of processors available to the Java virtual machine

ds-mon-jvm-class-pathFilesystem path

Path used to find directories and JAR archives containing Java class files

ds-mon-jvm-classes-loadedInteger

Number of classes loaded since the Java virtual machine started

ds-mon-jvm-classes-unloadedInteger

Number of classes unloaded since the Java virtual machine started

ds-mon-jvm-java-homeFilesystem path

Installation directory for Java runtime environment (JRE)

ds-mon-jvm-java-vendorDirectory String

Java runtime environment (JRE) vendor

ds-mon-jvm-java-versionDirectory String

Java runtime environment (JRE) version

ds-mon-jvm-memory-heap-initSize in bytes

Amount of heap memory that the Java virtual machine initially requested from the operating system

ds-mon-jvm-memory-heap-maxSize in bytes

Maximum amount of heap memory that the Java virtual machine will attempt to use

ds-mon-jvm-memory-heap-reservedSize in bytes

Amount of heap memory that is committed for the Java virtual machine to use

ds-mon-jvm-memory-heap-usedSize in bytes

Amount of heap memory used by the Java virtual machine

ds-mon-jvm-memory-initSize in bytes

Amount of memory that the Java virtual machine initially requested from the operating system

ds-mon-jvm-memory-maxSize in bytes

Maximum amount of memory that the Java virtual machine will attempt to use

ds-mon-jvm-memory-non-heap-initSize in bytes

Amount of non-heap memory that the Java virtual machine initially requested from the operating system

ds-mon-jvm-memory-non-heap-maxSize in bytes

Maximum amount of non-heap memory that the Java virtual machine will attempt to use

ds-mon-jvm-memory-non-heap-reservedSize in bytes

Amount of non-heap memory that is committed for the Java virtual machine to use

ds-mon-jvm-memory-non-heap-usedSize in bytes

Amount of non-heap memory used by the Java virtual machine

ds-mon-jvm-memory-reservedSize in bytes

Amount of memory that is committed for the Java virtual machine to use

ds-mon-jvm-memory-usedSize in bytes

Amount of memory used by the Java virtual machine

ds-mon-jvm-supported-tls-ciphersDirectory String

Transport Layer Security (TLS) cipher suites supported by this Directory Server

ds-mon-jvm-supported-tls-protocolsDirectory String

Transport Layer Security (TLS) protocols supported by this Directory Server

ds-mon-jvm-threads-blocked-countInteger

Number of threads in the BLOCKED state

ds-mon-jvm-threads-countInteger

Number of live threads including both daemon and non-daemon threads

ds-mon-jvm-threads-daemon-countInteger

Number of live daemon threads

ds-mon-jvm-threads-deadlock-countInteger

Number of deadlocked threads

ds-mon-jvm-threads-deadlocksDirectory String

Diagnostic stack traces for deadlocked threads

ds-mon-jvm-threads-new-countInteger

Number of threads in the NEW state

ds-mon-jvm-threads-runnable-countInteger

Number of threads in the RUNNABLE state

ds-mon-jvm-threads-terminated-countInteger

Number of threads in the TERMINATED state

ds-mon-jvm-threads-timed-waiting-countInteger

Number of threads in the TIMED_WAITING state

ds-mon-jvm-threads-waiting-countInteger

Number of threads in the WAITING state

ds-mon-jvm-vendorDirectory String

Java virtual machine vendor

ds-mon-jvm-versionDirectory String

Java virtual machine version

ds-mon-last-seenGeneralized Time

Time that this server was last seen

ds-mon-ldap-hostportHost port

The host and port to connect using LDAP (no support for start TLS)

ds-mon-ldap-starttls-hostportHost port

The host and port to connect using LDAP (with support for start TLS)

ds-mon-ldaps-hostportHost port

The host and port to connect using LDAPS

ds-mon-listen-addressDirectory String

Host and port

ds-mon-lost-connectionsDuration in milli-seconds

Number of times the replica lost its connection to the replication server

ds-mon-major-versionInteger

Major version number of the Directory Server

ds-mon-max-connectionsInteger

Maximum number of simultaneous client connections that have been established with the Directory Server

ds-mon-max-receive-windowInteger

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-windowInteger

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-versionInteger

Minor version number of the Directory Server

ds-mon-missing-changesInteger

Missing changes for replication

ds-mon-newest-change-numberInteger

Newest change number present in the change number index database

ds-mon-newest-csn-timestampGeneralized Time

Timestamp of the newest CSN present in the replica database

ds-mon-newest-csnCSN (Change Sequence Number)

Newest CSN present in the replica database

ds-mon-oldest-change-numberInteger

Oldest change number present in the change number index database

ds-mon-oldest-csn-timestampGeneralized Time

Timestamp of the oldest CSN present in the replica database

ds-mon-oldest-csnCSN (Change Sequence Number)

Oldest CSN present in the replica database

ds-mon-os-architectureDirectory String

Operating system architecture

ds-mon-os-nameDirectory String

Operating system name

ds-mon-os-versionDirectory String

Operating system version

ds-mon-point-versionInteger

Point version number of the Directory Server

ds-mon-process-idUUID

Process ID of the running directory server

ds-mon-product-nameDirectory String

Full name of the Directory Server

ds-mon-protocolDirectory String

Network protocol

ds-mon-receive-delayDuration in milli-seconds

Current local delay in receiving replicated operations

ds-mon-replay-delayDuration in milli-seconds

Current local delay in replaying replicated operations

ds-mon-replayed-updates-conflicts-resolvedCounter metric

Number of updates replayed on this replica for which replication naming conflicts have been resolved

ds-mon-replayed-updates-conflicts-unresolvedCounter metric

Number of updates replayed on this replica for which replication naming conflicts have not been resolved

ds-mon-replayed-updatesTimer metric

Timer for updates that have been replayed on this replica

ds-mon-replica-hostportHost port

Host and port of a replica server

ds-mon-replication-domainDN

The replication domain

ds-mon-replication-protocol-versionInteger

The protocol version used for replication

ds-mon-requests-abandonTimer metric

Abandon request timer

ds-mon-requests-addTimer metric

Add request timer

ds-mon-requests-bindTimer metric

Bind request timer

ds-mon-requests-compareTimer metric

Compare request timer

ds-mon-requests-deleteTimer metric

Delete request timer

ds-mon-requests-extendedTimer metric

Extended request timer

ds-mon-requests-failure-client-invalid-requestTimer 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-redirectTimer metric

Timer for requests that could not complete because further action is required (associated HTTP status codes: redirection (3xx))

ds-mon-requests-failure-client-referralTimer 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-limitTimer 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-securityTimer 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-serverTimer 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-uncategorizedTimer metric

Timer for requests that failed due to uncategorized reasons

ds-mon-requests-getTimer metric

GET request timer

ds-mon-requests-in-queueInteger

Number of requests in the work queue that have not yet been picked up for processing

ds-mon-requests-modify-dnTimer metric

Modify DN request timer

ds-mon-requests-modifyTimer metric

Modify request timer

ds-mon-requests-patchTimer metric

PATCH request timer

ds-mon-requests-postTimer metric

POST request timer

ds-mon-requests-putTimer metric

PUT request timer

ds-mon-requests-rejected-queue-fullSummary metric

Summary for operations that have been rejected because the work queue was already at its maximum capacity

ds-mon-requests-search-baseTimer metric

Base object search request timer

ds-mon-requests-search-oneTimer metric

One level search request timer

ds-mon-requests-search-subTimer metric

Subtree search request timer

ds-mon-requests-submittedSummary metric

Summary for operations that have been successfully submitted to the work queue

ds-mon-requests-unbindTimer metric

Unbind request timer

ds-mon-requests-uncategorizedTimer metric

Uncategorized request timer

ds-mon-revisionDirectory String

Revision ID in the source repository from which the Directory Server is build

ds-mon-sent-updatesCounter metric

Number of replication updates sent by this replica

ds-mon-server-hostportHost port

Host and port of a server

ds-mon-server-idInteger

Server identifier

ds-mon-server-is-localBoolean

Indicates whether this is the topology server that has handled the monitoring request

ds-mon-server-stateCSN (Change Sequence Number)

Replication server state

ds-mon-short-nameDirectory String

Short name of the Directory Server

ds-mon-ssl-encryptionBoolean

Whether SSL encryption is used when exchanging mesages with this server

ds-mon-start-timeGeneralized Time

Start date and time for the Directory Server

ds-mon-status-last-changedGeneralized Time

Last date and time the replication status of the local replica changed

ds-mon-statusDirectory String

Replication status of the local replica, can either be "Invalid", "Not connected", "Normal", "Degraded", "Full update", "Bad generation id"

ds-mon-system-nameDirectory String

Fully qualified domain name of the system where the Directory Server is running

ds-mon-total-connectionsInteger

Total number of client connections that have been established with the Directory Server since it started

ds-mon-updates-inbound-queueInteger

Number of remote updates received from the replication server but not replayed yet on this replica

ds-mon-updates-outbound-queueInteger

Number of local updates that are waiting to be sent to the replication server once they complete

ds-mon-updates-totals-per-replay-threadJson

JSON array of the number of updates replayed per replay thread

ds-mon-vendor-nameDirectory String

Vendor name of the Directory Server

ds-mon-version-qualifierDirectory String

Version qualifier of the Directory Server

ds-mon-working-directoryFilesystem path

Current working directory of the user running the Directory Server

Read a different version of :