Package org.opends.server.backends.pluggable

Class PluggableBackendMonitor

java.lang.Object
org.opends.server.api.MonitorProvider
org.opends.server.monitors.LocalBackendMonitor<BackendImpl<?>>
org.opends.server.backends.pluggable.PluggableBackendMonitor
All Implemented Interfaces:
MeterBinder
public abstract class PluggableBackendMonitor extends LocalBackendMonitor<BackendImpl<?>>
A monitor provider for high level backend statistics, such as filter stats and search counters.

  • Constructor Details

    • PluggableBackendMonitor

      protected PluggableBackendMonitor(BackendImpl<?> backend, ServerContext serverContext)
      Creates a new pluggable backend monitor instance associated to the provided backend.
      Parameters:
      backend - The backend monitored.
      serverContext - The server context

  • Method Details

    • addMonitorObjectClassNames

      protected void addMonitorObjectClassNames(Attribute ocAttr)
      Description copied from class: MonitorProvider
      Adds to the provided attribute the objectclass names that should be included in the monitor entry created from this monitor provider. This method should be implemented by child classes to make it easier to search for monitor entries of a specific type.
      Overrides:
      addMonitorObjectClassNames in class LocalBackendMonitor<BackendImpl<?>>
      Parameters:
      ocAttr - the objectClass attribute where to add the object class names

    • getBackendType

      protected abstract String getBackendType()
      Description copied from class: LocalBackendMonitor
      Returns the local backend implementation type.
      Overrides:
      getBackendType in class LocalBackendMonitor<BackendImpl<?>>
      Returns:
      A string used in this monitor provider's MeterRegistry representing the local backend type.

    • addAdditionalMetrics

      protected final void addAdditionalMetrics()
      Description copied from class: LocalBackendMonitor
      Adds additional metrics specific to the local backend implementation in this monitor provider's MeterRegistry.

      The default implementation is to do nothing.

      Overrides:
      addAdditionalMetrics in class LocalBackendMonitor<BackendImpl<?>>

    • addAdditionalPluggableMetrics

      protected void addAdditionalPluggableMetrics()
      Adds additional metrics specific to the pluggable backend implementation in this monitor provider's MeterRegistry.

      The default implementation is to do nothing.