パッケージ org.springframework.web.reactive.function.client

クラス ClientRequestObservationContext

java.lang.ObjectSE
io.micrometer.observation.Observation.Context
io.micrometer.observation.transport.SenderContext<C>
io.micrometer.observation.transport.RequestReplySenderContext<ClientRequest.Builder,ClientResponse>
org.springframework.web.reactive.function.client.ClientRequestObservationContext
実装されているすべてのインターフェース:
io.micrometer.observation.Observation.ContextView, io.micrometer.observation.transport.ResponseContext<ClientResponse>
public class ClientRequestObservationContext extends io.micrometer.observation.transport.RequestReplySenderContext<ClientRequest.Builder,ClientResponse>
HTTP client exchange observations 中にメタデータを収集するための情報を保持するコンテキスト。

実際のリクエストは不変であるため、tracing context carrier は request builder です。KeyValue 抽出の場合は、代わりに actual request を使用する必要があります。

導入:
6.0
作成者:
Brian Clozel

  • フィールドのサマリー

    フィールド
    修飾子と型
    フィールド
    説明
    static final StringSE
    CURRENT_OBSERVATION_CONTEXT_ATTRIBUTE
    現在の監視の context を保持するリクエスト属性の名前。

  • コンストラクターの概要

    コンストラクター
    コンストラクター
    説明
    ClientRequestObservationContext()
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    6.1.2 現在、ClientRequestObservationContext(ClientRequest.Builder) を推奨
    ClientRequestObservationContext(ClientRequest.Builder request)
    HTTP クライアント監視用の新しい監視コンテキストを作成します。

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    static OptionalSE<ClientRequestObservationContext>
    findCurrent(ClientRequest request)
    利用可能な場合、指定されたリクエストから現在の observation context を取得します。
    ClientRequest
    getRequest()
    不変のクライアントリクエストを返します。
    StringSE
    getUriTemplate()
    現在のクライアント交換に使用された URI テンプレートを返します。何も使用されていない場合は null です。
    boolean
    isAborted()
    クライアントがレスポンスを受信する前に現在の HTTP 交換を中止したかどうか。
    void
    setRequest(ClientRequest request)
    クライアントリクエストを設定します。
    void
    setUriTemplate(StringSE uriTemplate)
    現在のクライアント交換に使用される URI テンプレートを設定します。

    クラス io.micrometer.observation.transport.RequestReplySenderContext から継承されたメソッド

    getResponse, setResponse

    クラス io.micrometer.observation.transport.SenderContext から継承されたメソッド

    getCarrier, getKind, getRemoteServiceAddress, getRemoteServiceName, getSetter, setCarrier, setRemoteServiceAddress, setRemoteServiceName

    クラス io.micrometer.observation.Observation.Context から継承されたメソッド

    addHighCardinalityKeyValue, addHighCardinalityKeyValues, addLowCardinalityKeyValue, addLowCardinalityKeyValues, clear, computeIfAbsent, containsKey, get, getAllKeyValues, getContextualName, getError, getHighCardinalityKeyValue, getHighCardinalityKeyValues, getLowCardinalityKeyValue, getLowCardinalityKeyValues, getName, getOrDefault, getParentObservation, getRequired, put, remove, removeHighCardinalityKeyValue, removeHighCardinalityKeyValues, removeLowCardinalityKeyValue, removeLowCardinalityKeyValues, setContextualName, setError, setName, setParentObservation, toString

    クラス java.lang.ObjectSE から継承されたメソッド

    clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, wait, waitSE, waitSE

    インターフェース io.micrometer.observation.Observation.ContextView から継承されたメソッド

    getOrDefault

  • フィールドの詳細

    • CURRENT_OBSERVATION_CONTEXT_ATTRIBUTE

      public static final StringSE CURRENT_OBSERVATION_CONTEXT_ATTRIBUTE
      現在の監視の context を保持するリクエスト属性の名前。
      導入:
      6.1.2

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

    • ClientRequestObservationContext

      @DeprecatedSE(since="6.1.2", forRemoval=true) public ClientRequestObservationContext()
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      6.1.2 現在、ClientRequestObservationContext(ClientRequest.Builder) を推奨
      HTTP クライアント監視用の新しい監視コンテキストを作成します。

    • ClientRequestObservationContext

      public ClientRequestObservationContext(ClientRequest.Builder request)
      HTTP クライアント監視用の新しい監視コンテキストを作成します。
      パラメーター:
      request - クライアントリクエストビルダー
      導入:
      6.1.2

  • メソッドの詳細

    • getUriTemplate

      @Nullable public StringSE getUriTemplate()
      現在のクライアント交換に使用された URI テンプレートを返します。何も使用されていない場合は null です。

    • setUriTemplate

      public void setUriTemplate(@Nullable StringSE uriTemplate)
      現在のクライアント交換に使用される URI テンプレートを設定します。

    • isAborted

      public boolean isAborted()
      クライアントがレスポンスを受信する前に現在の HTTP 交換を中止したかどうか。
      戻り値:
      交換が中止されたかどうか

    • getRequest

      @Nullable public ClientRequest getRequest()
      不変のクライアントリクエストを返します。

    • setRequest

      public void setRequest(ClientRequest request)
      クライアントリクエストを設定します。

    • findCurrent

      public static OptionalSE<ClientRequestObservationContext> findCurrent(ClientRequest request)
      利用可能な場合、指定されたリクエストから現在の observation context を取得します。
      パラメーター:
      request - 現在のクライアントリクエスト
      戻り値:
      現在の観測コンテキスト
      導入:
      6.1.2