パッケージ org.springframework.core.metrics

インターフェース StartupStep

public interface StartupStep
ApplicationStartup 中に発生する特定のフェーズまたはアクションに関するメトリクスをステップ記録します。

StartupStep のライフサイクルは次のようになります。

  1. ステップが作成され、the application startup を呼び出すことによって開始され、一意の id が割り当てられます。
  2. 処理中に StartupStep.Tags で情報を接続できます
  3. 次に、ステップの end() をマークする必要があります

実装では、ステップの「実行時間」またはその他のメトリクスを追跡できます。

導入:
5.3
作成者:
Brian Clozel

  • ネストされたクラスのサマリー

    ネストされたクラス
    修飾子と型
    インターフェース
    説明
    static interface
    StartupStep.Tag
    ステップメタデータを格納するための単純なキー / 値の関連付け。
    static interface
    StartupStep.Tags
    StartupStep.Tag の不変のコレクション。

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    void
    end()
    ステップの状態と、実行時間などのその他のメトリクスを記録します。
    long
    getId()
    アプリケーションの起動時にこのステップの一意の ID を返します。
    StringSE
    getName()
    起動ステップの名前を返します。
    LongSE
    getParentId()
    可能な場合は、親ステップの ID を返します。
    StartupStep.Tags
    getTags()
    このステップの StartupStep.Tag コレクションを返します。
    StartupStep
    tag(StringSE key, StringSE value)
    ステップに StartupStep.Tag を追加します。
    StartupStep
    tag(StringSE key, SupplierSE<StringSE> value)
    ステップに StartupStep.Tag を追加します。

  • メソッドの詳細

    • getName

      StringSE getName()
      起動ステップの名前を返します。

      ステップ名は、現在のアクションまたはフェーズを示します。この技術名は "." である必要があります。名前空間化され、アプリケーションの起動時の同様のステップの他のインスタンスを記述するために再利用できます。

    • getId

      long getId()
      アプリケーションの起動時にこのステップの一意の ID を返します。

    • getParentId

      @Nullable LongSE getParentId()
      可能な場合は、親ステップの ID を返します。

      親ステップは、現在のステップが作成されたときに最後に開始されたステップです。

    • tag

      StartupStep tag(StringSE key, StringSE value)
      ステップに StartupStep.Tag を追加します。
      パラメーター:
      key - タグキー
      value - タグ値

    • tag

      StartupStep tag(StringSE key, SupplierSE<StringSE> value)
      ステップに StartupStep.Tag を追加します。
      パラメーター:
      key - タグキー
      value - SupplierSE（タグ値）

    • getTags

      StartupStep.Tags getTags()
      このステップの StartupStep.Tag コレクションを返します。

    • end

      void end()
      ステップの状態と、実行時間などのその他のメトリクスを記録します。

      終了すると、ステップ状態の変更は許可されません。