Package com.linecorp.armeria.client.retrofit2

Class RetrofitMeterIdPrefixFunctionBuilder

java.lang.Object

com.linecorp.armeria.client.retrofit2.RetrofitMeterIdPrefixFunctionBuilder

public final class RetrofitMeterIdPrefixFunctionBuilder
extends Object

Builds a RetrofitMeterIdPrefixFunction.

See Also:

RetrofitMeterIdPrefixFunction.builder(String)

Method Summary

Modifier and Type	Method	Description
RetrofitMeterIdPrefixFunction	build()	Returns a newly created RetrofitMeterIdPrefixFunction with the properties specified so far.
RetrofitMeterIdPrefixFunctionBuilder	serviceClass(Class<?> serviceClass)	Adds retrofit client service class that would be used to provide additional tags for metrics based on retrofit annotations.
RetrofitMeterIdPrefixFunctionBuilder	serviceName(String serviceName)	Define service name that should be used for metric with tag defined in serviceTag(String) instead of retrofit client service class.
RetrofitMeterIdPrefixFunctionBuilder	serviceTag(String serviceTagName)	Renames a tag in generated metrics that indicate service name.
RetrofitMeterIdPrefixFunctionBuilder	withServiceTag(String serviceTagName, String defaultServiceName)	Deprecated. Please use serviceTag(String) and serviceName(String) instead.

Methods inherited from class java.lang.Object

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

Method Details

withServiceTag

@Deprecated public RetrofitMeterIdPrefixFunctionBuilder withServiceTag(String serviceTagName, String defaultServiceName)

Deprecated.

Please use serviceTag(String) and serviceName(String) instead.

Adds a tag that signifies the service name to the generated MeterIdPrefixes.

Parameters:

serviceTagName - the name of the tag to be added, e.g. "service.name"

defaultServiceName - the default value of the tag, e.g. "myService"

serviceTag

public RetrofitMeterIdPrefixFunctionBuilder serviceTag(String serviceTagName)

Renames a tag in generated metrics that indicate service name. Default name for the tag service. Unless service name set with serviceName in place of service name would be used name of the retrofit client service class. In case retrofit client service class cannot be defined UNKNOWN would be used.

Parameters:

serviceTagName - the name of the tag to be added, e.g.: "serviceName"

serviceName

public RetrofitMeterIdPrefixFunctionBuilder serviceName(String serviceName)

Define service name that should be used for metric with tag defined in serviceTag(String) instead of retrofit client service class.

Parameters:

serviceName - service name to be reported in metrics

serviceClass

public RetrofitMeterIdPrefixFunctionBuilder serviceClass(Class<?> serviceClass)

Adds retrofit client service class that would be used to provide additional tags for metrics based on retrofit annotations. See RetrofitClassAwareMeterIdPrefixFunction.

Parameters:

serviceClass - class that defines retrofit client service.

build

public RetrofitMeterIdPrefixFunction build()

Returns a newly created RetrofitMeterIdPrefixFunction with the properties specified so far.