Prometheus HTTP Endpoint

The Prometheus HTTP Endpoint exposes OpenDJ's monitoring metrics using Prometheus text format.

Parent

The Prometheus HTTP Endpoint object inherits from HTTP Endpoint.

You can use configuration expressions to set property values at startup time. For details, see Property Value Substitution.

Basic Properties

Advanced Properties

authorization-mechanism

Synopsis	The HTTP authorization mechanisms supported by this HTTP Endpoint.
Default Value	None
Allowed Values	The name of an existing HTTP Authorization Mechanism . The referenced authorization mechanism must be enabled when the HTTP Endpoint is enabled.
Multi-valued	Yes
Required	Yes
Admin Action Required	None
Advanced	No
Read-Only	No

base-path

Synopsis	All HTTP requests matching the base path or subordinate to it will be routed to the HTTP endpoint unless a more specific HTTP endpoint is found.
Default Value	None
Allowed Values	A string.
Multi-valued	No
Required	Yes
Admin Action Required	None
Advanced	No
Read-Only	Yes

enabled

Synopsis	Indicates whether the HTTP Endpoint is enabled.
Default Value	None
Allowed Values	true false
Multi-valued	No
Required	Yes
Admin Action Required	None
Advanced	No
Read-Only	No

excluded-metric-pattern

Synopsis	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	None
Allowed Values	Any valid regular expression pattern which is supported by the java.util.regex.Pattern class (see https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html for documentation about this class for Java SE 8).
Multi-valued	Yes
Required	No
Admin Action Required	None
Advanced	No
Read-Only	No

included-metric-pattern

Synopsis	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	None
Allowed Values	Any valid regular expression pattern which is supported by the java.util.regex.Pattern class (see https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html for documentation about this class for Java SE 8).
Multi-valued	Yes
Required	No
Admin Action Required	None
Advanced	No
Read-Only	No

Use the --advanced option to access advanced properties.

java-class

Synopsis	Specifies the fully-qualified name of the Java class that provides the Prometheus HTTP Endpoint implementation.
Default Value	org.opends.server.protocols.http.PrometheusEndpoint
Allowed Values	A Java class that extends or implements: org.opends.server.api.HttpEndpoint
Multi-valued	No
Required	Yes
Admin Action Required	None
Advanced	Yes
Read-Only	No