Package org.forgerock.opendj.server.config.client

Interface PrometheusEndpointCfgClient

All Superinterfaces:
ConfigurationClient, HttpEndpointCfgClient
public interface PrometheusEndpointCfgClient extends HttpEndpointCfgClient
A client-side interface for reading and modifying Prometheus HTTP Endpoint settings.

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

  • Method Details

    • definition

      ManagedObjectDefinition<? extends PrometheusEndpointCfgClient,? extends PrometheusEndpointCfg> definition()
      Get the configuration definition associated with this Prometheus HTTP Endpoint.
      Specified by:
      definition in interface ConfigurationClient
      Specified by:
      definition in interface HttpEndpointCfgClient
      Returns:
      Returns the configuration definition associated with this Prometheus HTTP Endpoint.

    • getExcludedMetricPattern

      SortedSet<ValueOrExpression<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 the values of the "excluded-metric-pattern" property.

    • setExcludedMetricPattern

      void setExcludedMetricPattern(Collection<ValueOrExpression<String>> values) throws PropertyException
      Sets 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.

      Parameters:
      values - The values of the "excluded-metric-pattern" property.
      Throws:
      PropertyException - If one or more of the new values are invalid.

    • getIncludedMetricPattern

      SortedSet<ValueOrExpression<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 the values of the "included-metric-pattern" property.

    • setIncludedMetricPattern

      void setIncludedMetricPattern(Collection<ValueOrExpression<String>> values) throws PropertyException
      Sets 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.

      Parameters:
      values - The values of the "included-metric-pattern" property.
      Throws:
      PropertyException - If one or more of the new values are invalid.

    • getJavaClass

      @MandatoryProperty ValueOrExpression<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 interface HttpEndpointCfgClient
      Returns:
      Returns the value of the "java-class" property.

    • setJavaClass

      @MandatoryProperty void setJavaClass(ValueOrExpression<String> value) throws PropertyException
      Sets the "java-class" property.

      Specifies the fully-qualified name of the Java class that provides the Prometheus HTTP Endpoint implementation.

      Specified by:
      setJavaClass in interface HttpEndpointCfgClient
      Parameters:
      value - The value of the "java-class" property.
      Throws:
      PropertyException - If the new value is invalid.

    • isLegacyFormat

      ValueOrExpression<Boolean> isLegacyFormat()
      Gets the "legacy-format" property.

      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.

      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

      Returns:
      Returns the value of the "legacy-format" property.

    • setLegacyFormat

      void setLegacyFormat(ValueOrExpression<Boolean> value) throws PropertyException
      Sets the "legacy-format" property.

      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.

      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.

      Parameters:
      value - The value of the "legacy-format" property.
      Throws:
      PropertyException - If the new value is invalid.