Package io.honeycomb.beeline.tracing.propagation

Class BeelineServletFilter.Builder

java.lang.Object

io.honeycomb.beeline.tracing.propagation.BeelineServletFilter.Builder

Enclosing class:

BeelineServletFilter

public static class BeelineServletFilter.Builder
extends Object

Helper class to construct a BeelineServletFilter

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
BeelineServletFilter	build()
BeelineServletFilter.Builder	setBeeline(Beeline beeline)	Set the Beeline.
BeelineServletFilter.Builder	setExcludePaths(List<String> excludePaths)	Set the Ant patterns for matching requests to exclude when tracing.
BeelineServletFilter.Builder	setIncludePaths(List<String> includePaths)	Set the Ant patterns for matching requests to include when tracing.
BeelineServletFilter.Builder	setPathMatcher(PathMatcher pathMatcher)	Set the path matcher to use when matching on request paths.
BeelineServletFilter.Builder	setRequestToRedispatchSpanName(Function<javax.servlet.http.HttpServletRequest,String> requestToRedispatchSpanName)	Sets the function to use when creating redispatch span names.
BeelineServletFilter.Builder	setRequestToSpanName(Function<HttpServerRequestAdapter,String> requestToSpanName)	Sets the function to use when creating request span names.
BeelineServletFilter.Builder	setServiceName(String serviceName)	Set the name of the service using the filter.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

setServiceName

public BeelineServletFilter.Builder setServiceName(String serviceName)

Set the name of the service using the filter. Required.

Parameters:

serviceName - the name of the service using the filter

Returns:

this

setBeeline

public BeelineServletFilter.Builder setBeeline(Beeline beeline)

Set the Beeline. Required.

Parameters:

beeline - the beeline

Returns:

this

setIncludePaths

public BeelineServletFilter.Builder setIncludePaths(List<String> includePaths)

Set the Ant patterns for matching requests to include when tracing.

Optional. By default all requests are included.

Parameters:

includePaths - the Ant patterns for matching requests to include

Returns:

this

setExcludePaths

public BeelineServletFilter.Builder setExcludePaths(List<String> excludePaths)

Set the Ant patterns for matching requests to exclude when tracing.

Optional. By default no requests are excluded.

Parameters:

excludePaths - the Ant patterns for matching requests to exclude

Returns:

this

setPathMatcher

public BeelineServletFilter.Builder setPathMatcher(PathMatcher pathMatcher)

Set the path matcher to use when matching on request paths.

Optional. Defaults to AntPathMatcher.

Parameters:

pathMatcher - the path matcher

Returns:

this

setRequestToRedispatchSpanName

public BeelineServletFilter.Builder setRequestToRedispatchSpanName(Function<javax.servlet.http.HttpServletRequest,String> requestToRedispatchSpanName)

Sets the function to use when creating redispatch span names.

Optional. By default uses BeelineServletFilter.DEFAULT_REDISPATCH_SPAN_NAMING_FUNCTION.

Parameters:

requestToRedispatchSpanName - the function to use when creating redispatch span names

Returns:

this

setRequestToSpanName

public BeelineServletFilter.Builder setRequestToSpanName(Function<HttpServerRequestAdapter,String> requestToSpanName)

Sets the function to use when creating request span names.

Optional. By default uses BeelineServletFilter.DEFAULT_REQUEST_SPAN_NAMING_FUNCTION.

Parameters:

requestToSpanName - the function to use when creating request span names

Returns:

this

build

public BeelineServletFilter build()