Package com.linecorp.armeria.client.retrofit2

Class RetrofitMeterIdPrefixFunction

java.lang.Object

com.linecorp.armeria.client.retrofit2.RetrofitMeterIdPrefixFunction

All Implemented Interfaces:

MeterIdPrefixFunction

public final class RetrofitMeterIdPrefixFunction
extends Object
implements MeterIdPrefixFunction

Returns the default function for retrofit that creates a MeterIdPrefix with the specified name and the Tags derived from the RequestLog properties and Invocation.

• service (or serviceTagName) - Retrofit service interface name, provided serviceName or UNKNOWN if Retrofit service interface method available
• path - Retrofit service interface method path taken from method annotation or RequestHeaderGetters.path() if Retrofit service interface method available
• method - Retrofit service interface method or UNKNOWN if Retrofit service interface method available
• http.method - HTTP method name from Retrofit service interface method annotation or from RequestHeaderGetters.method() if Retrofit service interface method not available
• http.status - HttpStatus.code()

Method Summary

Modifier and Type	Method	Description
MeterIdPrefix	activeRequestPrefix(MeterRegistry registry, RequestOnlyLog log)	Creates a MeterIdPrefix for the active request counter gauges from the specified RequestOnlyLog.
MeterIdPrefix	completeRequestPrefix(MeterRegistry registry, RequestLog log)	Creates a MeterIdPrefix from the specified complete RequestLog.
static RetrofitMeterIdPrefixFunction	of(String name)	Returns a newly created RetrofitMeterIdPrefixFunction with the specified name.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.linecorp.armeria.common.metric.MeterIdPrefixFunction

andThen, withTags, withTags, withTags

Method Details

of

public static RetrofitMeterIdPrefixFunction of(String name)

Returns a newly created RetrofitMeterIdPrefixFunction with the specified name.

activeRequestPrefix

public MeterIdPrefix activeRequestPrefix(MeterRegistry registry,
 RequestOnlyLog log)

Description copied from interface: MeterIdPrefixFunction

Creates a MeterIdPrefix for the active request counter gauges from the specified RequestOnlyLog. Note that the given RequestOnlyLog might not have all properties available. However, the following properties' availability is guaranteed:

• RequestLogProperty.REQUEST_START_TIME
• RequestLogProperty.REQUEST_HEADERS
• RequestLogProperty.SESSION
• RequestLogProperty.NAME

Specified by:

activeRequestPrefix in interface MeterIdPrefixFunction

completeRequestPrefix

public MeterIdPrefix completeRequestPrefix(MeterRegistry registry,
 RequestLog log)

Description copied from interface: MeterIdPrefixFunction

Creates a MeterIdPrefix from the specified complete RequestLog.

Specified by:

completeRequestPrefix in interface MeterIdPrefixFunction