Package uk.gov.gchq.gaffer.commonutil.otel

Class OtelUtil

java.lang.Object

uk.gov.gchq.gaffer.commonutil.otel.OtelUtil

public final class OtelUtil
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static String	GRAPH_ID_ATTRIBUTE
static String	GREMLIN_QUERY_ATTRIBUTE
static String	JOB_ID_ATTRIBUTE
static String	OP_OPTIONS_ATTRIBUTE
static String	USER_ATTRIBUTE
static String	VIEW_ATTRIBUTE

Method Summary

Modifier and Type	Method	Description
static boolean	getOpenTelemetryActive()	Get if OpenTelemetry is in use.
static void	setOpenTelemetryActive(boolean active)	Set if OpenTelemetry is in use.
static io.opentelemetry.api.trace.Span	startSpan(String tracerName, String spanName)	Creates a new span with the given tracer and span names, note will return an 'invalid' span if OpenTelementry is turned off.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

USER_ATTRIBUTE

public static final String USER_ATTRIBUTE

See Also:

Constant Field Values

JOB_ID_ATTRIBUTE

public static final String JOB_ID_ATTRIBUTE

See Also:

Constant Field Values

GRAPH_ID_ATTRIBUTE

public static final String GRAPH_ID_ATTRIBUTE

See Also:

Constant Field Values

VIEW_ATTRIBUTE

public static final String VIEW_ATTRIBUTE

See Also:

Constant Field Values

OP_OPTIONS_ATTRIBUTE

public static final String OP_OPTIONS_ATTRIBUTE

See Also:

Constant Field Values

GREMLIN_QUERY_ATTRIBUTE

public static final String GREMLIN_QUERY_ATTRIBUTE

See Also:

Constant Field Values

Method Detail

startSpan

public static io.opentelemetry.api.trace.Span startSpan(String tracerName,
                                                        String spanName)

Creates a new span with the given tracer and span names, note will return an 'invalid' span if OpenTelementry is turned off.

Parameters:

tracerName - Name of the Tracer to use

spanName - Name of the Span to use.

Returns:

new Span

getOpenTelemetryActive

public static boolean getOpenTelemetryActive()

Get if OpenTelemetry is in use.

Returns:

Is active

setOpenTelemetryActive

public static void setOpenTelemetryActive(boolean active)

Set if OpenTelemetry is in use.

Parameters:

active - Is active