Package io.quarkus.smallrye.health.deployment

Interface SmallRyeHealthBuildTimeConfig

@ConfigRoot @ConfigMapping(prefix="quarkus.smallrye-health") public interface SmallRyeHealthBuildTimeConfig

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    contextPropagation()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Optional<String>
    defaultHealthGroup()
    The name of the default health group used when no other health group is defined on the health check.
    boolean
    enabled()
    Activate or disable this extension.
    boolean
    extensionsEnabled()
    Whether extensions published health check should be enabled.
    String
    groupPath()
    The relative path of the health group endpoint.
    String
    livenessPath()
    The relative path of the liveness health-checking endpoint.
    boolean
    managementEnabled()
    If management interface is turned on the health endpoints and ui will be published under the management interface.
    OptionalInt
    maxGroupRegistriesCount()
    The number of the maximum health groups that can be created.
    boolean
    openapiIncluded()
    Whether to include the Liveness and Readiness Health endpoints in the generated OpenAPI document
    String
    readinessPath()
    The relative path of the readiness health-checking endpoint.
    String
    rootPath()
    Root path for health-checking endpoints.
    String
    startupPath()
    The relative path of the startup health-checking endpoint.
    SmallRyeHealthUIConfig
    ui()
    SmallRye Health UI configuration
    String
    wellnessPath()
    The relative path of the wellness health-checking endpoint.

  • Method Details

    • enabled

      @WithDefault("true") boolean enabled()
      Activate or disable this extension. Disabling this extension means that no health related information is exposed.

    • extensionsEnabled

      @WithName("extensions.enabled") @WithDefault("true") boolean extensionsEnabled()
      Whether extensions published health check should be enabled.

    • openapiIncluded

      @WithName("openapi.included") @WithDefault("false") boolean openapiIncluded()
      Whether to include the Liveness and Readiness Health endpoints in the generated OpenAPI document

    • rootPath

      @WithDefault("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

      @WithDefault("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

      @WithDefault("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

      @WithDefault("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

      @WithDefault("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

      @WithDefault("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

      @WithDefault("false") @Deprecated(since="3.30", forRemoval=true) boolean contextPropagation()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Whether the context should be propagated to each health check invocation.

    • maxGroupRegistriesCount

      OptionalInt maxGroupRegistriesCount()
      The number of the maximum health groups that can be created.

    • defaultHealthGroup

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

    • managementEnabled

      @WithName("management.enabled") @WithDefault("true") 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

      @ConfigDocSection SmallRyeHealthUIConfig ui()
      SmallRye Health UI configuration