org.apache.camel.opentracing

Class OpenTracingTracer

java.lang.Object

org.apache.camel.support.service.ServiceSupport

org.apache.camel.opentracing.OpenTracingTracer

All Implemented Interfaces:

AutoCloseable, org.apache.camel.CamelContextAware, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.RoutePolicyFactory, org.apache.camel.StatefulService, org.apache.camel.StaticService, org.apache.camel.SuspendableService

@ManagedResource(description="OpenTracingTracer")
public class OpenTracingTracer
extends org.apache.camel.support.service.ServiceSupport
implements org.apache.camel.spi.RoutePolicyFactory, org.apache.camel.StaticService, org.apache.camel.CamelContextAware

To use OpenTracing with Camel then setup this OpenTracingTracer in your Camel application.

This class is implemented as both an EventNotifier and RoutePolicy that allows to trap when Camel starts/ends an Exchange being routed using the RoutePolicy and during the routing if the Exchange sends messages, then we track them using the EventNotifier.

Field Summary

Fields inherited from class org.apache.camel.support.service.ServiceSupport

BUILDED, FAILED, INITIALIZED, lock, NEW, SHUTDOWN, SHUTTINGDOWN, STARTED, STARTING, status, STOPPED, STOPPING, SUSPENDED, SUSPENDING

Constructor Summary

Constructors

Constructor and Description
OpenTracingTracer()

Method Summary

Modifier and Type	Method and Description
void	addDecorator(SpanDecorator decorator) To add a custom decorator that does not come out of the box with camel-opentracing.
void	addExcludePattern(String pattern) Adds an exclude pattern that will disable tracing for Camel messages that matches the pattern.
org.apache.camel.spi.RoutePolicy	createRoutePolicy(org.apache.camel.CamelContext camelContext, String routeId, org.apache.camel.NamedNode route)
protected void	doStart()
protected void	doStop()
org.apache.camel.CamelContext	getCamelContext()
Set<String>	getExcludePatterns()
protected SpanDecorator	getSpanDecorator(org.apache.camel.Endpoint endpoint)
io.opentracing.Tracer	getTracer()
void	init(org.apache.camel.CamelContext camelContext) Registers this OpenTracingTracer on the CamelContext if not already registered.
boolean	isEncoding()
void	setCamelContext(org.apache.camel.CamelContext camelContext)
void	setEncoding(boolean encoding)
void	setExcludePatterns(Set<String> excludePatterns)
void	setTracer(io.opentracing.Tracer tracer)

Methods inherited from class org.apache.camel.support.service.ServiceSupport

build, doBuild, doInit, doResume, doShutdown, doSuspend, getStatus, init, isBuild, isInit, isNew, isRunAllowed, isShutdown, isStarted, isStarting, isStartingOrStarted, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.camel.Service

build, close, init, start, stop

Methods inherited from interface org.apache.camel.CamelContextAware

trySetCamelContext

Constructor Detail

OpenTracingTracer

public OpenTracingTracer()

Method Detail

addDecorator

public void addDecorator(SpanDecorator decorator)

To add a custom decorator that does not come out of the box with camel-opentracing.

createRoutePolicy

public org.apache.camel.spi.RoutePolicy createRoutePolicy(org.apache.camel.CamelContext camelContext,
                                                          String routeId,
                                                          org.apache.camel.NamedNode route)

Specified by:

createRoutePolicy in interface org.apache.camel.spi.RoutePolicyFactory

init

public void init(org.apache.camel.CamelContext camelContext)

Registers this OpenTracingTracer on the CamelContext if not already registered.

getCamelContext

public org.apache.camel.CamelContext getCamelContext()

Specified by:

getCamelContext in interface org.apache.camel.CamelContextAware

setCamelContext

public void setCamelContext(org.apache.camel.CamelContext camelContext)

Specified by:

setCamelContext in interface org.apache.camel.CamelContextAware

getExcludePatterns

public Set<String> getExcludePatterns()

setExcludePatterns

public void setExcludePatterns(Set<String> excludePatterns)

isEncoding

public boolean isEncoding()

setEncoding

public void setEncoding(boolean encoding)

addExcludePattern

public void addExcludePattern(String pattern)

Adds an exclude pattern that will disable tracing for Camel messages that matches the pattern.

Parameters:

pattern - the pattern such as route id, endpoint url

getTracer

public io.opentracing.Tracer getTracer()

setTracer

public void setTracer(io.opentracing.Tracer tracer)

doStart

protected void doStart()
                throws Exception

Specified by:

doStart in class org.apache.camel.support.service.ServiceSupport

Throws:

Exception

doStop

protected void doStop()
               throws Exception

Specified by:

doStop in class org.apache.camel.support.service.ServiceSupport

Throws:

Exception

getSpanDecorator

protected SpanDecorator getSpanDecorator(org.apache.camel.Endpoint endpoint)