パッケージ org.springframework.batch.core.observability

クラス BatchMetrics

java.lang.ObjectSE
org.springframework.batch.core.observability.BatchMetrics
public final class BatchMetrics extends ObjectSE
バッチメトリクスの主要クラス。それは提供します:
  • Micrometer の API とやり取りして Timer や LongTaskTimer などの一般的なメトリクスを作成するためのメインエントリポイント。
  • 期間の計算や人間が読める形式でのフォーマットなど、いくつかのユーティリティメソッド。
内部使用のみを目的としています。
導入:
4.2
作成者:
Mahmoud Ben Hassine, Glenn Renfro

  • フィールドの詳細

  • 方法の詳細

    • createTimer

      public static io.micrometer.core.instrument.Timer createTimer(io.micrometer.core.instrument.MeterRegistry meterRegistry, StringSE name, StringSE description, io.micrometer.core.instrument.Tag... tags)
      Timer を作成します。
      パラメーター:
      meterRegistry - 使用するメーターレジストリ
      name - タイマー。接頭辞は METRICS_PREFIX になります。
      description - タイマー
      tags - タイマー
      戻り値:
      新しいタイマーインスタンス

    • createCounter

      public static io.micrometer.core.instrument.Counter createCounter(io.micrometer.core.instrument.MeterRegistry meterRegistry, StringSE name, StringSE description, io.micrometer.core.instrument.Tag... tags)
      Counter を作成します。
      パラメーター:
      meterRegistry - 使用するメーターレジストリ
      name - カウンター。METRICS_PREFIX というプレフィックスが付きます。
      description - カウンター
      tags - カウンター
      戻り値:
      新しいタイマーインスタンス

    • createObservation

      public static io.micrometer.observation.Observation createObservation(StringSE name, BatchJobContext context, io.micrometer.observation.ObservationRegistry observationRegistry)
      新しい Observation を作成します。これは開始されていません。開始するには、明示的に Observation.start() を呼び出す必要があります。

      ユーザーコードで Metrics.globalRegistry.withTimerObservationHandler() 経由で DefaultMeterObservationHandler を忘れずに登録してください。そうしないと、メトリクスが観測されなくなります。

      パラメーター:
      name - 観測
      context - バッチジョブ監視
      戻り値:
      新しい観測インスタンス
      導入:
      5.0

    • createObservation

      public static io.micrometer.observation.Observation createObservation(StringSE name, BatchStepContext context, io.micrometer.observation.ObservationRegistry observationRegistry)
      新しい Observation を作成します。これは開始されていません。開始するには、明示的に Observation.start() を呼び出す必要があります。

      ユーザーコードで Metrics.globalRegistry.withTimerObservationHandler() 経由で DefaultMeterObservationHandler を忘れずに登録してください。そうしないと、メトリクスが観測されなくなります。

      パラメーター:
      name - 観測
      context - 観測ステップコンテキスト
      戻り値:
      新しい観測インスタンス
      導入:
      5.0

    • createTimerSample

      public static io.micrometer.core.instrument.Timer.Sample createTimerSample(io.micrometer.core.instrument.MeterRegistry meterRegistry)
      新しい Timer.Sample を作成します。
      パラメーター:
      meterRegistry - 使用するメーターレジストリ
      戻り値:
      新しいタイマーサンプルインスタンス

    • createLongTaskTimer

      public static io.micrometer.core.instrument.LongTaskTimer createLongTaskTimer(io.micrometer.core.instrument.MeterRegistry meterRegistry, StringSE name, StringSE description, io.micrometer.core.instrument.Tag... tags)
      新しい LongTaskTimer を作成します。
      パラメーター:
      meterRegistry - 使用するメーターレジストリ
      name - ロングタスクタイマー。接頭辞は METRICS_PREFIX になります。
      description - ロングタスクタイマー。
      tags - タイマー
      戻り値:
      新しいロングタスクタイマーインスタンス

    • calculateDuration

      @Nullable public static DurationSE calculateDuration(@Nullable LocalDateTimeSE startTime, @Nullable LocalDateTimeSE endTime)
      2 つの日付の間の期間を計算します。
      パラメーター:
      startTime - 開始時間
      endTime - 終了時間
      戻り値:
      開始時間と終了時間の間の期間

    • formatDuration

      public static StringSE formatDuration(@Nullable DurationSE duration)
      2h32m15s10ms のように、人間が読める形式で期間をフォーマットします。
      パラメーター:
      duration - フォーマットする
      戻り値:
      人間が読める形式の期間