Package io.quarkus.smallrye.health.deployment

Class SmallRyeHealthConfig

java.lang.Object
io.quarkus.smallrye.health.deployment.SmallRyeHealthConfig
@ConfigRoot(name="smallrye-health") public class SmallRyeHealthConfig extends Object

  • Field Details

    • rootPath

      @ConfigItem(defaultValue="health") String rootPath
      Root path for health-checking endpoints. By default, this value will be resolved as a path relative to `${quarkus.http.non-application-root-path}`. If the management interface is enabled, the value will be resolved as a path relative to `${quarkus.management.root-path}`.

    • livenessPath

      @ConfigItem(defaultValue="live") String livenessPath
      The relative path of the liveness health-checking endpoint. By default, this value will be resolved as a path relative to `${quarkus.smallrye-health.rootPath}`.

    • readinessPath

      @ConfigItem(defaultValue="ready") String readinessPath
      The relative path of the readiness health-checking endpoint. By default, this value will be resolved as a path relative to `${quarkus.smallrye-health.rootPath}`.

    • groupPath

      @ConfigItem(defaultValue="group") String groupPath
      The relative path of the health group endpoint. By default, this value will be resolved as a path relative to `${quarkus.smallrye-health.rootPath}`.

    • wellnessPath

      @ConfigItem(defaultValue="well") String wellnessPath
      The relative path of the wellness health-checking endpoint. By default, this value will be resolved as a path relative to `${quarkus.smallrye-health.rootPath}`.

    • startupPath

      @ConfigItem(defaultValue="started") String startupPath
      The relative path of the startup health-checking endpoint. By default, this value will be resolved as a path relative to `${quarkus.smallrye-health.rootPath}`.

    • contextPropagation

      @ConfigItem(defaultValue="false") boolean contextPropagation
      Whether the context should be propagated to each health check invocation.

    • maxGroupRegistriesCount

      @ConfigItem OptionalInt maxGroupRegistriesCount
      The number of the maximum health groups that can be created.

    • defaultHealthGroup

      @ConfigItem Optional<String> defaultHealthGroup
      The name of the default health group used when no other health group is defined on the health check.

    • managementEnabled

      @ConfigItem(name="management.enabled", defaultValue="true") public boolean managementEnabled
      If management interface is turned on the health endpoints and ui will be published under the management interface. This allows you to exclude Health from management by setting the value to false

    • ui

      @ConfigItem @ConfigDocSection SmallRyeHealthUIConfig ui
      SmallRye Health UI configuration

  • Constructor Details

    • SmallRyeHealthConfig

      public SmallRyeHealthConfig()