Package org.eclipse.ditto.services.utils.tracing

Class TraceUtils

java.lang.Object

org.eclipse.ditto.services.utils.tracing.TraceUtils

@Immutable
public final class TraceUtils
extends Object

Utility for tracing Http requests.

Method Summary

Modifier and Type	Method	Description
static String	metricizeTraceUri(String traceUri)	Replaces all characters that are invalid for metrics (at least for Prometheus metrics).
static ExpiringTimerBuilder	newAmqpRoundTripTimer(org.eclipse.ditto.signals.base.Signal<?> command)	Prepares an ExpiringTimerBuilder with default AMQP_ROUNDTRIP_METRIC_NAME and tags.
static ExpiringTimerBuilder	newAmqpRoundTripTimer(org.eclipse.ditto.signals.commands.base.Command<?> command)	Prepares an ExpiringTimerBuilder with default AMQP_ROUNDTRIP_METRIC_NAME and tags.
static ExpiringTimerBuilder	newAuthFilterTimer(CharSequence authenticationType)	Prepares an ExpiringTimerBuilder with default FILTER_AUTH_METRIC_NAME and tags.
static ExpiringTimerBuilder	newAuthFilterTimer(CharSequence authenticationType, akka.http.javadsl.model.HttpRequest request)	Prepares an ExpiringTimerBuilder with default FILTER_AUTH_METRIC_NAME and tags.
static ExpiringTimerBuilder	newHttpRoundTripTimer(akka.http.javadsl.model.HttpRequest request)	Prepares an ExpiringTimerBuilder with default HTTP_ROUNDTRIP_METRIC_NAME and tags.

Methods inherited from class java.lang.Object

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

Method Detail

newHttpRoundTripTimer

public static ExpiringTimerBuilder newHttpRoundTripTimer(akka.http.javadsl.model.HttpRequest request)

Prepares an ExpiringTimerBuilder with default HTTP_ROUNDTRIP_METRIC_NAME and tags.

Parameters:

request - The request to extract tags and request method.

Returns:

The prepared ExpiringTimerBuilder

newAmqpRoundTripTimer

public static ExpiringTimerBuilder newAmqpRoundTripTimer(org.eclipse.ditto.signals.commands.base.Command<?> command)

Prepares an ExpiringTimerBuilder with default AMQP_ROUNDTRIP_METRIC_NAME and tags.

Parameters:

command - The command to extract tags.

Returns:

The prepared ExpiringTimerBuilder

newAmqpRoundTripTimer

public static ExpiringTimerBuilder newAmqpRoundTripTimer(org.eclipse.ditto.signals.base.Signal<?> command)

Prepares an ExpiringTimerBuilder with default AMQP_ROUNDTRIP_METRIC_NAME and tags.

Parameters:

command - The command to extract tags.

Returns:

The prepared ExpiringTimerBuilder

newAuthFilterTimer

public static ExpiringTimerBuilder newAuthFilterTimer(CharSequence authenticationType)

Prepares an ExpiringTimerBuilder with default FILTER_AUTH_METRIC_NAME and tags.

Parameters:

authenticationType - The name of the authentication type (i.e. jwt, ..)

Returns:

The prepared ExpiringTimerBuilder

newAuthFilterTimer

public static ExpiringTimerBuilder newAuthFilterTimer(CharSequence authenticationType,
                                                      akka.http.javadsl.model.HttpRequest request)

Prepares an ExpiringTimerBuilder with default FILTER_AUTH_METRIC_NAME and tags.

Parameters:

authenticationType - The name of the authentication type (i.e. jwt,...)

request - The HttpRequest used to extract required tags.

Returns:

The prepared ExpiringTimerBuilder

metricizeTraceUri

public static String metricizeTraceUri(String traceUri)

Replaces all characters that are invalid for metrics (at least for Prometheus metrics).