Package org.apache.camel.impl.debugger
Class BacklogTracer
java.lang.Object
org.apache.camel.support.service.BaseService
org.apache.camel.support.service.ServiceSupport
org.apache.camel.impl.debugger.BacklogTracer
- All Implemented Interfaces:
AutoCloseable
,org.apache.camel.Service
,org.apache.camel.ShutdownableService
,org.apache.camel.spi.BacklogTracer
,org.apache.camel.StatefulService
,org.apache.camel.SuspendableService
public final class BacklogTracer
extends org.apache.camel.support.service.ServiceSupport
implements org.apache.camel.spi.BacklogTracer
A tracer used for message tracing, storing a copy of the message details in a backlog.
This tracer allows to store message tracers per node in the Camel routes. The tracers is stored in a backlog queue
(FIFO based) which allows to pull the traced messages on demand.
-
Field Summary
Fields inherited from class org.apache.camel.support.service.BaseService
BUILT, FAILED, INITIALIZED, INITIALIZING, lock, NEW, SHUTDOWN, SHUTTING_DOWN, STARTED, STARTING, status, STOPPED, STOPPING, SUSPENDED, SUSPENDING
-
Method Summary
Modifier and TypeMethodDescriptionvoid
clear()
static BacklogTracer
createTracer
(org.apache.camel.CamelContext context) Creates a new backlog tracer.protected void
doStop()
List
<org.apache.camel.spi.BacklogTracerEventMessage> List
<org.apache.camel.spi.BacklogTracerEventMessage> dumpTracedMessages
(String nodeId) dumpTracedMessagesAsJSon
(String nodeId) dumpTracedMessagesAsXml
(String nodeId) int
int
long
long
long
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
void
void
setBacklogSize
(int backlogSize) void
setBodyIncludeFiles
(boolean bodyIncludeFiles) void
setBodyIncludeStreams
(boolean bodyIncludeStreams) void
setBodyMaxChars
(int bodyMaxChars) void
setEnabled
(boolean enabled) void
setIncludeException
(boolean includeException) void
setIncludeExchangeProperties
(boolean includeExchangeProperties) void
setIncludeExchangeVariables
(boolean includeExchangeVariables) void
setRemoveOnDump
(boolean removeOnDump) void
setStandby
(boolean standby) void
setTraceFilter
(String filter) void
setTracePattern
(String tracePattern) void
setTraceRests
(boolean traceRests) void
setTraceTemplates
(boolean traceTemplates) boolean
shouldTrace
(org.apache.camel.NamedNode definition, org.apache.camel.Exchange exchange) Whether or not to trace the given processor definition.void
Methods inherited from class org.apache.camel.support.service.BaseService
build, doBuild, doFail, doInit, doLifecycleChange, doResume, doShutdown, doStart, doSuspend, fail, 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.ShutdownableService
shutdown
Methods inherited from interface org.apache.camel.StatefulService
getStatus, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isSuspending
Methods inherited from interface org.apache.camel.SuspendableService
isSuspended, resume, suspend
-
Field Details
-
MAX_BACKLOG_SIZE
public static final int MAX_BACKLOG_SIZE- See Also:
-
-
Method Details
-
createTracer
Creates a new backlog tracer.- Parameters:
context
- Camel context- Returns:
- a new backlog tracer
-
shouldTrace
public boolean shouldTrace(org.apache.camel.NamedNode definition, org.apache.camel.Exchange exchange) Whether or not to trace the given processor definition.- Parameters:
definition
- the processor definitionexchange
- the exchange- Returns:
- true to trace, false to skip tracing
-
traceEvent
-
isEnabled
public boolean isEnabled()- Specified by:
isEnabled
in interfaceorg.apache.camel.spi.BacklogTracer
-
setEnabled
public void setEnabled(boolean enabled) - Specified by:
setEnabled
in interfaceorg.apache.camel.spi.BacklogTracer
-
isStandby
public boolean isStandby()- Specified by:
isStandby
in interfaceorg.apache.camel.spi.BacklogTracer
-
setStandby
public void setStandby(boolean standby) - Specified by:
setStandby
in interfaceorg.apache.camel.spi.BacklogTracer
-
getBacklogSize
public int getBacklogSize()- Specified by:
getBacklogSize
in interfaceorg.apache.camel.spi.BacklogTracer
-
setBacklogSize
public void setBacklogSize(int backlogSize) - Specified by:
setBacklogSize
in interfaceorg.apache.camel.spi.BacklogTracer
-
isRemoveOnDump
public boolean isRemoveOnDump()- Specified by:
isRemoveOnDump
in interfaceorg.apache.camel.spi.BacklogTracer
-
setRemoveOnDump
public void setRemoveOnDump(boolean removeOnDump) - Specified by:
setRemoveOnDump
in interfaceorg.apache.camel.spi.BacklogTracer
-
getBodyMaxChars
public int getBodyMaxChars()- Specified by:
getBodyMaxChars
in interfaceorg.apache.camel.spi.BacklogTracer
-
setBodyMaxChars
public void setBodyMaxChars(int bodyMaxChars) - Specified by:
setBodyMaxChars
in interfaceorg.apache.camel.spi.BacklogTracer
-
isBodyIncludeStreams
public boolean isBodyIncludeStreams()- Specified by:
isBodyIncludeStreams
in interfaceorg.apache.camel.spi.BacklogTracer
-
setBodyIncludeStreams
public void setBodyIncludeStreams(boolean bodyIncludeStreams) - Specified by:
setBodyIncludeStreams
in interfaceorg.apache.camel.spi.BacklogTracer
-
isBodyIncludeFiles
public boolean isBodyIncludeFiles()- Specified by:
isBodyIncludeFiles
in interfaceorg.apache.camel.spi.BacklogTracer
-
setBodyIncludeFiles
public void setBodyIncludeFiles(boolean bodyIncludeFiles) - Specified by:
setBodyIncludeFiles
in interfaceorg.apache.camel.spi.BacklogTracer
-
isIncludeExchangeProperties
public boolean isIncludeExchangeProperties()- Specified by:
isIncludeExchangeProperties
in interfaceorg.apache.camel.spi.BacklogTracer
-
setIncludeExchangeProperties
public void setIncludeExchangeProperties(boolean includeExchangeProperties) - Specified by:
setIncludeExchangeProperties
in interfaceorg.apache.camel.spi.BacklogTracer
-
isIncludeExchangeVariables
public boolean isIncludeExchangeVariables()- Specified by:
isIncludeExchangeVariables
in interfaceorg.apache.camel.spi.BacklogTracer
-
setIncludeExchangeVariables
public void setIncludeExchangeVariables(boolean includeExchangeVariables) - Specified by:
setIncludeExchangeVariables
in interfaceorg.apache.camel.spi.BacklogTracer
-
isIncludeException
public boolean isIncludeException()- Specified by:
isIncludeException
in interfaceorg.apache.camel.spi.BacklogTracer
-
setIncludeException
public void setIncludeException(boolean includeException) - Specified by:
setIncludeException
in interfaceorg.apache.camel.spi.BacklogTracer
-
isTraceRests
public boolean isTraceRests()- Specified by:
isTraceRests
in interfaceorg.apache.camel.spi.BacklogTracer
-
setTraceRests
public void setTraceRests(boolean traceRests) - Specified by:
setTraceRests
in interfaceorg.apache.camel.spi.BacklogTracer
-
isTraceTemplates
public boolean isTraceTemplates()- Specified by:
isTraceTemplates
in interfaceorg.apache.camel.spi.BacklogTracer
-
setTraceTemplates
public void setTraceTemplates(boolean traceTemplates) - Specified by:
setTraceTemplates
in interfaceorg.apache.camel.spi.BacklogTracer
-
getTracePattern
- Specified by:
getTracePattern
in interfaceorg.apache.camel.spi.BacklogTracer
-
setTracePattern
- Specified by:
setTracePattern
in interfaceorg.apache.camel.spi.BacklogTracer
-
getTraceFilter
- Specified by:
getTraceFilter
in interfaceorg.apache.camel.spi.BacklogTracer
-
setTraceFilter
- Specified by:
setTraceFilter
in interfaceorg.apache.camel.spi.BacklogTracer
-
getTraceCounter
public long getTraceCounter()- Specified by:
getTraceCounter
in interfaceorg.apache.camel.spi.BacklogTracer
-
getQueueSize
public long getQueueSize()- Specified by:
getQueueSize
in interfaceorg.apache.camel.spi.BacklogTracer
-
resetTraceCounter
public void resetTraceCounter()- Specified by:
resetTraceCounter
in interfaceorg.apache.camel.spi.BacklogTracer
-
dumpTracedMessages
- Specified by:
dumpTracedMessages
in interfaceorg.apache.camel.spi.BacklogTracer
-
dumpTracedMessagesAsXml
- Specified by:
dumpTracedMessagesAsXml
in interfaceorg.apache.camel.spi.BacklogTracer
-
dumpTracedMessagesAsJSon
- Specified by:
dumpTracedMessagesAsJSon
in interfaceorg.apache.camel.spi.BacklogTracer
-
dumpAllTracedMessages
- Specified by:
dumpAllTracedMessages
in interfaceorg.apache.camel.spi.BacklogTracer
-
dumpAllTracedMessagesAsXml
- Specified by:
dumpAllTracedMessagesAsXml
in interfaceorg.apache.camel.spi.BacklogTracer
-
dumpAllTracedMessagesAsJSon
- Specified by:
dumpAllTracedMessagesAsJSon
in interfaceorg.apache.camel.spi.BacklogTracer
-
clear
public void clear()- Specified by:
clear
in interfaceorg.apache.camel.spi.BacklogTracer
-
incrementTraceCounter
public long incrementTraceCounter() -
doStop
- Overrides:
doStop
in classorg.apache.camel.support.service.BaseService
- Throws:
Exception
-