パッケージ org.springframework.http.server.reactive.observation

クラス ServerRequestObservationContext

java.lang.ObjectSE
io.micrometer.observation.Observation.Context
io.micrometer.observation.transport.ReceiverContext<C>
io.micrometer.observation.transport.RequestReplyReceiverContext<ServerHttpRequest,ServerHttpResponse>
org.springframework.http.server.reactive.observation.ServerRequestObservationContext
実装されたすべてのインターフェース:
io.micrometer.observation.Observation.ContextView, io.micrometer.observation.transport.ResponseContext<ServerHttpResponse>
public class ServerRequestObservationContext extends io.micrometer.observation.transport.RequestReplyReceiverContext<ServerHttpRequest,ServerHttpResponse>
reactive HTTP requests 観測に関するメタデータコレクションの情報を保持するコンテキスト。

このコンテキストは、HTTP リクエスト処理中にトレース情報を伝搬するために RequestReplyReceiverContext も拡張します。

導入:
6.0
作成者:
Brian Clozel

  • フィールドのサマリー

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

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

    コンストラクター
    コンストラクター
    説明
    ServerRequestObservationContext(ServerHttpRequest request, ServerHttpResponse response, MapSE<StringSE,ObjectSE> attributes)
    新しい ServerRequestObservationContext インスタンスを作成します。

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    static OptionalSE<ServerRequestObservationContext>
    findCurrent(MapSE<StringSE,ObjectSE> attributes)
    可能な場合は、指定された属性から現在の observation context を取得します。
    MapSE<StringSE,ObjectSE>
    getAttributes()
    現在のリクエスト属性の不変のマップを返します。
    StringSE
    getPathPattern()
    現在のリクエストに一致するハンドラーのパスパターンを返します。
    boolean
    isConnectionAborted()
    現在の接続がクライアントによって中止されたために、リアクティブな チェーンで cancel signal が発生したか、リクエストを読み取るときに AbortedException が発生したか。
    void
    setConnectionAborted(boolean connectionAborted)
    現在の接続がクライアントによって中止された結果、リアクティブチェーンで cancel signal が発生したか、リクエストを読み取るときに AbortedException が発生したかを設定します。
    void
    setPathPattern(StringSE pathPattern)
    現在のリクエストに一致するハンドラーのパスパターンを設定します。

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

    getResponse, setResponse

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

    getCarrier, getGetter, getKind, getRemoteServiceAddress, getRemoteServiceName, 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

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

    • ServerRequestObservationContext

      public ServerRequestObservationContext(ServerHttpRequest request, ServerHttpResponse response, MapSE<StringSE,ObjectSE> attributes)
      新しい ServerRequestObservationContext インスタンスを作成します。
      パラメーター:
      request - 現在のリクエスト
      response - 現在のレスポンス
      attributes - 現在の属性

  • メソッドの詳細

    • getAttributes

      public MapSE<StringSE,ObjectSE> getAttributes()
      現在のリクエスト属性の不変のマップを返します。

    • getPathPattern

      @Nullable public StringSE getPathPattern()
      現在のリクエストに一致するハンドラーのパスパターンを返します。例: "/projects/{name}"。

      パスパターンは、アプリケーション全体でカーディナリティを低くする必要があります。

      戻り値:
      パスパターン、または見つからない場合は null 

    • setPathPattern

      public void setPathPattern(@Nullable StringSE pathPattern)
      現在のリクエストに一致するハンドラーのパスパターンを設定します。

      パスパターンは、アプリケーション全体でカーディナリティを低くする必要があります。

      パラメーター:
      pathPattern - "/projects/{name}" などのパスパターン。

    • isConnectionAborted

      public boolean isConnectionAborted()
      現在の接続がクライアントによって中止されたために、リアクティブな チェーンで cancel signal が発生したか、リクエストを読み取るときに AbortedException が発生したか。
      戻り値:
      接続が中止された場合

    • setConnectionAborted

      public void setConnectionAborted(boolean connectionAborted)
      現在の接続がクライアントによって中止された結果、リアクティブチェーンで cancel signal が発生したか、リクエストを読み取るときに AbortedException が発生したかを設定します。
      パラメーター:
      connectionAborted - 接続が中止された場合

    • findCurrent

      public static OptionalSE<ServerRequestObservationContext> findCurrent(MapSE<StringSE,ObjectSE> attributes)
      可能な場合は、指定された属性から現在の observation context を取得します。
      パラメーター:
      attributes - 現在の交換属性
      戻り値:
      現在の観測コンテキスト
      導入:
      6.1