Package com.couchbase.client.core.cnc.tracing

Enum ObservabilitySemanticConvention

java.lang.Object

java.lang.Enum<ObservabilitySemanticConvention>

com.couchbase.client.core.cnc.tracing.ObservabilitySemanticConvention

All Implemented Interfaces:

Serializable, Comparable<ObservabilitySemanticConvention>

@Uncommitted
public enum ObservabilitySemanticConvention
extends Enum<ObservabilitySemanticConvention>

Spans and metrics can be output in two formats:

The first, internally identified as "v0", follows the OpenTelemetry standard prior to its 1.23.0. The second, internally identified as "v1", follows the post-1.23.0 standard.

To provide backwards compatibility "v0" is the default if nothing is specified.

Enum Constant Summary

Enum Constants

Enum Constant	Description
DATABASE	Outputs only the post-1.23.0 OpenTelemetry standard ("v1")
DATABASE_DUP	Outputs both the pre and post-1.23.0 OpenTelemetry standard ("v0" and "v1").

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DATABASE

public static final ObservabilitySemanticConvention DATABASE

Outputs only the post-1.23.0 OpenTelemetry standard ("v1")

DATABASE_DUP

public static final ObservabilitySemanticConvention DATABASE_DUP

Outputs both the pre and post-1.23.0 OpenTelemetry standard ("v0" and "v1"). This is intended to support users transitioning between the two. Spans will have attributes reflecting both standards. Two versions of each metric will be output.

Method Details

values

public static ObservabilitySemanticConvention[] values()

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

Returns:

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

valueOf

public static ObservabilitySemanticConvention valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

loadAndParseOpenTelemetryEnvVar

public static List<ObservabilitySemanticConvention> loadAndParseOpenTelemetryEnvVar()