io.micronaut.tracing.instrument.http

Class AbstractOpenTracingFilter

java.lang.Object

io.micronaut.tracing.instrument.http.AbstractOpenTracingFilter

All Implemented Interfaces:

Ordered, HttpFilter

Direct Known Subclasses:

OpenTracingClientFilter, OpenTracingServerFilter

public abstract class AbstractOpenTracingFilter
extends Object
implements HttpFilter

Abstract filter used for Open Tracing based HTTP tracing.

Since:

1.0

Author:

graemerocher

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLIENT_PATH
static String	SERVER_PATH
static String	TAG_ERROR
static String	TAG_HTTP_CLIENT
static String	TAG_HTTP_SERVER
static String	TAG_HTTP_STATUS_CODE
static String	TAG_METHOD
static String	TAG_PATH
protected io.opentracing.Tracer	tracer

Fields inherited from interface io.micronaut.core.order.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
AbstractOpenTracingFilter(io.opentracing.Tracer tracer) Configure tracer in the filter for span creation and propagation across arbitrary transports.

Method Summary

Modifier and Type	Method and Description
protected io.opentracing.Tracer.SpanBuilder	newSpan(HttpRequest<?> request, io.opentracing.SpanContext spanContext) Creates a new span for the given request and span context.
protected String	resolveSpanName(HttpRequest<?> request) Resolve the span name to use for the request.
protected void	setErrorTags(io.opentracing.Span span, Throwable error) Sets the error tags to use on the span.
protected void	setResponseTags(HttpRequest<?> request, HttpResponse<?> response, io.opentracing.Span span) Sets the response tags.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.http.filter.HttpFilter

doFilter

Methods inherited from interface io.micronaut.core.order.Ordered

getOrder

Field Detail

CLIENT_PATH

public static final String CLIENT_PATH

See Also:

Constant Field Values

SERVER_PATH

public static final String SERVER_PATH

See Also:

Constant Field Values

TAG_METHOD

public static final String TAG_METHOD

See Also:

Constant Field Values

TAG_PATH

public static final String TAG_PATH

See Also:

Constant Field Values

TAG_ERROR

public static final String TAG_ERROR

See Also:

Constant Field Values

TAG_HTTP_STATUS_CODE

public static final String TAG_HTTP_STATUS_CODE

See Also:

Constant Field Values

TAG_HTTP_CLIENT

public static final String TAG_HTTP_CLIENT

See Also:

Constant Field Values

TAG_HTTP_SERVER

public static final String TAG_HTTP_SERVER

See Also:

Constant Field Values

tracer

protected final io.opentracing.Tracer tracer

Constructor Detail

AbstractOpenTracingFilter

public AbstractOpenTracingFilter(io.opentracing.Tracer tracer)

Configure tracer in the filter for span creation and propagation across arbitrary transports.

Parameters:

tracer - The tracer

Method Detail

setResponseTags

protected void setResponseTags(HttpRequest<?> request,
                               HttpResponse<?> response,
                               io.opentracing.Span span)

Sets the response tags.

Parameters:

request - The request

response - The response

span - The span

setErrorTags

protected void setErrorTags(io.opentracing.Span span,
                            Throwable error)

Sets the error tags to use on the span.

Parameters:

span - The span

error - The error

resolveSpanName

protected String resolveSpanName(HttpRequest<?> request)

Resolve the span name to use for the request.

Parameters:

request - The request

Returns:

The span name

newSpan

protected io.opentracing.Tracer.SpanBuilder newSpan(HttpRequest<?> request,
                                                    io.opentracing.SpanContext spanContext)

Creates a new span for the given request and span context.

Parameters:

request - The request

spanContext - The span context

Returns:

The span builder