クラス BatchMetrics
java.lang.ObjectSE
org.springframework.batch.core.observability.BatchMetrics
バッチメトリクスの主要クラス。それは提供します:
- Micrometer の API とやり取りして
Timer
やLongTaskTimer
などの一般的なメトリクスを作成するためのメインエントリポイント。 - 期間の計算や人間が読める形式でのフォーマットなど、いくつかのユーティリティメソッド。
- 導入:
- 4.2
- 作成者:
- Mahmoud Ben Hassine, Glenn Renfro
フィールドサマリー
メソッドのサマリー
修飾子と型メソッド説明static DurationSE
calculateDuration
(LocalDateTimeSE startTime, LocalDateTimeSE endTime) 2 つの日付の間の期間を計算します。static io.micrometer.core.instrument.Counter
createCounter
(io.micrometer.core.instrument.MeterRegistry meterRegistry, StringSE name, StringSE description, io.micrometer.core.instrument.Tag... tags) Counter
を作成します。static io.micrometer.core.instrument.LongTaskTimer
createLongTaskTimer
(io.micrometer.core.instrument.MeterRegistry meterRegistry, StringSE name, StringSE description, io.micrometer.core.instrument.Tag... tags) 新しいLongTaskTimer
を作成します。static io.micrometer.observation.Observation
createObservation
(StringSE name, BatchJobContext context, io.micrometer.observation.ObservationRegistry observationRegistry) 新しいObservation
を作成します。static io.micrometer.observation.Observation
createObservation
(StringSE name, BatchStepContext context, io.micrometer.observation.ObservationRegistry observationRegistry) 新しいObservation
を作成します。static io.micrometer.core.instrument.Timer
createTimer
(io.micrometer.core.instrument.MeterRegistry meterRegistry, StringSE name, StringSE description, io.micrometer.core.instrument.Tag... tags) Timer
を作成します。static io.micrometer.core.instrument.Timer.Sample
createTimerSample
(io.micrometer.core.instrument.MeterRegistry meterRegistry) 新しいTimer.Sample
を作成します。static StringSE
formatDuration
(DurationSE duration) 2h32m15s10ms のように、人間が読める形式で期間をフォーマットします。
フィールドの詳細
メソッドの詳細
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
2h32m15s10ms のように、人間が読める形式で期間をフォーマットします。- パラメーター:
duration
- フォーマットする- 戻り値:
- 人間が読める形式の期間