Module io.helidon.microprofile.metrics

Package io.helidon.microprofile.metrics

Class MetricUtil

java.lang.Object

io.helidon.microprofile.metrics.MetricUtil

public final class MetricUtil
extends Object

Class MetricUtil.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MetricUtil.LookupResult<A extends Annotation>	Deprecated. This class is made public to migrate from metrics1 to metrics2 for gRPC, this should be refactored
static class	MetricUtil.MatchingType	Deprecated. This class is made public to migrate from metrics1 to metrics2 for gRPC, this should be refactored

Method Summary

Modifier and Type	Method	Description
static <E extends Member & AnnotatedElement> String	getMetricName(E element, Class<?> clazz, MetricUtil.MatchingType matchingType, String explicitName, boolean absolute)	This method is intended only for other Helidon components.
static <E extends Member & AnnotatedElement,A extends Annotation> MetricUtil.LookupResult<A>	lookupAnnotation(E element, Class<? extends Annotation> annotClass, Class<?> clazz)	Deprecated. This method is made public to migrate from metrics1 to metrics2 for gRPC, this should be refactored.
static <E extends Member & AnnotatedElement> void	registerMetric(E element, Class<?> clazz, MetricUtil.LookupResult<? extends Annotation> lookupResult)	Register a metric.
static <E extends Member & AnnotatedElement> void	registerMetric(E element, Class<?> clazz, Annotation annotation, MetricUtil.MatchingType type)	Register a metric.

Methods inherited from class java.lang.Object

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

Method Detail

lookupAnnotation

@Deprecated
public static <E extends Member & AnnotatedElement,A extends Annotation> MetricUtil.LookupResult<A> lookupAnnotation(E element,
                                                                                                                           Class<? extends Annotation> annotClass,
                                                                                                                           Class<?> clazz)

Deprecated.

This method is made public to migrate from metrics1 to metrics2 for gRPC, this should be refactored. This method will be removed outside of major version of Helidon.

DO NOT USE THIS METHOD please, it will be removed.

Type Parameters:

E - element type

A - annotation type

Parameters:

element - element

annotClass - annotation class

clazz - class

Returns:

lookup result

getMetricName

public static <E extends Member & AnnotatedElement> String getMetricName(E element,
                                                                         Class<?> clazz,
                                                                         MetricUtil.MatchingType matchingType,
                                                                         String explicitName,
                                                                         boolean absolute)

This method is intended only for other Helidon components.

Type Parameters:

E - type of element

Parameters:

element - such as method

clazz - class

matchingType - type to match

explicitName - name

absolute - if absolute

Returns:

name of the metric

registerMetric

public static <E extends Member & AnnotatedElement> void registerMetric(E element,
                                                                        Class<?> clazz,
                                                                        MetricUtil.LookupResult<? extends Annotation> lookupResult)

Register a metric.

Type Parameters:

E - the annotated element type

Parameters:

element - the annotated element

clazz - the annotated class

lookupResult - the annotation lookup result

registerMetric

public static <E extends Member & AnnotatedElement> void registerMetric(E element,
                                                                        Class<?> clazz,
                                                                        Annotation annotation,
                                                                        MetricUtil.MatchingType type)

Register a metric.

Type Parameters:

E - the annotated element type

Parameters:

element - the annotated element

clazz - the annotated class

annotation - the annotation to register

type - the MetricUtil.MatchingType indicating the type of annotated element