micrometer-tracing 1.2.3 · io.micrometer.tracing.docs.SpanDocumentation

In order to describe your spans via e.g. enums instead of Strings you can use this interface that returns all the characteristics of a span. In Micrometer Tracing we analyze the sources and reuse this information to build a table of known spans, their names, tags and events.

We can generate documentation for all created spans but certain requirements need to be met

Metrics are grouped within an enum - the enum implements the SpanDocumentation interface
If the span contains KeyName then those need to be declared as nested enums
If the span contains EventValue then those need to be declared as nested enums
The SpanDocumentation#getKeyNames() need to call the nested enum's values() method to retrieve the array of allowed keys
The SpanDocumentation#getEvents() need to call the nested enum's values() method to retrieve the array of allowed events
Javadocs around enums will be used as description

Field Summary

Modifier and Type	Field and Description
public static final KeyName[]	EMPTY_KEY_NAMES Empty key names.
public static final EventValue[]	EMPTY_VALUES Empty values.

Method Summary

Modifier and Type	Method and Description
public default KeyName[]	Returns: additional key names - if set will append any key names coming from `SpanDocumentation#overridesDefaultSpanFrom()` getAdditionalKeyNames() Additional key names.
public default EventValue[]	Returns: allowed events getEvents() Allowed events.
public default KeyName[]	Returns: allowed key names - if set will override any key names coming from `SpanDocumentation#overridesDefaultSpanFrom()` getKeyNames() Allowed key names.
public String	Returns: metric name getName() Span name.
public default String	Returns: constructed name getName(String... variables to pass to `String#format(String, Object...)` vars) Builds a name from provided vars.
public default String	Returns: required prefix getPrefix() Returns required prefix to be there for tags.
public default Enum<?>	Returns: `io.micrometer.observation.docs.ObservationDocumentation` for which you don't want to create a default span documentation overridesDefaultSpanFrom() Override this when custom span should be documented instead of the default one.

Field Detail

EMPTY_KEY_NAMES	back to summary
public static final KeyName[] EMPTY_KEY_NAMES Empty key names.

EMPTY_VALUES	back to summary
public static final EventValue[] EMPTY_VALUES Empty values.

Method Detail

getAdditionalKeyNames back to summary

getAdditionalKeyNames	back to summary
public default KeyName[] getAdditionalKeyNames() Additional key names. Returns:KeyName[] additional key names - if set will append any key names coming from `SpanDocumentation#overridesDefaultSpanFrom()`

public default KeyName[] getAdditionalKeyNames()

Additional key names.

Returns:KeyName[]: additional key names - if set will append any key names coming from SpanDocumentation#overridesDefaultSpanFrom()

getEvents	back to summary
public default EventValue[] getEvents() Allowed events. Returns:EventValue[] allowed events

getEvents

back to summary

public default EventValue[] getEvents()

Allowed events.

Returns:EventValue[]: allowed events

getKeyNames back to summary

getKeyNames	back to summary
public default KeyName[] getKeyNames() Allowed key names. Returns:KeyName[] allowed key names - if set will override any key names coming from `SpanDocumentation#overridesDefaultSpanFrom()`

public default KeyName[] getKeyNames()

Allowed key names.

Returns:KeyName[]: allowed key names - if set will override any key names coming from SpanDocumentation#overridesDefaultSpanFrom()

getName	back to summary
public String getName() Span name. Returns:String metric name

getName

back to summary

public String getName()

Span name.

Returns:String: metric name

getName back to summary

getName	back to summary
public default String getName(String... vars) Builds a name from provided vars. Follows the `String#format(String, Object...)` patterns. Parameters vars:String[] variables to pass to `String#format(String, Object...)` Returns:String constructed name

public default String getName(String... vars)

Builds a name from provided vars. Follows the String#format(String, Object...) patterns.

Parameters

vars:String[]: variables to pass to String#format(String, Object...)

Returns:String

constructed name

getPrefix back to summary

getPrefix	back to summary
public default String getPrefix() Returns required prefix to be there for tags. For example, `foo.` would require the tags to have a `foo.` prefix like this: `foo.bar=true`. Returns:String required prefix

public default String getPrefix()

Returns required prefix to be there for tags. For example, foo. would require the tags to have a foo. prefix like this: foo.bar=true.

Returns:String: required prefix

overridesDefaultSpanFrom back to summary

overridesDefaultSpanFrom	back to summary
public default Enum<?> overridesDefaultSpanFrom() Override this when custom span should be documented instead of the default one. Returns:Enum<?> `io.micrometer.observation.docs.ObservationDocumentation` for which you don't want to create a default span documentation

public default Enum<?> overridesDefaultSpanFrom()

Override this when custom span should be documented instead of the default one.

Returns:Enum<?>: io.micrometer.observation.docs.ObservationDocumentation for which you don't want to create a default span documentation

public Interface SpanDocumentation

Field Summary

Method Summary

Field Detail

Method Detail