パッケージ org.springframework.boot.actuate.health

クラス AbstractHealthIndicator

java.lang.ObjectSE
org.springframework.boot.actuate.health.AbstractHealthIndicator
実装されたすべてのインターフェース:
HealthContributor, HealthIndicator
既知の直属サブクラス
AvailabilityStateHealthIndicator、CassandraDriverHealthIndicator、CouchbaseHealthIndicator、DataSourceHealthIndicator、DiskSpaceHealthIndicator、ElasticsearchRestClientHealthIndicator、HazelcastHealthIndicator、InfluxDbHealthIndicator、JmsHealthIndicator、LdapHealthIndicator、MailHealthIndicator、MongoHealthIndicator、Neo4jHealthIndicator、PingHealthIndicator、RabbitHealthIndicator、RedisHealthIndicator
public abstract class AbstractHealthIndicator extends ObjectSE implements HealthIndicator
Health インスタンスの作成とエラー処理をカプセル化するベース HealthIndicator 実装。

この実装は、doHealthCheck(org.springframework.boot.actuate.health.Health.Builder) から発生した ExceptionSE が Status.DOWN ヘルスステータスを作成する必要がある場合にのみ適しています。

導入:
1.1.0
作成者:
Christian Dupuis

  • コンストラクターの詳細

    • AbstractHealthIndicator

      protected AbstractHealthIndicator()
      デフォルトの healthCheckFailedMessage で新しい AbstractHealthIndicator インスタンスを作成します。

    • AbstractHealthIndicator

      protected AbstractHealthIndicator(StringSE healthCheckFailedMessage)
      ヘルスチェックが失敗したときにログに記録する特定のメッセージを使用して、新しい AbstractHealthIndicator インスタンスを作成します。
      パラメーター:
      healthCheckFailedMessage - ヘルスチェックの失敗を記録するメッセージ
      導入:
      2.0.0

    • AbstractHealthIndicator

      protected AbstractHealthIndicator(FunctionSE<ExceptionSE,StringSE> healthCheckFailedMessage)
      ヘルスチェックが失敗したときにログに記録する特定のメッセージを使用して、新しい AbstractHealthIndicator インスタンスを作成します。
      パラメーター:
      healthCheckFailedMessage - ヘルスチェックの失敗を記録するメッセージ
      導入:
      2.0.0

  • メソッドの詳細

    • health

      public final Health health()
      インターフェースからコピーされた説明: HealthIndicator
      ヘルス状態の表示を返します。
      次で指定:
      インターフェース HealthIndicator の health 
      戻り値:
      ヘルス

    • doHealthCheck

      protected abstract void doHealthCheck(Health.Builder builder) throws ExceptionSE
      実際のヘルスチェックロジック。
      パラメーター:
      builder - Health.Builder を使用して、ヘルスステータスと詳細を報告する
      例外:
      ExceptionSE - Status.DOWN システムステータスを作成する ExceptionSE。