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.

Nested Class Summary

Nested classes/interfaces inherited from class org.opends.server.monitors.LocalBackendMonitor

LocalBackendMonitor.BaseDnMonitorData

Field Summary

Fields inherited from class org.opends.server.api.MonitorProvider

registry

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PluggableBackendMonitor(BackendImpl<?> backend, ServerContext serverContext)	Creates a new pluggable backend monitor instance associated to the provided backend.

Method Summary

Modifier and Type	Method	Description
protected void	addAdditionalMetrics()	Adds additional metrics specific to the local backend implementation in this monitor provider's MeterRegistry.
protected void	addAdditionalPluggableMetrics()	Adds additional metrics specific to the pluggable backend implementation in this monitor provider's MeterRegistry.
protected void	addMonitorObjectClassNames(Attribute ocAttr)	Adds to the provided attribute the objectclass names that should be included in the monitor entry created from this monitor provider.
protected abstract String	getBackendType()	Returns the local backend implementation type.

Methods inherited from class org.opends.server.monitors.LocalBackendMonitor

bindTo, computeMonitorInstanceDn, deregisterBaseDnMonitors, getBaseDnMonitorData, getLocalBackend, registerBaseDnMonitors, updateBaseDnMonitors

Methods inherited from class org.opends.server.api.MonitorProvider

configurationDnToMonitorDn, deregisterAll, getMonitorEntry, getMonitorInstanceDn, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

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 Detail

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.