Top Description Inners Fields Constructors Methods
io.micrometer.observation.aop

pack-priv final Enum ObservedAspectObservationDocumentation

extends Enum<ObservedAspectObservationDocumentation>
implements ObservationDocumentation
Class Inheritance
All Implemented Interfaces
io.micrometer.observation.docs.ObservationDocumentation
Imports
io.micrometer.common.KeyValues, io.micrometer.common.docs.KeyName, io.micrometer.common.lang.Nullable, io.micrometer.observation.Observation, .ObservationRegistry, .ObservationConvention, io.micrometer.observation.annotation.Observed, io.micrometer.observation.docs.ObservationDocumentation, org.aspectj.lang.ProceedingJoinPoint, .Signature
An ObservationDocumentation for ObservedAspect.
Author
Jonatan Ivanov
Since
1.10.0

Nested and Inner Type Summary

Modifier and TypeClass and Description
pack-priv static enum
ObservedAspectObservationDocumentation.ObservedAspectLowCardinalityKeyName

Field Summary

Modifier and TypeField and Description
public static final ObservedAspectObservationDocumentation
DEFAULT

Constructor Summary

AccessConstructor and Description
private
ObservedAspectObservationDocumentation()

Method Summary

Modifier and TypeMethod and Description
public String
getContextualName()

Overrides default io.micrometer.observation.docs.ObservationDocumentation.getContextualName.

More human-readable name available within the given context (e.g.: span name).
public KeyName[]
getLowCardinalityKeyNames()

Overrides default io.micrometer.observation.docs.ObservationDocumentation.getLowCardinalityKeyNames.

Low cardinality key names.
public String
getName()

Overrides default io.micrometer.observation.docs.ObservationDocumentation.getName.

Default technical name (e.g.: metric name).
pack-priv static Observation
of(ProceedingJoinPoint pjp, Observed observed, ObservationRegistry registry, ObservationConvention<ObservedAspect.ObservedAspectContext> observationConvention)

public static ObservedAspectObservationDocumentation
valueOf(String name)

public static ObservedAspectObservationDocumentation[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

DEFAULTback to summary
public static final ObservedAspectObservationDocumentation DEFAULT

Constructor Detail

ObservedAspectObservationDocumentationback to summary
private ObservedAspectObservationDocumentation()

Method Detail

getContextualNameback to summary
public String getContextualName()

Overrides default io.micrometer.observation.docs.ObservationDocumentation.getContextualName.

Doc from io.micrometer.observation.docs.ObservationDocumentation.getContextualName.

More human-readable name available within the given context (e.g.: span name). You can set the name either by this method or getDefaultConvention(). This method will override what getDefaultConvention() has set.

Returns:String

contextual name

Annotations
@Override
getLowCardinalityKeyNamesback to summary
public KeyName[] getLowCardinalityKeyNames()

Overrides default io.micrometer.observation.docs.ObservationDocumentation.getLowCardinalityKeyNames.

Doc from io.micrometer.observation.docs.ObservationDocumentation.getLowCardinalityKeyNames.

Low cardinality key names.

Returns:KeyName[]

allowed tag keys for low cardinality key-values

Annotations
@Override
getNameback to summary
public String getName()

Overrides default io.micrometer.observation.docs.ObservationDocumentation.getName.

Doc from io.micrometer.observation.docs.ObservationDocumentation.getName.

Default technical name (e.g.: metric name). You can set the name either by this method or getDefaultConvention(). You can't use both.

Returns:String

name

Annotations
@Override
ofback to summary
pack-priv static Observation of(ProceedingJoinPoint pjp, Observed observed, ObservationRegistry registry, ObservationConvention<ObservedAspect.ObservedAspectContext> observationConvention)
valueOfback to summary
public static ObservedAspectObservationDocumentation valueOf(String name)
valuesback to summary
public static ObservedAspectObservationDocumentation[] values()
io.micrometer.observation.aop back to summary

pack-priv sealed Enum ObservedAspectObservationDocumentation.ObservedAspectLowCardinalityKeyName

extends Enum<ObservedAspectObservationDocumentation.ObservedAspectLowCardinalityKeyName>
implements KeyName
Class Inheritance
All Implemented Interfaces
io.micrometer.common.docs.KeyName

Field Summary

Modifier and TypeField and Description
public static final ObservedAspectObservationDocumentation.ObservedAspectLowCardinalityKeyName
CLASS_NAME

public static final ObservedAspectObservationDocumentation.ObservedAspectLowCardinalityKeyName
METHOD_NAME

Constructor Summary

AccessConstructor and Description
private
ObservedAspectLowCardinalityKeyName()

Method Summary

Modifier and TypeMethod and Description
public static ObservedAspectObservationDocumentation.ObservedAspectLowCardinalityKeyName
valueOf(String name)

public static ObservedAspectObservationDocumentation.ObservedAspectLowCardinalityKeyName[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

CLASS_NAMEback to summary
public static final ObservedAspectObservationDocumentation.ObservedAspectLowCardinalityKeyName CLASS_NAME
METHOD_NAMEback to summary
public static final ObservedAspectObservationDocumentation.ObservedAspectLowCardinalityKeyName METHOD_NAME

Constructor Detail

ObservedAspectLowCardinalityKeyNameback to summary
private ObservedAspectLowCardinalityKeyName()

Method Detail

valueOfback to summary
public static ObservedAspectObservationDocumentation.ObservedAspectLowCardinalityKeyName valueOf(String name)
valuesback to summary
public static ObservedAspectObservationDocumentation.ObservedAspectLowCardinalityKeyName[] values()