クラス CorrelationIdFormatter
java.lang.ObjectSE
org.springframework.boot.logging.CorrelationIdFormatter
W3C 推奨事項に基づいてロギング用の相関 ID をフォーマットするために使用できるユーティリティクラス。
フォーマッタは、名前のカンマ区切りリストとその解決された値の予想される長さを使用して構成できます。各項目は "<name>(length)" の形式で指定する必要があります。例: "traceId(32),spanId(16)" は、名前 "traceId" および "spanId" を指定し、予想される長さはそれぞれ 32 および 16 です。
相関 ID は、角括弧 で囲まれたダッシュ区切りの文字列としてフォーマットされます。フォーマットされた出力は常に固定幅で、末尾にスペースが付きます。名前付き項目がどれも解決できない場合、ダッシュは省略されます。
次の例は、"[01234567890123456789012345678901-0123456789012345] " のフォーマットされた結果を返します。
CorrelationIdFormatter formatter = CorrelationIdFormatter.of("traceId(32),spanId(16)");
Map<String, String> mdc = Map.of("traceId", "01234567890123456789012345678901", "spanId", "0123456789012345");
return formatter.format(mdc::get);
of(String) が空の仕様で呼び出された場合は、DEFAULT フォーマッタが使用されます。
- 導入:
- 3.2.0
- 作成者:
- Phillip Webb
- 関連事項:
フィールドのサマリー
フィールドメソッドのサマリー
修飾子と型メソッド説明format(UnaryOperatorSE<StringSE> resolver) 指定されたリゾルバーの値から相関関係をフォーマットします。voidformatTo(UnaryOperatorSE<StringSE> resolver, AppendableSE appendable) 指定されたリゾルバーの値から相関をフォーマットし、指定されたAppendableSE に追加します。static CorrelationIdFormatter指定された仕様から新しいCorrelationIdFormatterインスタンスを作成します。static CorrelationIdFormatter指定された仕様から新しいCorrelationIdFormatterインスタンスを作成します。static CorrelationIdFormatterof(CollectionSE<StringSE> spec) 指定された仕様から新しいCorrelationIdFormatterインスタンスを作成します。toString()
フィールドの詳細
DEFAULT
デフォルトCorrelationIdFormatter。
メソッドの詳細
format
指定されたリゾルバーの値から相関関係をフォーマットします。- パラメーター:
resolver- 名前付きの値を解決するために使用されるリゾルバー- 戻り値:
- フォーマットされた相関 ID
formatTo
指定されたリゾルバーの値から相関をフォーマットし、指定されたAppendableSE に追加します。- パラメーター:
resolver- 名前付きの値を解決するために使用されるリゾルバーappendable- フォーマットされた相関 ID に追加可能なもの
toString
of
指定された仕様から新しいCorrelationIdFormatterインスタンスを作成します。- パラメーター:
spec- カンマ区切りの仕様- 戻り値:
- 新しい
CorrelationIdFormatterインスタンス
of
指定された仕様から新しいCorrelationIdFormatterインスタンスを作成します。- パラメーター:
spec- 事前に分離された仕様- 戻り値:
- 新しい
CorrelationIdFormatterインスタンス
of
指定された仕様から新しいCorrelationIdFormatterインスタンスを作成します。- パラメーター:
spec- 事前に分離された仕様- 戻り値:
- 新しい
CorrelationIdFormatterインスタンス