Package com.mongodb.observability.micrometer

Enum Class MongodbObservation.HighCardinalityKeyNames

java.lang.Object

java.lang.Enum<MongodbObservation.HighCardinalityKeyNames>

com.mongodb.observability.micrometer.MongodbObservation.HighCardinalityKeyNames

All Implemented Interfaces:

io.micrometer.common.docs.KeyName, Serializable, Comparable<MongodbObservation.HighCardinalityKeyNames>, java.lang.constant.Constable

Enclosing class:

MongodbObservation

public static enum MongodbObservation.HighCardinalityKeyNames
extends Enum<MongodbObservation.HighCardinalityKeyNames>
implements io.micrometer.common.docs.KeyName

High cardinality (highly variable values) key names for command-level observations.

Nested Class Summary

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

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLIENT_CONNECTION_ID	The client-side driver connection ID (db.mongodb.driver_connection_id).
CURSOR_ID	The cursor ID (db.mongodb.cursor_id).
EXCEPTION_MESSAGE	The exception message (exception.message).
EXCEPTION_STACKTRACE	The exception stacktrace (exception.stacktrace).
EXCEPTION_TYPE	The exception type (exception.type).
QUERY_TEXT	The database query text (db.query.text).
SERVER_CONNECTION_ID	The server-side connection ID (db.mongodb.server_connection_id).
SESSION_ID	The logical session ID (db.mongodb.lsid).
TRANSACTION_NUMBER	The transaction number (db.mongodb.txn_number).

Method Summary

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

asString, isRequired, withValue, withValue

Enum Constant Details

QUERY_TEXT

public static final MongodbObservation.HighCardinalityKeyNames QUERY_TEXT

The database query text (db.query.text).

CLIENT_CONNECTION_ID

public static final MongodbObservation.HighCardinalityKeyNames CLIENT_CONNECTION_ID

The client-side driver connection ID (db.mongodb.driver_connection_id).

SERVER_CONNECTION_ID

public static final MongodbObservation.HighCardinalityKeyNames SERVER_CONNECTION_ID

The server-side connection ID (db.mongodb.server_connection_id).

CURSOR_ID

public static final MongodbObservation.HighCardinalityKeyNames CURSOR_ID

The cursor ID (db.mongodb.cursor_id).

TRANSACTION_NUMBER

public static final MongodbObservation.HighCardinalityKeyNames TRANSACTION_NUMBER

The transaction number (db.mongodb.txn_number).

SESSION_ID

public static final MongodbObservation.HighCardinalityKeyNames SESSION_ID

The logical session ID (db.mongodb.lsid).

EXCEPTION_MESSAGE

public static final MongodbObservation.HighCardinalityKeyNames EXCEPTION_MESSAGE

The exception message (exception.message).

EXCEPTION_TYPE

public static final MongodbObservation.HighCardinalityKeyNames EXCEPTION_TYPE

The exception type (exception.type).

EXCEPTION_STACKTRACE

public static final MongodbObservation.HighCardinalityKeyNames EXCEPTION_STACKTRACE

The exception stacktrace (exception.stacktrace).

Method Details

values

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