Package com.linecorp.armeria.common.metric

Interface MeterIdPrefixFunction

All Known Implementing Classes:

GrpcMeterIdPrefixFunction, RetrofitMeterIdPrefixFunction

public interface MeterIdPrefixFunction

Creates a MeterIdPrefix from a RequestLog.

See Also:

• MetricCollectingClient
• MetricCollectingService

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.
default MeterIdPrefixFunction	andThen(MeterIdPrefixFunctionCustomizer function)	Returns a MeterIdPrefixFunction that applies transformation on the MeterIdPrefix returned by this function.
MeterIdPrefix	completeRequestPrefix(MeterRegistry registry, RequestLog log)	Creates a MeterIdPrefix from the specified complete RequestLog.
static MeterIdPrefixFunction	of(BiFunction<? super MeterRegistry,? super RequestOnlyLog,MeterIdPrefix> function)	Returns a MeterIdPrefixFunction which generates a MeterIdPrefix from the given MeterRegistry and RequestOnlyLog.
static MeterIdPrefixFunction	ofDefault(String name)	Returns the default function that creates a MeterIdPrefix with the specified name and the Tags derived from the RequestLog properties.
default MeterIdPrefixFunction	withTags(Tag... tags)	Returns a MeterIdPrefixFunction that returns a newly created MeterIdPrefix which has the specified labels added.
default MeterIdPrefixFunction	withTags(Iterable<Tag> tags)	Returns a MeterIdPrefixFunction that returns a newly created MeterIdPrefix which has the specified labels added.
default MeterIdPrefixFunction	withTags(String... keyValues)	Returns a MeterIdPrefixFunction that returns a newly created MeterIdPrefix which has the specified label added.

Method Details

ofDefault

static MeterIdPrefixFunction ofDefault(String name)

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

• Server-side tags:
  • hostnamePattern - VirtualHost.hostnamePattern()
  • service - RPC service name or innermost service class name
  • method - RPC method name or Enum.name() if RPC method name is not available
  • httpStatus - HttpStatus.code()
• Client-side tags:
  • method - RPC method name or Enum.name() if RPC method name is not available
  • httpStatus - HttpStatus.code()

of

static MeterIdPrefixFunction of(BiFunction<? super MeterRegistry,? super RequestOnlyLog,MeterIdPrefix> function)

Returns a MeterIdPrefixFunction which generates a MeterIdPrefix from the given MeterRegistry and RequestOnlyLog. Both activeRequestPrefix(MeterRegistry, RequestOnlyLog) and completeRequestPrefix(MeterRegistry, RequestLog) will return the same MeterIdPrefix for the same input.

activeRequestPrefix

MeterIdPrefix activeRequestPrefix(MeterRegistry registry,
 RequestOnlyLog log)

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

completeRequestPrefix

MeterIdPrefix completeRequestPrefix(MeterRegistry registry,
 RequestLog log)

Creates a MeterIdPrefix from the specified complete RequestLog.

withTags

default MeterIdPrefixFunction withTags(String... keyValues)

Returns a MeterIdPrefixFunction that returns a newly created MeterIdPrefix which has the specified label added.

withTags

default MeterIdPrefixFunction withTags(Tag... tags)

Returns a MeterIdPrefixFunction that returns a newly created MeterIdPrefix which has the specified labels added.

withTags

default MeterIdPrefixFunction withTags(Iterable<Tag> tags)

Returns a MeterIdPrefixFunction that returns a newly created MeterIdPrefix which has the specified labels added.

andThen

default MeterIdPrefixFunction andThen(MeterIdPrefixFunctionCustomizer function)

Returns a MeterIdPrefixFunction that applies transformation on the MeterIdPrefix returned by this function.