Package org.springframework.kafka.support.micrometer

Enum Class KafkaTemplateObservation

java.lang.Object

java.lang.Enum<KafkaTemplateObservation>

org.springframework.kafka.support.micrometer.KafkaTemplateObservation

All Implemented Interfaces:

io.micrometer.observation.docs.ObservationDocumentation, Serializable, Comparable<KafkaTemplateObservation>, Constable

public enum KafkaTemplateObservation
extends Enum<KafkaTemplateObservation>
implements io.micrometer.observation.docs.ObservationDocumentation

Spring for Apache Kafka Observation for KafkaTemplate.

Since:

3.0

Author:

Gary Russell, Christian Mergenthaler, Wang Zhiyang

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	KafkaTemplateObservation.DefaultKafkaTemplateObservationConvention	Default KafkaTemplateObservationConvention for Kafka template key values.
static enum	KafkaTemplateObservation.TemplateLowCardinalityTags	Low cardinality tags.

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
TEMPLATE_OBSERVATION	Observation for KafkaTemplates.

Field Summary

Fields inherited from interface io.micrometer.observation.docs.ObservationDocumentation

EMPTY, EMPTY_EVENT_NAMES

Method Summary

Modifier and Type	Method	Description
static KafkaTemplateObservation	valueOf(String name)	Returns the enum constant of this class with the specified name.
static KafkaTemplateObservation[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.micrometer.observation.docs.ObservationDocumentation

getContextualName, getDefaultConvention, getEvents, getHighCardinalityKeyNames, getLowCardinalityKeyNames, getName, getPrefix, observation, observation, observation, start, start, start

Enum Constant Details

TEMPLATE_OBSERVATION

public static final KafkaTemplateObservation TEMPLATE_OBSERVATION

Observation for KafkaTemplates.

Method Details

values

public static KafkaTemplateObservation[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static KafkaTemplateObservation valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null