Package org.opends.server.protocols.http

Class PrometheusEndpoint

java.lang.Object

org.opends.server.api.HttpEndpoint<PrometheusEndpointCfg>

org.opends.server.protocols.http.PrometheusEndpoint

public final class PrometheusEndpoint
extends HttpEndpoint<PrometheusEndpointCfg>

Represents an HTTP endpoint exposing OpenDJ metrics using Prometheus text format.

Field Summary

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

configuration, serverContext, USE_DEFAULT_BUFFER_FACTORY

Constructor Summary

Constructors

Constructor	Description
PrometheusEndpoint(PrometheusEndpointCfg configuration, ServerContext serverContext)	Creates a new PrometheusEndpoint.

Method Summary

Modifier and Type	Method	Description
boolean	isConfigurationValid(List<LocalizableMessage> unacceptableReasons)	Check that the configuration of this HttpEndpoint is valid.
org.forgerock.http.HttpApplication	newHttpApplication()	Create a new HttpApplication.

Methods inherited from class java.lang.Object

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

Constructor Detail

PrometheusEndpoint

public PrometheusEndpoint(PrometheusEndpointCfg configuration,
                          ServerContext serverContext)

Creates a new PrometheusEndpoint.

Parameters:

configuration - The configuration to use.

serverContext - The ServerContext which will be used for retrieving the server's metrics.

Method Detail

newHttpApplication

public org.forgerock.http.HttpApplication newHttpApplication()

Description copied from class: HttpEndpoint

Create a new HttpApplication.

Specified by:

newHttpApplication in class HttpEndpoint<PrometheusEndpointCfg>

Returns:

an HttpApplication configured and ready to be started.

isConfigurationValid

public boolean isConfigurationValid(List<LocalizableMessage> unacceptableReasons)

Description copied from class: HttpEndpoint

Check that the configuration of this HttpEndpoint is valid. This default implementation try to instantiate and start the underlying HttpApplication.

Overrides:

isConfigurationValid in class HttpEndpoint<PrometheusEndpointCfg>

Parameters:

unacceptableReasons - A list that can be used to hold messages about why the configuration is not acceptable.

Returns:

true if the configuration is valid.