|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.unboundidds.monitors.MonitorEntry
com.unboundid.ldap.sdk.unboundidds.monitors.MemoryUsageMonitorEntry
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class MemoryUsageMonitorEntry
NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.This class defines a monitor entry that provides information about the memory usage for the JVM in which the Directory Server is running. In particular, it reports information about the memory pools and garbage collectors defined in the JVM. The information that may be available in the memory usage monitor entry includes:
MonitorManager.getMemoryUsageMonitorEntry(com.unboundid.ldap.sdk.LDAPConnection)
method.
This entry provides specific methods for accessing information about JVM
memory usage (e.g., the getMemoryPoolNames()
method can be used to retrieve the names of the memory pool). 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 Summary | |
---|---|
MemoryUsageMonitorEntry(Entry entry)
Creates a new memory usage monitor entry from the provided entry. |
Method Summary | |
---|---|
java.lang.Long |
getAverageCollectionDuration(java.lang.String collectorName)
Retrieves the average garbage collection duration (in milliseconds) for the specified collector. |
java.util.Map<java.lang.String,java.lang.Long> |
getAverageCollectionDurations()
Retrieves a map containing the average garbage collection duration (in milliseconds) per garbage collector. |
java.util.Map<java.lang.String,java.lang.Long> |
getBytesUsedAfterLastCollection()
Retrieves a map containing the number of bytes used after the last garbage collection per memory pool. |
java.lang.Long |
getBytesUsedAfterLastCollection(java.lang.String poolName)
Retrieves the number of bytes used after the last garbage collection for the specified memory pool. |
java.util.Map<java.lang.String,java.lang.Long> |
getCurrentBytesUsed()
Retrieves a map containing the current number of bytes used per memory pool. |
java.lang.Long |
getCurrentBytesUsed(java.lang.String poolName)
Retrieves the current number of bytes used for the specified memory pool. |
java.lang.Long |
getCurrentReservedMemoryMB()
Retrieves the amount of memory (in megabytes) that is currently allocated for use by the JVM. |
java.util.Map<java.lang.Long,java.lang.Long> |
getDetectedPauseCounts()
Retrieves the number of pauses of various durations detected by the server. |
java.lang.Long |
getFreeReservedMemoryMB()
Retrieves the amount of memory (in megabytes) allocated for use by the JVM that is not currently in use for holding Java objects. |
java.util.List<java.lang.String> |
getGarbageCollectorNames()
Retrieves the names of the garbage collectors for which information is available. |
java.lang.Long |
getMaxDetectedPauseTimeMillis()
Retrieves the duration of the longest pause detected by the server. |
java.lang.Long |
getMaxReservableMemoryMB()
Retrieves the maximum amount of memory (in megabytes) that may be allocated and used by the JVM. |
java.util.List<java.lang.String> |
getMemoryPoolNames()
Retrieves the names of the memory pools for which information is available. |
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 |
getNonHeapMemoryBytesUsed()
Retrieves the amount of non-heap memory consumed by the JVM. |
java.lang.Long |
getPercentageOfCommittedTenuredMemoryUsedByMemoryConsumers()
Retrieves the percentage of the committed amount of tenured memory that is used by memory consumers (assuming that all memory used by memory consumers is contained in the tenured generation). |
java.lang.Long |
getPercentageOfMaximumTenuredMemoryUsedByMemoryConsumers()
Retrieves the percentage of the maximum allowed amount of tenured memory that is used by memory consumers (assuming that all memory used by memory consumers is contained in the tenured generation). |
java.lang.Long |
getRecentCollectionDuration(java.lang.String collectorName)
Retrieves the duration (in milliseconds) of the most recent garbage collection for the specified collector. |
java.util.Map<java.lang.String,java.lang.Long> |
getRecentCollectionDurations()
Retrieves a map containing the most recent garbage collection duration (in milliseconds) per garbage collector. |
java.lang.Long |
getReservedMemoryPercentFull()
Retrieves the percent of the currently-reserved memory that is actually in use by the JVM for storing Java objects. |
java.lang.Long |
getTotalBytesUsedByMemoryConsumers()
Retrieves the total amount of memory in bytes held by memory consumers. |
java.lang.Long |
getTotalCollectionCount(java.lang.String collectorName)
Retrieves the total number of garbage collections performed by the specified collector. |
java.util.Map<java.lang.String,java.lang.Long> |
getTotalCollectionCounts()
Retrieves a map containing the total number of garbage collections performed per collector. |
java.lang.Long |
getTotalCollectionDuration(java.lang.String collectorName)
Retrieves the total length of time (in milliseconds) spent performing garbage collection for the specified collector. |
java.util.Map<java.lang.String,java.lang.Long> |
getTotalCollectionDurations()
Retrieves a map containing the total length of time (in milliseconds) spent performing garbage collection per collector. |
java.lang.Long |
getUsedReservedMemoryMB()
Retrieves the amount of memory (in megabytes) allocated for use by the JVM that is currently in use for holding Java objects. |
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.monitors.MonitorEntry |
---|
addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, decode, getBoolean, getDate, getDN, getDouble, getEntry, getInteger, getLong, getMonitorClass, getMonitorName, getString, getStrings, toString, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public MemoryUsageMonitorEntry(Entry entry)
entry
- The entry to be parsed as a memory usage monitor entry. It
must not be null
.Method Detail |
---|
public java.lang.Long getMaxReservableMemoryMB()
null
if this was not included in
the monitor entry.public java.lang.Long getCurrentReservedMemoryMB()
null
if this was not included in
the monitor entry.public java.lang.Long getUsedReservedMemoryMB()
null
if this was not included in the monitor entry.public java.lang.Long getFreeReservedMemoryMB()
null
if this was not included in the monitor entry.public java.lang.Long getReservedMemoryPercentFull()
public java.util.List<java.lang.String> getGarbageCollectorNames()
public java.util.List<java.lang.String> getMemoryPoolNames()
public java.util.Map<java.lang.String,java.lang.Long> getTotalCollectionCounts()
public java.lang.Long getTotalCollectionCount(java.lang.String collectorName)
collectorName
- The name of the garbage collector for which to
retrieve the information.
null
if that information is not available.public java.util.Map<java.lang.String,java.lang.Long> getTotalCollectionDurations()
public java.lang.Long getTotalCollectionDuration(java.lang.String collectorName)
collectorName
- The name of the garbage collector for which to
retrieve the information.
null
if
that information is not available.public java.util.Map<java.lang.String,java.lang.Long> getAverageCollectionDurations()
public java.lang.Long getAverageCollectionDuration(java.lang.String collectorName)
collectorName
- The name of the garbage collector for which to
retrieve the information.
null
if that information is not
available.public java.util.Map<java.lang.String,java.lang.Long> getRecentCollectionDurations()
public java.lang.Long getRecentCollectionDuration(java.lang.String collectorName)
collectorName
- The name of the garbage collector for which to
retrieve the information.
null
if that
information is not available.public java.util.Map<java.lang.String,java.lang.Long> getCurrentBytesUsed()
public java.lang.Long getCurrentBytesUsed(java.lang.String poolName)
poolName
- The name of the memory pool for which to retrieve the
information.
null
if that information is not available.public java.util.Map<java.lang.String,java.lang.Long> getBytesUsedAfterLastCollection()
public java.lang.Long getBytesUsedAfterLastCollection(java.lang.String poolName)
poolName
- The name of the memory pool for which to retrieve the
information.
null
if that information is not
available.public java.lang.Long getNonHeapMemoryBytesUsed()
null
if that information is not available.public java.lang.Long getTotalBytesUsedByMemoryConsumers()
null
if that information is not available.public java.lang.Long getPercentageOfMaximumTenuredMemoryUsedByMemoryConsumers()
null
if that
information is not available.public java.lang.Long getPercentageOfCommittedTenuredMemoryUsedByMemoryConsumers()
null
if that information is
not available.public java.util.Map<java.lang.Long,java.lang.Long> getDetectedPauseCounts()
public java.lang.Long getMaxDetectedPauseTimeMillis()
null
if that information is not available.public java.lang.String getMonitorDisplayName()
getMonitorDisplayName
in class MonitorEntry
public java.lang.String getMonitorDescription()
getMonitorDescription
in class MonitorEntry
public java.util.Map<java.lang.String,MonitorAttribute> getMonitorAttributes()
getMonitorAttributes
in class MonitorEntry
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |