Interface PrometheusEndpointCfg
-
- All Superinterfaces:
Configuration
,HttpEndpointCfg
public interface PrometheusEndpointCfg extends HttpEndpointCfg
A server-side interface for querying Prometheus HTTP Endpoint settings.The Prometheus HTTP Endpoint exposes OpenDJ's monitoring metrics using Prometheus text format.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addPrometheusEndpointChangeListener(ConfigurationChangeListener<PrometheusEndpointCfg> listener)
Register to be notified when this Prometheus HTTP Endpoint is changed.Class<? extends PrometheusEndpointCfg>
configurationClass()
Gets the configuration class associated with this Prometheus HTTP Endpoint.SortedSet<String>
getExcludedMetricPattern()
Gets the "excluded-metric-pattern" property.SortedSet<String>
getIncludedMetricPattern()
Gets the "included-metric-pattern" property.String
getJavaClass()
Gets the "java-class" property.void
removePrometheusEndpointChangeListener(ConfigurationChangeListener<PrometheusEndpointCfg> listener)
Deregister an existing Prometheus HTTP Endpoint configuration change listener.-
Methods inherited from interface org.forgerock.opendj.config.Configuration
dn, name
-
Methods inherited from interface org.forgerock.opendj.server.config.server.HttpEndpointCfg
addChangeListener, getAuthorizationMechanism, getAuthorizationMechanismDns, getBasePath, isEnabled, removeChangeListener
-
-
-
-
Method Detail
-
configurationClass
Class<? extends PrometheusEndpointCfg> configurationClass()
Gets the configuration class associated with this Prometheus HTTP Endpoint.- Specified by:
configurationClass
in interfaceConfiguration
- Specified by:
configurationClass
in interfaceHttpEndpointCfg
- Returns:
- Returns the configuration class associated with this Prometheus HTTP Endpoint.
-
addPrometheusEndpointChangeListener
void addPrometheusEndpointChangeListener(ConfigurationChangeListener<PrometheusEndpointCfg> listener)
Register to be notified when this Prometheus HTTP Endpoint is changed.- Parameters:
listener
- The Prometheus HTTP Endpoint configuration change listener.
-
removePrometheusEndpointChangeListener
void removePrometheusEndpointChangeListener(ConfigurationChangeListener<PrometheusEndpointCfg> listener)
Deregister an existing Prometheus HTTP Endpoint configuration change listener.- Parameters:
listener
- The Prometheus HTTP Endpoint configuration change listener.
-
getExcludedMetricPattern
SortedSet<String> getExcludedMetricPattern()
Gets the "excluded-metric-pattern" property.Zero or more regular expressions identifying metrics that should not be published. The metric name prefix must not be included in the filter. Exclusion patterns take precedence over inclusion patterns.
Default value is undefined
- Returns:
- Returns an unmodifiable set containing the values of the "excluded-metric-pattern" property.
-
getIncludedMetricPattern
SortedSet<String> getIncludedMetricPattern()
Gets the "included-metric-pattern" property.Zero or more regular expressions identifying metrics that should be published. The metric name prefix must not be included in the filter. Exclusion patterns take precedence over inclusion patterns.
Default value is undefined
- Returns:
- Returns an unmodifiable set containing the values of the "included-metric-pattern" property.
-
getJavaClass
String getJavaClass()
Gets the "java-class" property.Specifies the fully-qualified name of the Java class that provides the Prometheus HTTP Endpoint implementation.
Default value:
org.opends.server.protocols.http.PrometheusEndpoint
- Specified by:
getJavaClass
in interfaceHttpEndpointCfg
- Returns:
- Returns the value of the "java-class" property.
-
-