Package io.quarkus.micrometer.runtime.config

Interface PrometheusConfigGroup

All Superinterfaces:
MicrometerConfig.CapabilityEnabled
public interface PrometheusConfigGroup extends MicrometerConfig.CapabilityEnabled

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    defaultRegistry()
    By default, this extension will create a Prometheus MeterRegistry instance.
    Optional<Boolean>
    enabled()
    Support for export to Prometheus.
    String
    path()
    The path for the prometheus metrics endpoint (produces text/plain).

  • Method Details

    • enabled

      Optional<Boolean> enabled()
      Support for export to Prometheus.

      Support for Prometheus will be enabled if Micrometer support is enabled, the PrometheusMeterRegistry is on the classpath and either this value is true, or this value is unset and quarkus.micrometer.registry-enabled-default is true.

      Specified by:
      enabled in interface MicrometerConfig.CapabilityEnabled
      Returns:
      Optional<Boolean>

    • path

      @WithDefault("metrics") String path()
      The path for the prometheus metrics endpoint (produces text/plain). The default value is `metrics` and is resolved relative to the non-application endpoint (`q`), e.g. `${quarkus.http.root-path}/${quarkus.http.non-application-root-path}/metrics`. If an absolute path is specified (`/metrics`), the prometheus endpoint will be served from the configured path. If the management interface is enabled, the value will be resolved as a path relative to `${quarkus.management.root-path}` (`q` by default), e.g. `http://${quarkus.management.host}:${quarkus.management.port}/${quarkus.management.root-path}/metrics`. If an absolute path is specified (`/metrics`), the prometheus endpoint will be served from the configured path, e.g. `http://${quarkus.management.host}:${quarkus.management.port}/metrics`.

    • defaultRegistry

      @WithDefault("true") boolean defaultRegistry()
      By default, this extension will create a Prometheus MeterRegistry instance.

      Use this attribute to veto the creation of the default Prometheus MeterRegistry.