Package io.micrometer.core.instrument.binder.okhttp3

Class OkHttpMetricsEventListener

java.lang.Object
okhttp3.EventListener
io.micrometer.core.instrument.binder.okhttp3.OkHttpMetricsEventListener
@NonNullApi @NonNullFields public class OkHttpMetricsEventListener extends okhttp3.EventListener
EventListener for collecting metrics from OkHttpClient.

uri tag is usually limited to URI patterns to mitigate tag cardinality explosion but OkHttpClient doesn't provide URI patterns. We provide "URI_PATTERN" header to support uri tag or you can configure a URI mapper to provide your own tag values for uri tag.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    OkHttpMetricsEventListener.Builder
     

    Nested classes/interfaces inherited from class okhttp3.EventListener

    okhttp3.EventListener.Companion, okhttp3.EventListener.Factory

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static String
    URI_PATTERN
    Header name for URI patterns which will be used for tag values.

    Fields inherited from class okhttp3.EventListener

    Companion, NONE

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    OkHttpMetricsEventListener​(MeterRegistry registry, String requestsMetricName, Function<okhttp3.Request,​String> urlMapper, Iterable<Tag> extraTags, Iterable<BiFunction<okhttp3.Request,​okhttp3.Response,​Tag>> contextSpecificTags)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static OkHttpMetricsEventListener.Builder
    builder​(MeterRegistry registry, String name)
     
    void
    callEnd​(okhttp3.Call call)
     
    void
    callFailed​(okhttp3.Call call, IOException e)
     
    void
    callStart​(okhttp3.Call call)
     
    void
    responseHeadersEnd​(okhttp3.Call call, okhttp3.Response response)
     

    Methods inherited from class okhttp3.EventListener

    cacheConditionalHit, cacheHit, cacheMiss, canceled, connectEnd, connectFailed, connectionAcquired, connectionReleased, connectStart, dnsEnd, dnsStart, proxySelectEnd, proxySelectStart, requestBodyEnd, requestBodyStart, requestFailed, requestHeadersEnd, requestHeadersStart, responseBodyEnd, responseBodyStart, responseFailed, responseHeadersStart, satisfactionFailure, secureConnectEnd, secureConnectStart

    Methods inherited from class java.lang.Object

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

  • Field Details

    • URI_PATTERN

      public static final String URI_PATTERN
      Header name for URI patterns which will be used for tag values.
      See Also:
      Constant Field Values

  • Constructor Details

  • Method Details

    • builder

      public static OkHttpMetricsEventListener.Builder builder​(MeterRegistry registry, String name)

    • callStart

      public void callStart​(okhttp3.Call call)
      Overrides:
      callStart in class okhttp3.EventListener

    • callFailed

      public void callFailed​(okhttp3.Call call, IOException e)
      Overrides:
      callFailed in class okhttp3.EventListener

    • callEnd

      public void callEnd​(okhttp3.Call call)
      Overrides:
      callEnd in class okhttp3.EventListener

    • responseHeadersEnd

      public void responseHeadersEnd​(okhttp3.Call call, okhttp3.Response response)
      Overrides:
      responseHeadersEnd in class okhttp3.EventListener