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.
Prometheus HTTP Endpoint properties
You can use configuration expressions to set property values at startup time. For details, see Property value substitution.
| Basic Properties | Advanced Properties |
|---|---|
authorization-mechanism |
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/en/java/javase/17/docs/api/java.base/java/util/regex/Pattern.html for documentation about this class for Java 17). |
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/en/java/javase/17/docs/api/java.base/java/util/regex/Pattern.html for documentation about this class for Java 17). |
Multi-valued |
Yes |
Required |
No |
Admin action required |
None |
Advanced |
No |
Read-only |
No |
legacy-format (DEPRECATED)
|
DEPRECATED for removal since 7.5.0: The legacy format used before 7.5 prevents some third party vendors from consuming the metrics. Alternative: Switch to use the Prometheus compliant output format for better interoperability. |
Synopsis |
Change the output format between one that is compliant with the Prometheus text format and one that is compatible with the (non-compliant) legacy format used before OpenDJ 7.5. |
Description |
The legacy format used before OpenDJ 7.5 is not compliant with the Prometheus text format 0.0.4 and cannot be consumed by some third party tools including the OpenTelemetry Collector. |
Default value |
false |
Allowed values |
true false |
Multi-valued |
No |
Required |
No |
Admin action required |
None |
Advanced |
No |
Read-only |
No |
Advanced properties
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:
|
Multi-valued |
No |
Required |
Yes |
Admin action required |
None |
Advanced |
Yes |
Read-only |
No |