Prometheus metrics reference

ds_acis_count{type}

Gauge

Total number of ACIs of the specified type

ds_admin_connector_connections

Gauge

Number of connections currently established on the Administration Connector

ds_all_entry_caches_cache_entry_count

Gauge

Current number of entries held in this cache

ds_all_entry_caches_cache_misses_count

Summary

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

ds_all_entry_caches_cache_misses_sum

Summary

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

ds_all_entry_caches_cache_size_bytes

Gauge

Total memory in bytes used by this cache

ds_all_entry_caches_cache_total_tries_count

Summary

Number of attempts to retrieve an entry from this cache

ds_all_entry_caches_cache_total_tries_sum

Summary

Number of attempts to retrieve an entry from this cache

ds_backend_db_cache_evict_internal_nodes_count{backend,type}

Gauge

Number of internal nodes evicted from the database cache

ds_backend_db_cache_evict_leaf_nodes_count{backend,type}

Gauge

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

ds_backend_db_cache_leaf_nodes{backend,type}

Gauge

Whether leaf nodes are cached

ds_backend_db_cache_misses_internal_nodes{backend,type}

Gauge

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

ds_backend_db_cache_misses_leaf_nodes{backend,type}

Gauge

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

ds_backend_db_cache_size_active_bytes{backend,type}

Gauge

Size of the database cache

ds_backend_db_cache_size_total_bytes{backend,type}

Gauge

Maximum size of the database cache

ds_backend_db_cache_total_tries_internal_nodes{backend,type}

Gauge

Number of internal nodes requested by btree operations

ds_backend_db_cache_total_tries_leaf_nodes{backend,type}

Gauge

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

ds_backend_db_checkpoint_count{backend,type}

Gauge

Number of checkpoints run so far

ds_backend_db_log_cleaner_file_deletion_count{backend,type}

Gauge

Number of cleaner file deletions

ds_backend_db_log_files_opened{backend,type}

Gauge

Number of times a log file has been opened

ds_backend_db_log_files_open{backend,type}

Gauge

Number of files currently open in the database file cache

ds_backend_db_log_size_active_bytes{backend,type}

Gauge

Estimate of the amount in bytes of live data in all data files (i.e., the size of the DB, ignoring garbage)

ds_backend_db_log_size_total_bytes{backend,type}

Gauge

Size used by all data files on disk

ds_backend_db_log_utilization_max{backend,type}

Gauge

Current maximum (upper bound) log utilization as a percentage

ds_backend_db_log_utilization_min{backend,type}

Gauge

Current minimum (lower bound) log utilization as a percentage

ds_backend_degraded_index_count{backend,type}

Gauge

Number of degraded indexes in the backend

ds_backend_entry_count{backend,base_dn,type}

Gauge

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

ds_backend_entry_size_read_bucket{backend,type,le}

Histogram

Histogram of entry sizes being read from the underlying storage

ds_backend_entry_size_read_count{backend,type}

Histogram

Histogram of entry sizes being read from the underlying storage

ds_backend_entry_size_read_sum{backend,type}

Histogram

Histogram of entry sizes being read from the underlying storage

ds_backend_entry_size_written_bucket{backend,type,le}

Histogram

Histogram of entry sizes being written to the underlying storage

ds_backend_entry_size_written_count{backend,type}

Histogram

Histogram of entry sizes being written to the underlying storage

ds_backend_entry_size_written_sum{backend,type}

Histogram

Histogram of entry sizes being written to the underlying storage

ds_backend_filter_indexed{backend,type}

Gauge

Number of indexed searches performed against the backend

ds_backend_filter_unindexed{backend,type}

Gauge

Number of unindexed searches performed against the backend

ds_backend_filter_use_start_time_seconds{backend,type}

Gauge

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

ds_backend_index_cost_seconds_count{backend,base_dn,index,type}

Summary

Number of index updates and their time cost

ds_backend_index_cost_seconds_sum{backend,base_dn,index,type}

Summary

Number of index updates and their time cost

ds_backend_index_cost_seconds{backend,base_dn,index,type,quantile}

Summary

Number of index updates and their time cost

ds_backend_index_uses_count{backend,base_dn,index,type}

Summary

Number of accesses of this index. For attribute indexes it represents the number of search operations that have used this index, for system indexes it represents the number of key lookups.

ds_backend_index_uses_sum{backend,base_dn,index,type}

Summary

Number of accesses of this index. For attribute indexes it represents the number of search operations that have used this index, for system indexes it represents the number of key lookups.

ds_backend_is_private{backend,type}

Gauge

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

ds_backend_ttl_entries_deleted_count{backend,type}

Summary

Summary for entries purged by time-to-live

ds_backend_ttl_entries_deleted_sum{backend,type}

Summary

Summary for entries purged by time-to-live

ds_backend_ttl_is_running{backend,type}

Gauge

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

ds_backend_ttl_last_run_time_seconds{backend,type}

Gauge

Last time time-to-live finished purging expired entries

ds_backend_ttl_queue_size{backend,type}

Gauge

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

ds_backend_ttl_thread_count{backend,type}

Gauge

Number of active time-to-live threads

ds_certificates_certificate_expires_at_seconds{alias,key_manager}

Gauge

Time the certificate expires

ds_change_number_indexing_state{indexing_state}

Gauge

Refer to the indexing_state dimension for details

ds_change_number_time_since_last_indexing_seconds

Gauge

Duration since the last time a change was indexed

ds_connection_handlers_http_active_connections_count{http_handler}

Gauge

Number of active client connections

ds_connection_handlers_http_bytes_read_count{http_handler}

Summary

Network bytes read summary

ds_connection_handlers_http_bytes_read_sum{http_handler}

Summary

Network bytes read summary

ds_connection_handlers_http_bytes_written_count{http_handler}

Summary

Network bytes written summary

ds_connection_handlers_http_bytes_written_sum{http_handler}

Summary

Network bytes written summary

ds_connection_handlers_http_requests_failure_seconds_count{http_handler,type}

Summary

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_connection_handlers_http_requests_failure_seconds_sum{http_handler,type}

Summary

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_connection_handlers_http_requests_failure_seconds{http_handler,type,quantile}

Summary

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_connection_handlers_http_requests_seconds_count{http_handler,type}

Summary

Timer for the specified request type

ds_connection_handlers_http_requests_seconds_sum{http_handler,type}

Summary

Timer for the specified request type

ds_connection_handlers_http_requests_seconds{http_handler,type,quantile}

Summary

Timer for the specified request type

ds_connection_handlers_ldap_abandoned_requests_total{ldap_handler}

Counter

Total number of abandoned operations since startup

ds_connection_handlers_ldap_abandoned_requests{ldap_handler} (deprecated)

Counter

Total number of abandoned operations since startup

ds_connection_handlers_ldap_active_connections_count{ldap_handler}

Gauge

Number of active client connections

ds_connection_handlers_ldap_active_persistent_searches{ldap_handler}

Gauge

Number of active persistent searches

ds_connection_handlers_ldap_bytes_read_count{ldap_handler}

Summary

Network bytes read summary

ds_connection_handlers_ldap_bytes_read_sum{ldap_handler}

Summary

Network bytes read summary

ds_connection_handlers_ldap_bytes_written_count{ldap_handler}

Summary

Network bytes written summary

ds_connection_handlers_ldap_bytes_written_sum{ldap_handler}

Summary

Network bytes written summary

ds_connection_handlers_ldap_connections_count{ldap_handler}

Summary

Connection summary

ds_connection_handlers_ldap_connections_sum{ldap_handler}

Summary

Connection summary

ds_connection_handlers_ldap_requests_failure_seconds_count{ldap_handler,type}

Summary

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_connection_handlers_ldap_requests_failure_seconds_sum{ldap_handler,type}

Summary

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_connection_handlers_ldap_requests_failure_seconds{ldap_handler,type,quantile}

Summary

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_connection_handlers_ldap_requests_seconds_count{ldap_handler,scope,type}

Summary

Timer for the specified request type

ds_connection_handlers_ldap_requests_seconds_count{ldap_handler,type}

Summary

Timer for the specified request type

ds_connection_handlers_ldap_requests_seconds_sum{ldap_handler,scope,type}

Summary

Timer for the specified request type

ds_connection_handlers_ldap_requests_seconds_sum{ldap_handler,type}

Summary

Timer for the specified request type

ds_connection_handlers_ldap_requests_seconds{ldap_handler,scope,type,quantile}

Summary

Timer for the specified request type

ds_connection_handlers_ldap_requests_seconds{ldap_handler,type,quantile}

Summary

Timer for the specified request type

ds_current_connections

Gauge

Number of client connections currently established except on the Administration Connector

ds_current_time_seconds

Gauge

Current time

ds_disk_free_space_bytes{disk}

Gauge

Amount of free disk space

ds_disk_free_space_full_threshold_bytes{disk}

Gauge

Effective full disk space threshold

ds_disk_free_space_low_threshold_bytes{disk}

Gauge

Effective low disk space threshold

ds_entries_with_aci_attributes_count

Gauge

Total number of entries with ACI attributes

ds_entry_cache_entry_count{cache}

Gauge

Current number of entries held in this cache

ds_entry_cache_max_entry_count{cache}

Gauge

Maximum number of entries allowed in this cache

ds_entry_cache_max_size_bytes{cache}

Gauge

Memory limit for this cache

ds_entry_cache_misses_count{cache}

Summary

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

ds_entry_cache_misses_sum{cache}

Summary

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

ds_entry_cache_size_bytes{cache}

Gauge

Total memory in bytes used by this cache

ds_entry_cache_total_tries_count{cache}

Summary

Number of attempts to retrieve an entry from this cache

ds_entry_cache_total_tries_sum{cache}

Summary

Number of attempts to retrieve an entry from this cache

ds_groups_count{type}

Gauge

Total number of groups of the specified type

ds_health_status_alive

Gauge

Indicates whether the server is alive

ds_health_status_healthy

Gauge

Indicates whether the server is able to handle requests

ds_jvm_available_cpus

Gauge

Number of processors available to the Java virtual machine

ds_jvm_classes_loaded

Gauge

Number of classes loaded since the Java virtual machine started

ds_jvm_classes_unloaded

Gauge

Number of classes unloaded since the Java virtual machine started

ds_jvm_memory_heap_init_bytes

Gauge

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

ds_jvm_memory_heap_max_bytes

Gauge

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

ds_jvm_memory_heap_reserved_bytes

Gauge

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

ds_jvm_memory_heap_used_bytes

Gauge

Amount of heap memory used by the Java virtual machine

ds_jvm_memory_init_bytes

Gauge

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

ds_jvm_memory_max_bytes

Gauge

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

ds_jvm_memory_non_heap_init_bytes

Gauge

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

ds_jvm_memory_non_heap_max_bytes

Gauge

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

ds_jvm_memory_non_heap_reserved_bytes

Gauge

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

ds_jvm_memory_non_heap_used_bytes

Gauge

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

ds_jvm_memory_reserved_bytes

Gauge

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

ds_jvm_memory_used_bytes

Gauge

Amount of memory used by the Java virtual machine

ds_jvm_threads_blocked_count

Gauge

Number of threads in the BLOCKED state

ds_jvm_threads_count

Gauge

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

ds_jvm_threads_daemon_count

Gauge

Number of live daemon threads

ds_jvm_threads_deadlock_count

Gauge

Number of deadlocked threads

ds_jvm_threads_new_count

Gauge

Number of threads in the NEW state

ds_jvm_threads_runnable_count

Gauge

Number of threads in the RUNNABLE state

ds_jvm_threads_terminated_count

Gauge

Number of threads in the TERMINATED state

ds_jvm_threads_timed_waiting_count

Gauge

Number of threads in the TIMED_WAITING state

ds_jvm_threads_waiting_count

Gauge

Number of threads in the WAITING state

ds_max_connections

Gauge

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

ds_replication_changelog_connected_changelogs_current_receive_window{changelog_id,domain_name}

Gauge

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_replication_changelog_connected_changelogs_domain_generation_id{changelog_id,domain_name}

Gauge

Replication domain generation identifier

ds_replication_changelog_connected_changelogs_ssl_encryption{changelog_id,domain_name}

Gauge

Whether SSL encryption is used when exchanging messages with this server

ds_replication_changelog_connected_replicas_current_receive_window{domain_name,server_id}

Gauge

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_replication_changelog_connected_replicas_domain_generation_id{domain_name,server_id}

Gauge

Replication domain generation identifier

ds_replication_changelog_connected_replicas_ssl_encryption{domain_name,server_id}

Gauge

Whether SSL encryption is used when exchanging messages with this server

ds_replication_changelog_domain_generation_id{domain_name}

Gauge

Replication domain generation identifier

ds_replication_changelog_newest_change_number

Gauge

Newest change number present in the change number index database

ds_replication_changelog_oldest_change_number

Gauge

Oldest change number present in the change number index database

ds_replication_changelog_purge_waiting_for_change_number_indexing

Gauge

Indicates whether changelog purging is waiting for change number indexing to advance. If true, check the ds-mon-indexing-state and ds-mon-replicas-preventing-indexing metrics

ds_replication_changelog_replica_dbs_changelog_file_count{domain_name,server_id}

Gauge

The number of changelog files containing updates generated by this replica. A value of zero indicates the replica did not generate any updates during the last purge delay interval

ds_replication_changelog_replica_dbs_newest_csn_timestamp_seconds{domain_name,server_id}

Gauge

Time of the newest CSN present in the replica database

ds_replication_changelog_replica_dbs_oldest_csn_timestamp_seconds{domain_name,server_id}

Gauge

Time of the oldest CSN present in the replica database

ds_replication_replica_current_receive_window{domain_name,server_id}

Gauge

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_replication_replica_domain_generation_id{domain_name,server_id}

Gauge

Replication domain generation identifier

ds_replication_replica_entries_awaiting_updates_count{domain_name,server_id}

Gauge

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

ds_replication_replica_lost_connections{domain_name,server_id}

Gauge

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

ds_replication_replica_remote_replicas_receive_delay_seconds{domain_name,remote_server_id,server_id}

Gauge

Current local delay in receiving replicated operations

ds_replication_replica_remote_replicas_replay_delay_seconds{domain_name,remote_server_id,server_id}

Gauge

Current local delay in replaying replicated operations

ds_replication_replica_remote_replicas_replayed_updates_seconds_count{domain_name,remote_server_id,server_id}

Summary

Replay etime for updates that have been replayed on this replica

ds_replication_replica_remote_replicas_replayed_updates_seconds_sum{domain_name,remote_server_id,server_id}

Summary

Replay etime for updates that have been replayed on this replica

ds_replication_replica_remote_replicas_replayed_updates_seconds{domain_name,remote_server_id,server_id,quantile}

Summary

Replay etime for updates that have been replayed on this replica

ds_replication_replica_remote_replicas_updates_in_progress{domain_name,remote_server_id,server_id}

Gauge

Number of remote updates received in the queue waiting to be replayed

ds_replication_replica_remote_replicas_updates_in_queue{domain_name,remote_server_id,server_id}

Gauge

Number of remote updates received in the queue

ds_replication_replica_replayed_internal_updates_total{domain_name,server_id}

Counter

Number of updates replayed on this replica which modify the internal state but not user data

ds_replication_replica_replayed_internal_updates{domain_name,server_id} (deprecated)

Counter

Number of updates replayed on this replica which modify the internal state but not user data

ds_replication_replica_replayed_updates_conflicts_resolved_total{domain_name,server_id}

Counter

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

ds_replication_replica_replayed_updates_conflicts_resolved{domain_name,server_id} (deprecated)

Counter

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

ds_replication_replica_replayed_updates_conflicts_unresolved_total{domain_name,server_id}

Counter

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

ds_replication_replica_replayed_updates_conflicts_unresolved{domain_name,server_id} (deprecated)

Counter

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

ds_replication_replica_replayed_updates_seconds_count{domain_name,server_id}

Summary

Replay etime for updates that have been replayed on this replica

ds_replication_replica_replayed_updates_seconds_sum{domain_name,server_id}

Summary

Replay etime for updates that have been replayed on this replica

ds_replication_replica_replayed_updates_seconds{domain_name,server_id,quantile}

Summary

Replay etime for updates that have been replayed on this replica

ds_replication_replica_sent_updates_total{domain_name,server_id}

Counter

Number of replication updates sent by this replica

ds_replication_replica_ssl_encryption{domain_name,server_id}

Gauge

Whether SSL encryption is used when exchanging messages with this server

ds_replication_replica_status_last_changed_seconds{domain_name,server_id}

Gauge

Last time the replication status of the local replica changed

ds_replication_replica_status{domain_name,server_id,status}

Gauge

Status of the specified replica

ds_replication_replica_total_update_entry_count{domain_name,server_id}

Gauge

The total number of entries to be processed when a total update is in progress

ds_replication_replica_total_update_entry_left{domain_name,server_id}

Gauge

The number of entries still to be processed when a total update is in progress

ds_replication_replica_updates_already_in_progress_total{domain_name,server_id}

Counter

Number of duplicate updates: updates received by this replica which cannot be applied because they are already in progress. Can happen when a directory server fails over to another replication server

ds_replication_replica_updates_already_in_progress{domain_name,server_id} (deprecated)

Counter

Number of duplicate updates: updates received by this replica which cannot be applied because they are already in progress. Can happen when a directory server fails over to another replication server

ds_replication_replica_updates_inbound_queue{domain_name,server_id}

Gauge

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

ds_replication_replica_updates_outbound_queue{domain_name,server_id}

Gauge

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

ds_start_time_seconds

Gauge

Time the Directory Server started

ds_static_group_size_bucket{le}

Gauge

Number of static groups with at most the specified number of members

ds_subentries_count{type}

Gauge

Total number of LDAP subentries of the specified type

ds_topology_servers_server_is_local{server_id}

Gauge

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

ds_total_connections

Gauge

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

ds_work_queue_requests_in_queue

Gauge

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

ds_work_queue_requests_submitted_count

Summary

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

ds_work_queue_requests_submitted_sum

Summary

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