com.datadoghq.trace.agent

Class OpenTracingHelper

java.lang.Object

org.jboss.byteman.rule.helper.Helper

com.datadoghq.trace.agent.OpenTracingHelper

public class OpenTracingHelper
extends org.jboss.byteman.rule.helper.Helper

This class provides helper capabilities to the byteman rules.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OpenTracingHelper.AgentSpanBuilder
static class	OpenTracingHelper.AgentTracer Proxy tracer used for one purpose - to enable the rules to define a ChildOf relationship without being concerned whether the supplied Span is null.

Constructor Summary

Constructors

Constructor and Description
OpenTracingHelper(org.jboss.byteman.rule.Rule rule)

Method Summary

Modifier and Type	Method and Description
void	associateSpan(Object obj, io.opentracing.Span span) This method establishes an association between an application object (i.e.
void	finishedSpan(Object key, io.opentracing.Span span) Needs to be replaced by span.isFinished()
int	getState(Object obj) This method retrieves the current 'state' number associated with the supplied application object.
io.opentracing.Tracer	getTracer() This method returns the OpenTracing tracer.
boolean	ignore(Object obj) This method determines whether the instrumentation point, associated with the supplied object, should be ignored.
boolean	isFinished(Object key)
io.opentracing.Span	retrieveSpan(Object obj) This method retrieves the span associated with the supplied application object.
void	setState(Object obj, int value) This method enables an instrumentation rule to record a 'state' number against an application object.

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, incrementCounter, incrementCounter, installed, isCountDown, isJoin, isRendezvous, joinEnlist, joinWait, joinWait, killJVM, killJVM, killThread, link, link, linked, linked, noisy, noisyTraceException, openTrace, openTrace, out, outTraceException, 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, uninstalled, unlink, unlink, verbose, verboseTraceException, waitFor, waitFor, waiting

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

OpenTracingHelper

public OpenTracingHelper(org.jboss.byteman.rule.Rule rule)

Method Detail

getTracer

public io.opentracing.Tracer getTracer()

This method returns the OpenTracing tracer.

Returns:

The tracer

associateSpan

public void associateSpan(Object obj,
                          io.opentracing.Span span)

This method establishes an association between an application object (i.e. the subject of the instrumentation) and a span. Once the application object is no longer being used, the association with the span will automatically be discarded.

Parameters:

obj - The application object to be associated with the span

span - The span

retrieveSpan

public io.opentracing.Span retrieveSpan(Object obj)

This method retrieves the span associated with the supplied application object.

Parameters:

obj - The application object

Returns:

The span, or null if no associated span exists

finishedSpan

public void finishedSpan(Object key,
                         io.opentracing.Span span)

Needs to be replaced by span.isFinished()

isFinished

public boolean isFinished(Object key)

setState

public void setState(Object obj,
                     int value)

This method enables an instrumentation rule to record a 'state' number against an application object. This can be used in situations where rules are only applicable in certain states. For example, the simple case for rules responsible for installing filters would be states representing NOT_INSTALLED and INSTALLED. This means that the filter would only be installed if the application object (target of the instrumentation rule) was in the NOT_INSTALLED state. However other more complex scenarios may be encountered where more than two states are required.

Parameters:

obj - The application object

value - The state value

getState

public int getState(Object obj)

This method retrieves the current 'state' number associated with the supplied application object.

Parameters:

obj - The application object

Returns:

The state, or 0 if no state currently exists

ignore

public boolean ignore(Object obj)

This method determines whether the instrumentation point, associated with the supplied object, should be ignored.

Parameters:

obj - The instrumentation target

Returns:

Whether the instrumentation point should be ignored