io.micrometer.core.instrument.binder.okhttp3

Class OkHttpMetricsEventListener

java.lang.Object

EventListener

io.micrometer.core.instrument.binder.okhttp3.OkHttpMetricsEventListener

@NonNullApi
 @NonNullFields
public class OkHttpMetricsEventListener
extends 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 and Description
static class	OkHttpMetricsEventListener.Builder

Field Summary

Fields

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

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

Method Detail

builder

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

callStart

public void callStart(Call call)

callFailed

public void callFailed(Call call,
                       IOException e)

responseHeadersEnd

public void responseHeadersEnd(Call call,
                               Response response)