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 Detail

      • 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 interface HttpEndpointCfg
        Returns:
        Returns the value of the "java-class" property.