Package com.unboundid.ldap.sdk.unboundidds.monitors

Class ProcessingTimeHistogramMonitorEntry

java.lang.Object
com.unboundid.ldap.sdk.unboundidds.monitors.MonitorEntry
com.unboundid.ldap.sdk.unboundidds.monitors.ProcessingTimeHistogramMonitorEntry
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
PerApplicationProcessingTimeHistogramMonitorEntry
@NotMutable @NotExtensible @ThreadSafety(level=COMPLETELY_THREADSAFE) public class ProcessingTimeHistogramMonitorEntry extends MonitorEntry
This class defines a monitor entry that provides information about the processing times of operations that are performed in the server. It includes the total counts of each type of operation, the average response time for each type of operation, and counts and percentages of operations whose server-side processing time fits in defined buckets.
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.

The following buckets are defined in the default configuration:
  • Less than 1ms.
  • Greater than or equal to 1ms and less than 2ms.
  • Greater than or equal to 2ms and less than 3ms.
  • Greater than or equal to 3ms and less than 5ms.
  • Greater than or equal to 5ms and less than 10ms.
  • Greater than or equal to 10ms and less than 20ms.
  • Greater than or equal to 20ms and less than 30ms.
  • Greater than or equal to 30ms and less than 50ms.
  • Greater than or equal to 50ms and less than 100ms.
  • Greater than or equal to 100ms and less than 1000ms.
  • Greater than or equal to 1000ms.
It provides the following information for each operation, as well as for the total for all operations:
  • The number of operations of the specified type within each bucket.
  • The percentage of operations of the specified type within each bucket.
  • The aggregate percentage of operations of the specified type for each bucket (i.e., the percentage of operations in that bucket or any bucket for a lower duration).
The server should present at most one processing time histogram monitor entry. It can be retrieved using the MonitorManager.getProcessingTimeHistogramMonitorEntry(com.unboundid.ldap.sdk.LDAPConnection) method. This entry provides specific methods for accessing information about processing times per bucket (e.g., the getAllOpsPercent() method can be used to retrieve a map containing the percent of operations within each bucket). 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.
See Also:

  • Constructor Details

    • ProcessingTimeHistogramMonitorEntry

      public ProcessingTimeHistogramMonitorEntry(@NotNull Entry entry)
      Creates a new processing time histogram monitor entry from the provided entry.
      Parameters:
      entry - The entry to be parsed as a processing time histogram monitor entry. It must not be null.

  • Method Details

    • getAllOpsTotalCount

      @Nullable public final Long getAllOpsTotalCount()
      Retrieves the total number of operations that have been performed in the server.
      Returns:
      The total number of operations that have been performed in the server, or null if it was not included in the monitor entry.

    • getAllOpsAverageResponseTimeMillis

      @Nullable public final Double getAllOpsAverageResponseTimeMillis()
      Retrieves the average response time in milliseconds of all operations of all types performed in the server.
      Returns:
      The average response time in milliseconds of all operations of all types performed in the server, or null if it was not included in the monitor entry.

    • getAllOpsCount

      @NotNull public final Map<Long,Long> getAllOpsCount()
      Retrieves a map with information about the total number of operations of all types within each of the response time buckets. The mapping will be between the lower bound for the processing time bucket in milliseconds and the number of operations whose processing time fell within that bucket.
      Returns:
      A map with information about the total number of operations of all types within each of the response time buckets, or an empty map if it was not included in the monitor entry.

    • getAllOpsPercent

      @NotNull public final Map<Long,Double> getAllOpsPercent()
      Retrieves a map with information about the percentage of operations of all types within each of the response time buckets. The mapping will be between the lower bound for the processing time bucket in milliseconds and the percentage of operations whose processing time fell within that bucket.
      Returns:
      A map with information about the percentage of operations of all types within each of the response time buckets, or an empty map if it was not included in the monitor entry.

    • getAllOpsAggregatePercent

      @NotNull public final Map<Long,Double> getAllOpsAggregatePercent()
      Retrieves a map with information about the aggregate percentage of operations of all types within each of the response time buckets or one of the lower response time buckets. The mapping will be between the lower bound for the processing time bucket in milliseconds and the aggregate percentage of operations whose processing time fell within that or lower response time buckets.
      Returns:
      A map with information about the aggregate percentage of operations of all types within each of the response time buckets, or an empty map if it was not included in the monitor entry.

    • getAddOpsTotalCount

      @Nullable public final Long getAddOpsTotalCount()
      Retrieves the total number of add operations that have been performed in the server.
      Returns:
      The total number of add operations that have been performed in the server, or null if it was not included in the monitor entry.

    • getAddOpsAverageResponseTimeMillis

      @Nullable public final Double getAddOpsAverageResponseTimeMillis()
      Retrieves the average response time in milliseconds of add operations performed in the server.
      Returns:
      The average response time in milliseconds of add operations that have been performed in the server, or null if it was not included in the monitor entry.

    • getAddOpsCount

      @NotNull public final Map<Long,Long> getAddOpsCount()
      Retrieves a map with information about the total number of add operations within each of the response time buckets. The mapping will be between the lower bound for the processing time bucket in milliseconds and the number of operations whose processing time fell within that bucket.
      Returns:
      A map with information about the total number of add operations within each of the response time buckets, or an empty map if it was not included in the monitor entry.

    • getAddOpsPercent

      @NotNull public final Map<Long,Double> getAddOpsPercent()
      Retrieves a map with information about the percentage of add operations within each of the response time buckets. The mapping will be between the lower bound for the processing time bucket in milliseconds and the percentage of operations whose processing time fell within that bucket.
      Returns:
      A map with information about the percentage of add operations within each of the response time buckets, or an empty map if it was not included in the monitor entry.

    • getAddOpsAggregatePercent

      @NotNull public final Map<Long,Double> getAddOpsAggregatePercent()
      Retrieves a map with information about the aggregate percentage of add operations within each of the response time buckets or one of the lower response time buckets. The mapping will be between the lower bound for the processing time bucket in milliseconds and the aggregate percentage of operations whose processing time fell within that or lower response time buckets.
      Returns:
      A map with information about the aggregate percentage of add operations within each of the response time buckets, or an empty map if it was not included in the monitor entry.

    • getBindOpsTotalCount

      @Nullable public final Long getBindOpsTotalCount()
      Retrieves the total number of bind operations that have been performed in the server.
      Returns:
      The total number of bind operations that have been performed in the server, or null if it was not included in the monitor entry.

    • getBindOpsAverageResponseTimeMillis

      @Nullable public final Double getBindOpsAverageResponseTimeMillis()
      Retrieves the average response time in milliseconds of bind operations performed in the server.
      Returns:
      The average response time in milliseconds of bind operations that have been performed in the server, or null if it was not included in the monitor entry.

    • getBindOpsCount

      @NotNull public final Map<Long,Long> getBindOpsCount()
      Retrieves a map with information about the total number of bind operations within each of the response time buckets. The mapping will be between the lower bound for the processing time bucket in milliseconds and the number of operations whose processing time fell within that bucket.
      Returns:
      A map with information about the total number of bind operations within each of the response time buckets, or an empty map if it was not included in the monitor entry.

    • getBindOpsPercent

      @NotNull public final Map<Long,Double> getBindOpsPercent()
      Retrieves a map with information about the percentage of bind operations within each of the response time buckets. The mapping will be between the lower bound for the processing time bucket in milliseconds and the percentage of operations whose processing time fell within that bucket.
      Returns:
      A map with information about the percentage of bind operations within each of the response time buckets, or an empty map if it was not included in the monitor entry.

    • getBindOpsAggregatePercent

      @NotNull public final Map<Long,Double> getBindOpsAggregatePercent()
      Retrieves a map with information about the aggregate percentage of bind operations within each of the response time buckets or one of the lower response time buckets. The mapping will be between the lower bound for the processing time bucket in milliseconds and the aggregate percentage of operations whose processing time fell within that or lower response time buckets.
      Returns:
      A map with information about the aggregate percentage of bind operations within each of the response time buckets, or an empty map if it was not included in the monitor entry.

    • getCompareOpsTotalCount

      @Nullable public final Long getCompareOpsTotalCount()
      Retrieves the total number of compare operations that have been performed in the server.
      Returns:
      The total number of compare operations that have been performed in the server, or null if it was not included in the monitor entry.

    • getCompareOpsAverageResponseTimeMillis

      @Nullable public final Double getCompareOpsAverageResponseTimeMillis()
      Retrieves the average response time in milliseconds of compare operations performed in the server.
      Returns:
      The average response time in milliseconds of compare operations that have been performed in the server, or null if it was not included in the monitor entry.

    • getCompareOpsCount

      @NotNull public final Map<Long,Long> getCompareOpsCount()
      Retrieves a map with information about the total number of compare operations within each of the response time buckets. The mapping will be between the lower bound for the processing time bucket in milliseconds and the number of operations whose processing time fell within that bucket.
      Returns:
      A map with information about the total number of compare operations within each of the response time buckets, or an empty map if it was not included in the monitor entry.

    • getCompareOpsPercent

      @NotNull public final Map<Long,Double> getCompareOpsPercent()
      Retrieves a map with information about the percentage of compare operations within each of the response time buckets. The mapping will be between the lower bound for the processing time bucket in milliseconds and the percentage of operations whose processing time fell within that bucket.
      Returns:
      A map with information about the percentage of compare operations within each of the response time buckets, or an empty map if it was not included in the monitor entry.

    • getCompareOpsAggregatePercent

      @NotNull public final Map<Long,Double> getCompareOpsAggregatePercent()
      Retrieves a map with information about the aggregate percentage of compare operations within each of the response time buckets or one of the lower response time buckets. The mapping will be between the lower bound for the processing time bucket in milliseconds and the aggregate percentage of operations whose processing time fell within that or lower response time buckets.
      Returns:
      A map with information about the aggregate percentage of compare operations within each of the response time buckets, or an empty map if it was not included in the monitor entry.

    • getDeleteOpsTotalCount

      @Nullable public final Long getDeleteOpsTotalCount()
      Retrieves the total number of delete operations that have been performed in the server.
      Returns:
      The total number of delete operations that have been performed in the server, or null if it was not included in the monitor entry.

    • getDeleteOpsAverageResponseTimeMillis

      @Nullable public final Double getDeleteOpsAverageResponseTimeMillis()
      Retrieves the average response time in milliseconds of delete operations performed in the server.
      Returns:
      The average response time in milliseconds of delete operations that have been performed in the server, or null if it was not included in the monitor entry.

    • getDeleteOpsCount

      @NotNull public final Map<Long,Long> getDeleteOpsCount()
      Retrieves a map with information about the total number of delete operations within each of the response time buckets. The mapping will be between the lower bound for the processing time bucket in milliseconds and the number of operations whose processing time fell within that bucket.
      Returns:
      A map with information about the total number of delete operations within each of the response time buckets, or an empty map if it was not included in the monitor entry.

    • getDeleteOpsPercent

      @NotNull public final Map<Long,Double> getDeleteOpsPercent()
      Retrieves a map with information about the percentage of delete operations within each of the response time buckets. The mapping will be between the lower bound for the processing time bucket in milliseconds and the percentage of operations whose processing time fell within that bucket.
      Returns:
      A map with information about the percentage of delete operations within each of the response time buckets, or an empty map if it was not included in the monitor entry.

    • getDeleteOpsAggregatePercent

      @NotNull public final Map<Long,Double> getDeleteOpsAggregatePercent()
      Retrieves a map with information about the aggregate percentage of delete operations within each of the response time buckets or one of the lower response time buckets. The mapping will be between the lower bound for the processing time bucket in milliseconds and the aggregate percentage of operations whose processing time fell within that or lower response time buckets.
      Returns:
      A map with information about the aggregate percentage of delete operations within each of the response time buckets, or an empty map if it was not included in the monitor entry.

    • getExtendedOpsTotalCount

      @Nullable public final Long getExtendedOpsTotalCount()
      Retrieves the total number of extended operations that have been performed in the server.
      Returns:
      The total number of extended operations that have been performed in the server, or null if it was not included in the monitor entry.

    • getExtendedOpsAverageResponseTimeMillis

      @Nullable public final Double getExtendedOpsAverageResponseTimeMillis()
      Retrieves the average response time in milliseconds of extended operations performed in the server.
      Returns:
      The average response time in milliseconds of extended operations that have been performed in the server, or null if it was not included in the monitor entry.

    • getExtendedOpsCount

      @NotNull public final Map<Long,Long> getExtendedOpsCount()
      Retrieves a map with information about the total number of extended operations within each of the response time buckets. The mapping will be between the lower bound for the processing time bucket in milliseconds and the number of operations whose processing time fell within that bucket.
      Returns:
      A map with information about the total number of extended operations within each of the response time buckets, or an empty map if it was not included in the monitor entry.

    • getExtendedOpsPercent

      @NotNull public final Map<Long,Double> getExtendedOpsPercent()
      Retrieves a map with information about the percentage of extended operations within each of the response time buckets. The mapping will be between the lower bound for the processing time bucket in milliseconds and the percentage of operations whose processing time fell within that bucket.
      Returns:
      A map with information about the percentage of extended operations within each of the response time buckets, or an empty map if it was not included in the monitor entry.

    • getExtendedOpsAggregatePercent

      @NotNull public final Map<Long,Double> getExtendedOpsAggregatePercent()
      Retrieves a map with information about the aggregate percentage of extended operations within each of the response time buckets or one of the lower response time buckets. The mapping will be between the lower bound for the processing time bucket in milliseconds and the aggregate percentage of operations whose processing time fell within that or lower response time buckets.
      Returns:
      A map with information about the aggregate percentage of extended operations within each of the response time buckets, or an empty map if it was not included in the monitor entry.

    • getModifyOpsTotalCount

      @Nullable public final Long getModifyOpsTotalCount()
      Retrieves the total number of modify operations that have been performed in the server.
      Returns:
      The total number of modify operations that have been performed in the server, or null if it was not included in the monitor entry.

    • getModifyOpsAverageResponseTimeMillis

      @Nullable public final Double getModifyOpsAverageResponseTimeMillis()
      Retrieves the average response time in milliseconds of modify operations performed in the server.
      Returns:
      The average response time in milliseconds of modify operations that have been performed in the server, or null if it was not included in the monitor entry.

    • getModifyOpsCount

      @NotNull public final Map<Long,Long> getModifyOpsCount()
      Retrieves a map with information about the total number of modify operations within each of the response time buckets. The mapping will be between the lower bound for the processing time bucket in milliseconds and the number of operations whose processing time fell within that bucket.
      Returns:
      A map with information about the total number of modify operations within each of the response time buckets, or an empty map if it was not included in the monitor entry.

    • getModifyOpsPercent

      @NotNull public final Map<Long,Double> getModifyOpsPercent()
      Retrieves a map with information about the percentage of modify operations within each of the response time buckets. The mapping will be between the lower bound for the processing time bucket in milliseconds and the percentage of operations whose processing time fell within that bucket.
      Returns:
      A map with information about the percentage of modify operations within each of the response time buckets, or an empty map if it was not included in the monitor entry.

    • getModifyOpsAggregatePercent

      @NotNull public final Map<Long,Double> getModifyOpsAggregatePercent()
      Retrieves a map with information about the aggregate percentage of modify operations within each of the response time buckets or one of the lower response time buckets. The mapping will be between the lower bound for the processing time bucket in milliseconds and the aggregate percentage of operations whose processing time fell within that or lower response time buckets.
      Returns:
      A map with information about the aggregate percentage of modify operations within each of the response time buckets, or an empty map if it was not included in the monitor entry.

    • getModifyDNOpsCount

      @NotNull public final Map<Long,Long> getModifyDNOpsCount()
      Retrieves a map with information about the total number of modify DN operations within each of the response time buckets. The mapping will be between the lower bound for the processing time bucket in milliseconds and the number of operations whose processing time fell within that bucket.
      Returns:
      A map with information about the total number of modify DN operations within each of the response time buckets, or an empty map if it was not included in the monitor entry.

    • getModifyDNOpsTotalCount

      @Nullable public final Long getModifyDNOpsTotalCount()
      Retrieves the total number of modify DN operations that have been performed in the server.
      Returns:
      The total number of modify DN operations that have been performed in the server, or null if it was not included in the monitor entry.

    • getModifyDNOpsAverageResponseTimeMillis

      @Nullable public final Double getModifyDNOpsAverageResponseTimeMillis()
      Retrieves the average response time in milliseconds of modify DN operations performed in the server.
      Returns:
      The average response time in milliseconds of modify DN operations that have been performed in the server, or null if it was not included in the monitor entry.

    • getModifyDNOpsPercent

      @NotNull public final Map<Long,Double> getModifyDNOpsPercent()
      Retrieves a map with information about the percentage of modify DN operations within each of the response time buckets. The mapping will be between the lower bound for the processing time bucket in milliseconds and the percentage of operations whose processing time fell within that bucket.
      Returns:
      A map with information about the percentage of modify DN operations within each of the response time buckets, or an empty map if it was not included in the monitor entry.

    • getModifyDNOpsAggregatePercent

      @NotNull public final Map<Long,Double> getModifyDNOpsAggregatePercent()
      Retrieves a map with information about the aggregate percentage of modify DN operations within each of the response time buckets or one of the lower response time buckets. The mapping will be between the lower bound for the processing time bucket in milliseconds and the aggregate percentage of operations whose processing time fell within that or lower response time buckets.
      Returns:
      A map with information about the aggregate percentage of modify DN operations within each of the response time buckets, or an empty map if it was not included in the monitor entry.

    • getSearchOpsTotalCount

      @Nullable public final Long getSearchOpsTotalCount()
      Retrieves the total number of search operations that have been performed in the server.
      Returns:
      The total number of search operations that have been performed in the server, or null if it was not included in the monitor entry.

    • getSearchOpsAverageResponseTimeMillis

      @Nullable public final Double getSearchOpsAverageResponseTimeMillis()
      Retrieves the average response time in milliseconds of search operations performed in the server.
      Returns:
      The average response time in milliseconds of search operations that have been performed in the server, or null if it was not included in the monitor entry.

    • getSearchOpsCount

      @NotNull public final Map<Long,Long> getSearchOpsCount()
      Retrieves a map with information about the total number of search operations within each of the response time buckets. The mapping will be between the lower bound for the processing time bucket in milliseconds and the number of operations whose processing time fell within that bucket.
      Returns:
      A map with information about the total number of search operations within each of the response time buckets, or an empty map if it was not included in the monitor entry.

    • getSearchOpsPercent

      @NotNull public final Map<Long,Double> getSearchOpsPercent()
      Retrieves a map with information about the percentage of search operations within each of the response time buckets. The mapping will be between the lower bound for the processing time bucket in milliseconds and the percentage of operations whose processing time fell within that bucket.
      Returns:
      A map with information about the percentage of search operations within each of the response time buckets, or an empty map if it was not included in the monitor entry.

    • getSearchOpsAggregatePercent

      @NotNull public final Map<Long,Double> getSearchOpsAggregatePercent()
      Retrieves a map with information about the aggregate percentage of search operations within each of the response time buckets or one of the lower response time buckets. The mapping will be between the lower bound for the processing time bucket in milliseconds and the aggregate percentage of operations whose processing time fell within that or lower response time buckets.
      Returns:
      A map with information about the aggregate percentage of search operations within each of the response time buckets, or an empty map if it was not included in the monitor entry.

    • getMonitorDisplayName

      @NotNull public String getMonitorDisplayName()
      Retrieves a human-readable display name for this monitor entry.
      Overrides:
      getMonitorDisplayName in class MonitorEntry
      Returns:
      A human-readable display name for this monitor entry.

    • getMonitorDescription

      @NotNull public String getMonitorDescription()
      Retrieves a human-readable description name for this monitor entry.
      Overrides:
      getMonitorDescription in class MonitorEntry
      Returns:
      A human-readable description name for this monitor entry.

    • getMonitorAttributes

      @NotNull public Map<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.
      Overrides:
      getMonitorAttributes in class MonitorEntry
      Returns:
      The set of parsed monitor attributes for this monitor entry.