Prometheus metrics reference
The following list puts Prometheus labels in braces.
For example, the labels in ds_backend_db_cache_misses_internal_nodes{backend,type}
are backend
and type
.
For examples of common monitoring requests, see HTTP-based monitoring.
Some |
Name | Type | Description |
---|---|---|
|
Gauge |
Current number of entries held in this cache |
|
Summary |
Number of attempts to retrieve an entry that was not held in this cache |
|
Summary |
Number of attempts to retrieve an entry that was not held in this cache |
|
Summary |
Number of attempts to retrieve an entry from this cache |
|
Summary |
Number of attempts to retrieve an entry from this cache |
|
Gauge |
Number of internal nodes evicted from the database cache |
|
Gauge |
Number of leaf nodes (data records) evicted from the database cache |
|
Gauge |
Whether leaf nodes are cached |
|
Gauge |
Number of internal nodes requested by btree operations that were not in the database cache |
|
Gauge |
Number of leaf nodes (data records) requested by btree operations that were not in the database cache |
|
Gauge |
Size of the database cache |
|
Gauge |
Maximum size of the database cache |
|
Gauge |
Number of internal nodes requested by btree operations |
|
Gauge |
Number of leaf nodes (data records) requested by btree operations |
|
Gauge |
Number of checkpoints run so far |
|
Gauge |
Number of cleaner file deletions |
|
Gauge |
Number of files currently open in the database file cache |
|
Gauge |
Number of times a log file has been opened |
|
Gauge |
Estimate of the amount in bytes of live data in all data files (i.e., the size of the DB, ignoring garbage) |
|
Gauge |
Size used by all data files on disk |
|
Gauge |
Current maximum (upper bound) log utilization as a percentage |
|
Gauge |
Current minimum (lower bound) log utilization as a percentage |
|
Gauge |
Number of degraded indexes in the backend |
|
Gauge |
Number of subordinate entries of the base DN, including the base DN |
|
Gauge |
Number of subordinate entries of the base DN, including the base DN |
|
Histogram |
Histogram of entry sizes being read from the underlying storage |
|
Histogram |
Histogram of entry sizes being written to the underlying storage |
|
Gauge |
Number of indexed searches performed against the backend |
|
Gauge |
Time when recording started for statistical information about the simple search filters processed against the backend |
|
Gauge |
Number of unindexed searches performed against the backend |
|
Summary |
Current number of index reads |
|
Summary |
Total number of index reads |
|
Gauge |
Whether the base DNs of this backend should be considered public or private |
|
Summary |
Summary for entries purged by time-to-live |
|
Summary |
Summary for entries purged by time-to-live |
|
Gauge |
Indicates whether time-to-live is in the process of purging expired entries |
|
Gauge |
Last date and time when time-to-live finished purging expired entries |
|
Gauge |
Number of entries queued for purging by the time-to-live service |
|
Gauge |
Number of active time-to-live threads |
|
Gauge |
Certificate expiration date and time |
|
Gauge |
Number of active client connections |
|
Summary |
Network bytes read summary |
|
Summary |
Network bytes read summary |
|
Summary |
Network bytes written summary |
|
Summary |
Network bytes written summary |
|
Summary |
Delete request timer |
|
Summary |
GET request timer |
|
Summary |
PATCH request timer |
|
Summary |
POST request timer |
|
Summary |
PUT request timer |
|
Summary |
Uncategorized request timer |
|
Summary |
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)) |
|
Summary |
Timer for requests that could not complete because further action is required (associated HTTP status codes: redirection (3xx)) |
|
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) |
|
Summary |
Timer for requests that failed due to uncategorized reasons |
|
Summary |
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)) |
|
Summary |
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)) |
|
Summary |
Timer for requests that could not complete because further action is required (associated HTTP status codes: redirection (3xx)) |
|
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) |
|
Summary |
Timer for requests that failed due to uncategorized reasons |
|
Summary |
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)) |
|
Summary |
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)) |
|
Summary |
Timer for requests that could not complete because further action is required (associated HTTP status codes: redirection (3xx)) |
|
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) |
|
Summary |
Timer for requests that failed due to uncategorized reasons |
|
Summary |
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)) |
|
Summary |
Delete request timer |
|
Summary |
GET request timer |
|
Summary |
PATCH request timer |
|
Summary |
POST request timer |
|
Summary |
PUT request timer |
|
Summary |
Uncategorized request timer |
|
Summary |
Delete request timer |
|
Summary |
GET request timer |
|
Summary |
PATCH request timer |
|
Summary |
POST request timer |
|
Summary |
PUT request timer |
|
Summary |
Uncategorized request timer |
|
Counter |
Total number of abandoned operations since startup |
|
Gauge |
Number of active client connections |
|
Gauge |
Number of active persistent searches |
|
Summary |
Network bytes read summary |
|
Summary |
Network bytes read summary |
|
Summary |
Network bytes written summary |
|
Summary |
Network bytes written summary |
|
Summary |
Connection summary |
|
Summary |
Connection summary |
|
Summary |
Base object search request timer |
|
Summary |
One level search request timer |
|
Summary |
Subtree search request timer |
|
Summary |
Abandon request timer |
|
Summary |
Add request timer |
|
Summary |
Bind request timer |
|
Summary |
Compare request timer |
|
Summary |
Delete request timer |
|
Summary |
Extended request timer |
|
Summary |
Modify DN request timer |
|
Summary |
Modify request timer |
|
Summary |
Unbind request timer |
|
Summary |
Uncategorized request timer |
|
Summary |
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)) |
|
Summary |
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) |
|
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) |
|
Summary |
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) |
|
Summary |
Timer for requests that failed due to uncategorized reasons |
|
Summary |
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)) |
|
Summary |
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)) |
|
Summary |
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) |
|
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) |
|
Summary |
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) |
|
Summary |
Timer for requests that failed due to uncategorized reasons |
|
Summary |
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)) |
|
Summary |
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)) |
|
Summary |
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) |
|
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) |
|
Summary |
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) |
|
Summary |
Timer for requests that failed due to uncategorized reasons |
|
Summary |
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)) |
|
Summary |
Base object search request timer |
|
Summary |
One level search request timer |
|
Summary |
Subtree search request timer |
|
Summary |
Abandon request timer |
|
Summary |
Add request timer |
|
Summary |
Bind request timer |
|
Summary |
Compare request timer |
|
Summary |
Delete request timer |
|
Summary |
Extended request timer |
|
Summary |
Modify DN request timer |
|
Summary |
Modify request timer |
|
Summary |
Unbind request timer |
|
Summary |
Uncategorized request timer |
|
Summary |
Base object search request timer |
|
Summary |
One level search request timer |
|
Summary |
Subtree search request timer |
|
Summary |
Abandon request timer |
|
Summary |
Add request timer |
|
Summary |
Bind request timer |
|
Summary |
Compare request timer |
|
Summary |
Delete request timer |
|
Summary |
Extended request timer |
|
Summary |
Modify DN request timer |
|
Summary |
Modify request timer |
|
Summary |
Unbind request timer |
|
Summary |
Uncategorized request timer |
|
Gauge |
Number of client connections currently established with the Directory Server |
|
Gauge |
Current date and time |
|
Gauge |
Amount of free disk space |
|
Gauge |
Effective full disk space threshold |
|
Gauge |
Effective low disk space threshold |
|
Gauge |
Current number of entries held in this cache |
|
Gauge |
Maximum number of entries allowed in this cache |
|
Gauge |
Memory limit for this cache |
|
Summary |
Number of attempts to retrieve an entry that was not held in this cache |
|
Summary |
Number of attempts to retrieve an entry that was not held in this cache |
|
Summary |
Number of attempts to retrieve an entry from this cache |
|
Summary |
Number of attempts to retrieve an entry from this cache |
|
Gauge |
Indicates whether the server is alive |
|
Gauge |
Indicates whether the server is able to handle requests |
|
Gauge |
Number of processors available to the Java virtual machine |
|
Gauge |
Number of classes loaded since the Java virtual machine started |
|
Gauge |
Number of classes unloaded since the Java virtual machine started |
|
Gauge |
Amount of heap memory that the Java virtual machine initially requested from the operating system |
|
Gauge |
Maximum amount of heap memory that the Java virtual machine will attempt to use |
|
Gauge |
Amount of heap memory that is committed for the Java virtual machine to use |
|
Gauge |
Amount of heap memory used by the Java virtual machine |
|
Gauge |
Amount of memory that the Java virtual machine initially requested from the operating system |
|
Gauge |
Maximum amount of memory that the Java virtual machine will attempt to use |
|
Gauge |
Amount of non-heap memory that the Java virtual machine initially requested from the operating system |
|
Gauge |
Maximum amount of non-heap memory that the Java virtual machine will attempt to use |
|
Gauge |
Amount of non-heap memory that is committed for the Java virtual machine to use |
|
Gauge |
Amount of non-heap memory used by the Java virtual machine |
|
Gauge |
Amount of memory that is committed for the Java virtual machine to use |
|
Gauge |
Amount of memory used by the Java virtual machine |
|
Gauge |
Number of threads in the BLOCKED state |
|
Gauge |
Number of live threads including both daemon and non-daemon threads |
|
Gauge |
Number of live daemon threads |
|
Gauge |
Number of deadlocked threads |
|
Gauge |
Number of threads in the NEW state |
|
Gauge |
Number of threads in the RUNNABLE state |
|
Gauge |
Number of threads in the TERMINATED state |
|
Gauge |
Number of threads in the TIMED_WAITING state |
|
Gauge |
Number of threads in the WAITING state |
|
Gauge |
Maximum number of simultaneous client connections that have been established with the Directory Server |
|
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 |
|
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 |
|
Gauge |
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 |
|
Gauge |
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 |
|
Gauge |
Replication domain generation identifier |
|
Gauge |
Replication domain generation identifier |
|
Gauge |
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 |
|
Gauge |
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 |
|
Gauge |
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 |
|
Gauge |
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 |
|
Gauge |
Missing changes for replication |
|
Gauge |
Missing changes for replication |
|
Gauge |
Whether SSL encryption is used when exchanging messages with this server |
|
Gauge |
Whether SSL encryption is used when exchanging messages with this server |
|
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 |
|
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 |
|
Gauge |
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 |
|
Gauge |
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 |
|
Gauge |
Replication domain generation identifier |
|
Gauge |
Replication domain generation identifier |
|
Gauge |
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 |
|
Gauge |
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 |
|
Gauge |
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 |
|
Gauge |
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 |
|
Gauge |
Whether SSL encryption is used when exchanging messages with this server |
|
Gauge |
Whether SSL encryption is used when exchanging messages with this server |
|
Gauge |
Replication domain generation identifier |
|
Gauge |
Replication domain generation identifier |
|
Gauge |
Missing changes for replication |
|
Gauge |
Missing changes for replication |
|
Gauge |
Newest change number present in the change number index database |
|
Gauge |
Oldest change number present in the change number index database |
|
Gauge |
Timestamp of the newest CSN present in the replica database |
|
Gauge |
Timestamp of the oldest CSN present in the replica database |
|
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 |
|
Gauge |
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 |
|
Gauge |
Replication domain generation identifier |
|
Gauge |
Number of entries for which an update operation has been received but not replayed yet by this replica |
|
Gauge |
Number of times the replica lost its connection to the replication server |
|
Gauge |
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 |
|
Gauge |
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 |
|
Gauge |
Current local delay in receiving replicated operations |
|
Gauge |
Current local delay in receiving replicated operations |
|
Gauge |
Current local delay in replaying replicated operations |
|
Summary |
Timer for updates that have been replayed on this replica |
|
Summary |
Timer for updates that have been replayed on this replica |
|
Summary |
Timer for updates that have been replayed on this replica |
|
Counter |
Number of updates replayed on this replica which modify the internal state but not user data |
|
Counter |
Number of updates replayed on this replica for which replication naming conflicts have been resolved |
|
Counter |
Number of updates replayed on this replica for which replication naming conflicts have not been resolved |
|
Summary |
Timer for updates that have been replayed on this replica |
|
Summary |
Timer for updates that have been replayed on this replica |
|
Summary |
Timer for updates that have been replayed on this replica |
|
Counter |
Number of replication updates sent by this replica |
|
Gauge |
Whether SSL encryption is used when exchanging messages with this server |
|
Gauge |
Last date and time the replication status of the local replica changed |
|
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 |
|
Gauge |
Number of remote updates received from the replication server but not replayed yet on this replica |
|
Gauge |
Number of local updates that are waiting to be sent to the replication server once they complete |
|
Gauge |
Start date and time for the Directory Server |
|
Gauge |
Indicates whether this is the topology server that has handled the monitoring request |
|
Gauge |
Total number of client connections that have been established with the Directory Server since it started |
|
Gauge |
Number of requests in the work queue that have not yet been picked up for processing |
|
Summary |
Summary for operations that have been successfully submitted to the work queue |
|
Summary |
Summary for operations that have been successfully submitted to the work queue |