Package com.mongodb.observability.micrometer

Enum Class MongodbObservation

java.lang.Object

java.lang.Enum<MongodbObservation>

com.mongodb.observability.micrometer.MongodbObservation

All Implemented Interfaces:

io.micrometer.observation.docs.ObservationDocumentation, Serializable, Comparable<MongodbObservation>, java.lang.constant.Constable

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

MongoDB ObservationDocumentation definitions for operation-level and command-level observations.

These are split into two separate observation types so that each has a distinct name and a fixed set of low-cardinality tag keys. This is required by Prometheus which rejects meters that share a name but have different tag key sets.

Since:

5.7

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	MongodbObservation.CommandLowCardinalityKeyNames	Low cardinality key names for command-level observations.
static enum	MongodbObservation.HighCardinalityKeyNames	High cardinality (highly variable values) key names for command-level observations.
static enum	MongodbObservation.OperationLowCardinalityKeyNames	Low cardinality key names for operation-level observations.
static enum	MongodbObservation.TransactionLowCardinalityKeyNames	Low cardinality key names for transaction observations.

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

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
MONGODB_COMMAND	Observation for wire-protocol MongoDB commands sent to the server.
MONGODB_OPERATION	Observation for high-level MongoDB operations (e.g.
MONGODB_TRANSACTION	Observation for MongoDB transactions.

Field Summary

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

EMPTY, EMPTY_EVENT_NAMES

Method Summary

Modifier and Type	Method	Description
static MongodbObservation	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MongodbObservation[]	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

MONGODB_OPERATION

public static final MongodbObservation MONGODB_OPERATION

Observation for high-level MongoDB operations (e.g. find, insert, update). Created per user-initiated operation, may contain multiple command spans.

MONGODB_COMMAND

public static final MongodbObservation MONGODB_COMMAND

Observation for wire-protocol MongoDB commands sent to the server. Created per actual command (nested under an operation span).

MONGODB_TRANSACTION

public static final MongodbObservation MONGODB_TRANSACTION

Observation for MongoDB transactions. Created per transaction lifecycle (startTransaction to commit/abort).

Method Details

values

public static MongodbObservation[] 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 MongodbObservation 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