public class HealthStatusMonitorProvider extends MonitorProvider
MonitorProvider for monitoring the server health status.registry| Constructor and Description |
|---|
HealthStatusMonitorProvider(HealthStatusProvider healthStatusProvider)
Creates a new
HealthStatusMonitorProvider for monitoring the provided HealthStatusProvider. |
| Modifier and Type | Method and Description |
|---|---|
protected void |
addMonitorObjectClassNames(Attribute objectClassAttribute)
Adds to the provided attribute the objectclass names that should be included in the monitor entry created from
this monitor provider.
|
void |
bindTo(MeterRegistry parent)
.
|
protected Dn |
computeMonitorInstanceDn()
Returns the monitor instance DN for this monitor provider.
|
configurationDnToMonitorDn, deregisterAll, getMonitorEntry, getMonitorInstanceDn, toStringpublic HealthStatusMonitorProvider(HealthStatusProvider healthStatusProvider)
HealthStatusMonitorProvider for monitoring the provided HealthStatusProvider.healthStatusProvider - The HealthStatusProvider to be monitored.public void bindTo(MeterRegistry parent)
MonitorProvider
Implementations MUST set the MonitorProvider.registry field by creating a new MeterRegistryHolder, and
specifying the appropriate prefix for the dimensional model and also the hierarchical model if they are
different. This can be done using a parameter on the constructor, or the
MeterRegistryHolder.hierarchicalNamePrefix(String) method. Tags common to all metrics for this monitor
provider can also be set using the MeterRegistryHolder.tag(String, String) method.
Attribute names are then registered by calling factory methods on the MonitorProvider.registry field.
(Please remove the comments when using this code as a template)
public void bindTo(final MeterRegistry parent) {
// create the MeterRegistryHolder wrapping OpenDJ's MeterRegistry
registry = new MeterRegistryHolder("dimensional-name-prefix", parent)
.tag("label", "dimension")
.hierarchicalNamePrefix("hierarchical-name-prefix.dimension");
// register the metrics against the wrapper
registry.numberGauge("gauge", numberSupplier); // use lambdas or method references here
timer = registry.timer("requests-submitted");
// set a different name for the metric in cn=monitor, dimensional model and hierarchical model
Gauge.doubleGauge(dimensionalName, supplier)
.hierarchicalName(hierarchicalName)
.tag(MeterRegistryHolder.TAG_ATTRIBUTE_NAME, "cn-monitor-name") // drop the "ds-mon-" prefix here
.register(registry);
// this gauge will only output to cn=monitor based monitoring endpoints
registry.monitoringGauge("only-visible-in-cn-monitor", supplier);
}
bindTo in interface MeterBinderbindTo in class MonitorProviderprotected Dn computeMonitorInstanceDn()
MonitorProvidercomputeMonitorInstanceDn in class MonitorProviderprotected void addMonitorObjectClassNames(Attribute objectClassAttribute)
MonitorProvideraddMonitorObjectClassNames in class MonitorProviderobjectClassAttribute - the objectClass attribute where to add the object class namesCopyright 2010-2022 ForgeRock AS.