io.opentracing.contrib.agent.helper

Class DDAgentTracingHelper<ObjectType>

java.lang.Object

org.jboss.byteman.rule.helper.Helper

io.opentracing.contrib.agent.OpenTracingHelper

io.opentracing.contrib.agent.helper.DDAgentTracingHelper<ObjectType>

Type Parameters:

ObjectType - The type of the object to patch

Direct Known Subclasses:

ApacheHTTPClientHelper, AWSClientHelper, CassandraHelper, ElasticsearchHelper, JettyServletHelper, MongoHelper, OkHttpHelper, TomcatServletHelper

public abstract class DDAgentTracingHelper<ObjectType>
extends OpenTracingHelper

This class provides helpfull stuff in order to easy patch object using Byteman rules

Nested Class Summary

Nested classes/interfaces inherited from class io.opentracing.contrib.agent.OpenTracingHelper

OpenTracingHelper.AgentSpanBuilder, OpenTracingHelper.AgentTracer

Field Summary

Fields

Modifier and Type	Field and Description
protected io.opentracing.Tracer	tracer The current instance of the tracer.

Fields inherited from class org.jboss.byteman.rule.helper.Helper

rule

Method Summary

Modifier and Type	Method and Description
protected abstract ObjectType	doPatch(ObjectType obj) The current implementation of the patch
protected void	info(String message) Simple wrapper to emit an info
protected void	logStackTrace(String message, Throwable th) Simple wrapper to emit the corresponding stacktrace.
ObjectType	patch(ObjectType args) This method takes an object and applies some mutation in order to add tracing capabilities.
protected void	warning(String message) Simple wrapper to emit a warning

Methods inherited from class io.opentracing.contrib.agent.OpenTracingHelper

associateSpan, finishedSpan, getState, getTracer, ignore, initTracer, isFinished, retrieveSpan, setState

Methods inherited from class org.jboss.byteman.rule.helper.Helper

activated, addCountDown, callerCheck, callerEquals, callerEquals, callerEquals, callerEquals, callerEquals, callerEquals, callerEquals, callerEquals, callerEquals, callerMatches, callerMatches, callerMatches, callerMatches, callerMatches, callerMatches, callerMatches, callerMatches, callerMatches, clear, closeTrace, countDown, createCountDown, createCounter, createCounter, createJoin, createLinkMap, createRendezvous, createRendezvous, createTimer, deactivated, debug, decrementCounter, delay, deleteCounter, deleteLinkMap, deleteRendezvous, deleteTimer, err, errTraceException, flag, flagged, formatAllStacks, formatAllStacks, formatAllStacks, formatAllStacks, formatStack, formatStack, formatStack, formatStack, formatStackBetween, formatStackBetween, formatStackBetween, formatStackBetween, formatStackBetween, formatStackBetween, formatStackBetweenMatches, formatStackBetweenMatches, formatStackBetweenMatches, formatStackBetweenMatches, formatStackBetweenMatches, formatStackBetweenMatches, formatStackMatching, formatStackMatching, formatStackMatching, formatStackMatching, formatStackMatching, formatStackMatching, formatStackRange, formatThreadStack, formatThreadStack, formatThreadStack, formatThreadStack, getCountDown, getElapsedTimeFromTimer, getObjectSize, getRendezvous, getStack, incrementCounter, incrementCounter, installed, isCountDown, isJoin, isRendezvous, joinEnlist, joinWait, joinWait, killJVM, killJVM, killThread, link, link, linked, linked, matchIndex, noisy, noisyTraceException, openTrace, openTrace, out, outTraceException, printFrame, printlnFrame, readCounter, readCounter, rendezvous, rendezvous, resetTimer, setTriggering, signalKill, signalKill, signalThrow, signalThrow, signalWake, signalWake, toString, trace, trace, traceAllStacks, traceAllStacks, traceAllStacks, traceAllStacks, traceAllStacks, traceAllStacks, traceClose, traceln, traceln, traceOpen, traceOpen, traceStack, traceStack, traceStack, traceStack, traceStack, traceStack, traceStackBetween, traceStackBetween, traceStackBetween, traceStackBetween, traceStackBetween, traceStackBetween, traceStackBetween, traceStackBetween, traceStackBetween, traceStackBetweenMatches, traceStackBetweenMatches, traceStackBetweenMatches, traceStackBetweenMatches, traceStackBetweenMatches, traceStackBetweenMatches, traceStackBetweenMatches, traceStackBetweenMatches, traceStackBetweenMatches, traceStackMatching, traceStackMatching, traceStackMatching, traceStackMatching, traceStackMatching, traceStackMatching, traceStackMatching, traceStackMatching, traceStackMatching, traceStackRange, traceThreadStack, traceThreadStack, traceThreadStack, traceThreadStack, traceThreadStack, traceThreadStack, triggerIndex, uninstalled, unlink, unlink, verbose, verboseTraceException, waitFor, waitFor, waiting

Methods inherited from class java.lang.Object

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

Field Detail

tracer

protected final io.opentracing.Tracer tracer

The current instance of the tracer. If something goes wrong during the resolution, we provides a NoopTracer.

Method Detail

patch

public ObjectType patch(ObjectType args)

This method takes an object and applies some mutation in order to add tracing capabilities. This method should never return any Exception in order to not stop the app traced.

This method should be defined as final, but something Byteman need to define this one with the explicit type (i.e. without using generic), so this is why we don't use final here.

Parameters:

args - The object to patch, the type is defined by the subclass instantiation

Returns:

The object patched

doPatch

protected abstract ObjectType doPatch(ObjectType obj)
                               throws Exception

The current implementation of the patch

Parameters:

obj - the object to patch

Returns:

the object patched

Throws:

Exception - The exceptions are managed directly to the patch method

warning

protected void warning(String message)

Simple wrapper to emit a warning

Parameters:

message - the message to log as a warning

info

protected void info(String message)

Simple wrapper to emit an info

Parameters:

message - the message to log as an info

logStackTrace

protected void logStackTrace(String message,
                             Throwable th)

Simple wrapper to emit the corresponding stacktrace. To not warn the user, we log the stack as a debug info. By default, the stack traces are noit shown in the log.

Parameters:

message - the stacktrace to log as a debug