Package org.springframework.web.observation.reactive

Class HttpRequestsObservationContext

java.lang.Object
io.micrometer.observation.Observation.Context
io.micrometer.observation.transport.ReceiverContext<C>
io.micrometer.observation.transport.RequestReplyReceiverContext<ServerHttpRequest,ServerHttpResponse>
org.springframework.web.observation.reactive.HttpRequestsObservationContext
All Implemented Interfaces:
io.micrometer.observation.Observation.ContextView, io.micrometer.observation.transport.ResponseContext<ServerHttpResponse>
public class HttpRequestsObservationContext extends io.micrometer.observation.transport.RequestReplyReceiverContext<ServerHttpRequest,ServerHttpResponse>
Context that holds information for metadata collection during observations for reactive web applications.

This context also extends RequestReplyReceiverContext for propagating tracing information with the HTTP server exchange.

Since:
6.0
Author:
Brian Clozel

  • Constructor Summary

    Constructors
    Constructor
    Description
    HttpRequestsObservationContext(ServerWebExchange exchange)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    PathPattern
    getPathPattern()
    Return the path pattern for the handler that matches the current request.
    boolean
    isConnectionAborted()
    Whether the current connection was aborted by the client, resulting in a cancel signal on the reactive chain, or an AbortedException when reading the request.
    void
    setPathPattern(PathPattern pathPattern)
    Set the path pattern for the handler that matches the current request.

    Methods inherited from class io.micrometer.observation.transport.RequestReplyReceiverContext

    getResponse, setResponse

    Methods inherited from class io.micrometer.observation.transport.ReceiverContext

    getCarrier, getGetter, getKind, getRemoteServiceName, setCarrier, setRemoteServiceName

    Methods inherited from class io.micrometer.observation.Observation.Context

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

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • HttpRequestsObservationContext

      public HttpRequestsObservationContext(ServerWebExchange exchange)

  • Method Details

    • getPathPattern

      @Nullable public PathPattern getPathPattern()
      Return the path pattern for the handler that matches the current request. For example, "/projects/{name}".

      Path patterns must have a low cardinality for the entire application.

      Returns:
      the path pattern, or null if none found

    • setPathPattern

      public void setPathPattern(@Nullable PathPattern pathPattern)
      Set the path pattern for the handler that matches the current request.

      Path patterns must have a low cardinality for the entire application.

      Parameters:
      pathPattern - the path pattern, for example "/projects/{name}".

    • isConnectionAborted

      public boolean isConnectionAborted()
      Whether the current connection was aborted by the client, resulting in a cancel signal on the reactive chain, or an AbortedException when reading the request.
      Returns:
      if the connection has been aborted