@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class JEEnvironmentMonitorEntry extends MonitorEntry
NOTE: This class, and other classes within the
com.unboundid.ldap.sdk.unboundidds
package structure, are only
supported for use against Ping Identity, UnboundID, and
Nokia/Alcatel-Lucent 8661 server products. These classes provide support
for proprietary functionality or for external specifications that are not
considered stable or mature enough to be guaranteed to work in an
interoperable way with other types of LDAP servers.
MonitorManager.getJEEnvironmentMonitorEntries(com.unboundid.ldap.sdk.LDAPConnection)
method. These entries provide specific methods for accessing information
about the JE environment (e.g., the
getJEVersion()
method can be used to retrieve
the Berkeley DB JE version). Alternately, this information may be accessed
using the generic API. See the MonitorManager
class documentation
for an example that demonstrates the use of the generic API for accessing
monitor data.Constructor and Description |
---|
JEEnvironmentMonitorEntry(Entry entry)
Creates a new JE environment monitor entry from the provided entry.
|
Modifier and Type | Method and Description |
---|---|
java.lang.Boolean |
checkpointInProgress()
Indicates whether a checkpoint is currently in progress in the associated
backend.
|
java.lang.Long |
getActiveTransactionCount()
Retrieves the number of active transactions in the JE database environment.
|
java.lang.Long |
getAverageCheckpointDurationMillis()
Retrieves the average duration in milliseconds of all checkpoints completed
in the associated backend.
|
java.lang.String |
getBackendID()
Retrieves the backend ID for the backend with which the Berkeley DB JE
database is associated.
|
java.lang.Long |
getCleanerBacklog()
Retrieves the number of log files that the cleaner needs to examine.
|
java.lang.Long |
getCurrentDBCacheSize()
Retrieves the amount of memory in bytes currently consumed by the database
cache.
|
java.lang.Long |
getDBCachePercentFull()
Retrieves the percentage of the maximum database cache size that is
currently in use.
|
java.lang.String |
getDBDirectory()
Retrieves the path to the directory containing the database files.
|
java.lang.Long |
getDBOnDiskSize()
Retrieves the amount of disk space in bytes consumed by the database files.
|
java.lang.String |
getEnvironmentStat(java.lang.String statName)
Retrieves the string representation of the value for a database environment
statistic.
|
java.util.Map<java.lang.String,java.lang.String> |
getEnvironmentStats()
Retrieves a set of general environment statistics for the database
environment, mapped from the statistic name to the string representation of
its value.
|
java.lang.String |
getJEVersion()
Retrieves the Berkeley DB JE version string for the database environment
of the associated backend.
|
java.lang.Long |
getLastCheckpointDurationMillis()
Retrieves the duration in milliseconds of the last checkpoint completed in
the associated backend.
|
java.util.Date |
getLastCheckpointStartTime()
Retrieves the time that the last completed checkpoint began.
|
java.util.Date |
getLastCheckpointStopTime()
Retrieves the time that the last completed checkpoint ended.
|
java.util.Date |
getLastCheckpointTime()
Deprecated.
Use
getLastCheckpointStopTime() instead. |
java.lang.String |
getLockStat(java.lang.String statName)
Retrieves the string representation of the value for a database environment
lock statistic.
|
java.util.Map<java.lang.String,java.lang.String> |
getLockStats()
Retrieves a set of lock statistics for the database environment, mapped
from the statistic name to the string representation of its value.
|
java.lang.Long |
getMaxDBCacheSize()
Retrieves the maximum amount of memory in bytes that may be consumed by the
database cache.
|
java.lang.Long |
getMillisSinceLastCheckpoint()
Retrieves the length of time in milliseconds since the last completed
checkpoint.
|
java.util.Map<java.lang.String,MonitorAttribute> |
getMonitorAttributes()
Retrieves the set of parsed monitor attributes for this monitor entry,
mapped from a unique identifier (in all lowercase characters) to the
corresponding monitor attribute.
|
java.lang.String |
getMonitorDescription()
Retrieves a human-readable description name for this monitor entry.
|
java.lang.String |
getMonitorDisplayName()
Retrieves a human-readable display name for this monitor entry.
|
java.lang.Long |
getNodesEvicted()
Retrieves the number of nodes that have been evicted from the database
cache since the backend was started.
|
java.lang.Long |
getNumCheckpoints()
Retrieves the number of checkpoints completed in the associated backend.
|
java.lang.Long |
getRandomReads()
Retrieves the number of random-access disk reads performed since the
backend was started.
|
java.lang.Long |
getRandomWrites()
Retrieves the number of random-access disk writes performed since the
backend was started.
|
java.lang.Long |
getReadLocksHeld()
Retrieves the number of read locks held in the JE database environment.
|
java.lang.Long |
getSequentialReads()
Retrieves the number of sequential disk reads performed since the backend
was started.
|
java.lang.Long |
getSequentialWrites()
Retrieves the number of sequential disk writes performed since the backend
was started.
|
java.lang.Long |
getTotalCheckpointDurationMillis()
Retrieves the total duration in milliseconds of all checkpoints completed
in the associated backend.
|
java.lang.String |
getTransactionStat(java.lang.String statName)
Retrieves the string representation of the value for a database environment
transaction statistic.
|
java.util.Map<java.lang.String,java.lang.String> |
getTransactionStats()
Retrieves a set of transaction statistics for the database environment,
mapped from the statistic name to the string representation of its value.
|
java.lang.Long |
getTransactionsWaitingOnLocks()
Retrieves the number of transactions currently waiting on a lock in the
database environment.
|
java.lang.Long |
getWriteLocksHeld()
Retrieves the number of write locks held in the JE database environment.
|
addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, decode, getBoolean, getDate, getDN, getDouble, getEntry, getInteger, getLong, getMonitorClass, getMonitorName, getString, getStrings, toString, toString
public JEEnvironmentMonitorEntry(@NotNull Entry entry)
entry
- The entry to be parsed as a JE environment monitor entry.
It must not be null
.@Nullable public java.lang.String getBackendID()
@Nullable public java.lang.String getJEVersion()
null
if it was not included in
the monitor entry.@Nullable public java.lang.String getDBDirectory()
null
if it was not included in the monitor entry.@Nullable public java.lang.Long getDBOnDiskSize()
null
if it was not included in the monitor entry.@Nullable public java.lang.Long getCurrentDBCacheSize()
null
if it was not included in the monitor
entry.@Nullable public java.lang.Long getMaxDBCacheSize()
null
if it was not included in the
monitor entry.@Nullable public java.lang.Long getDBCachePercentFull()
null
if it was not included in the
monitor entry.@Nullable public java.lang.Boolean checkpointInProgress()
Boolean
value indicating whether a checkpoint is
currently in progress in the associated backend, or null
if it was not included in the monitor entry.@Nullable public java.lang.Long getNumCheckpoints()
null
if it was not included in the monitor entry.@Nullable public java.lang.Long getTotalCheckpointDurationMillis()
null
if it was not included in
the monitor entry.@Nullable public java.lang.Long getAverageCheckpointDurationMillis()
null
if it was not included
in the monitor entry.@Nullable public java.lang.Long getLastCheckpointDurationMillis()
null
if it was not included
in the monitor entry.@Nullable public java.util.Date getLastCheckpointStartTime()
null
if it was not included in the monitor entry.@Nullable public java.util.Date getLastCheckpointStopTime()
null
if it was not included in the monitor entry.@Deprecated @Nullable public java.util.Date getLastCheckpointTime()
getLastCheckpointStopTime()
instead.null
if it
was not included in the monitor entry.@Nullable public java.lang.Long getMillisSinceLastCheckpoint()
null
if it was not included in the monitor
entry.@Nullable public java.lang.Long getCleanerBacklog()
null
if it was not included in the monitor entry.@Nullable public java.lang.Long getNodesEvicted()
null
if it was not
included in the monitor entry.@Nullable public java.lang.Long getRandomReads()
null
if it was not included in the monitor
entry.@Nullable public java.lang.Long getRandomWrites()
null
if it was not included in the
monitor entry.@Nullable public java.lang.Long getSequentialReads()
null
if it was not included in the monitor
entry.@Nullable public java.lang.Long getSequentialWrites()
null
if it was not included in the monitor
entry.@Nullable public java.lang.Long getActiveTransactionCount()
null
if it was not included in the monitor entry.@Nullable public java.lang.Long getReadLocksHeld()
null
if it was not included in the monitor entry.@Nullable public java.lang.Long getWriteLocksHeld()
null
if it was not included in the monitor entry.@Nullable public java.lang.Long getTransactionsWaitingOnLocks()
null
if it was not included in
the monitor entry.@NotNull public java.util.Map<java.lang.String,java.lang.String> getEnvironmentStats()
@Nullable public java.lang.String getEnvironmentStat(@NotNull java.lang.String statName)
statName
- The name of the statistic to retrieve. It will be
treated in a case-insensitive manner.null
if no such statistic was provided.@NotNull public java.util.Map<java.lang.String,java.lang.String> getLockStats()
@Nullable public java.lang.String getLockStat(@NotNull java.lang.String statName)
statName
- The name of the statistic to retrieve. It will be
treated in a case-insensitive manner.null
if no such statistic was provided.@NotNull public java.util.Map<java.lang.String,java.lang.String> getTransactionStats()
@Nullable public java.lang.String getTransactionStat(@NotNull java.lang.String statName)
statName
- The name of the statistic to retrieve. It will be
treated in a case-insensitive manner.null
if no such statistic was provided.@NotNull public java.lang.String getMonitorDisplayName()
getMonitorDisplayName
in class MonitorEntry
@NotNull public java.lang.String getMonitorDescription()
getMonitorDescription
in class MonitorEntry
@NotNull public java.util.Map<java.lang.String,MonitorAttribute> getMonitorAttributes()
getMonitorAttributes
in class MonitorEntry