com.newrelic.agent.tracers

Class AbstractTracer

java.lang.Object

com.newrelic.agent.tracers.AbstractTracer

All Implemented Interfaces:

com.newrelic.agent.bridge.ExitTracer, ErrorTracer, TimedItem, Tracer, com.newrelic.api.agent.AttributeHolder, com.newrelic.api.agent.TracedMethod, java.lang.reflect.InvocationHandler

Direct Known Subclasses:

DefaultTracer, MethodExitTracerNoSkip

public abstract class AbstractTracer
extends java.lang.Object
implements Tracer, com.newrelic.api.agent.AttributeHolder

Base class for all tracers. This implements InvocationHandler.invoke(Object, Method, Object[])

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	ATTRIBUTE_TYPE

Constructor Summary

Constructors

Constructor and Description
AbstractTracer(Transaction transaction) Create a tracer on the current thread.
AbstractTracer(TransactionActivity txa, AttributeValidator attributeValidator) Create a tracer on the current thread.

Method Summary

Modifier and Type	Method and Description
void	addCustomAttribute(java.lang.String key, boolean value)
void	addCustomAttribute(java.lang.String key, java.lang.Number value)
void	addCustomAttribute(java.lang.String key, java.lang.String value)
void	addCustomAttributes(java.util.Map<java.lang.String,java.lang.Object> attributes)
void	addExclusiveRollupMetricName(java.lang.String... metricNameParts)
void	addOutboundRequestHeaders(com.newrelic.api.agent.OutboundHeaders outboundHeaders)
void	addRollupMetricName(java.lang.String... metricNameParts)
void	excludeLeaf()
java.lang.Object	getAgentAttribute(java.lang.String key) Returns the specific object for the input key in the map of attributes used to store extra information about the invocation (Like the sql statement for a sql tracer).
java.util.Set<java.lang.String>	getAgentAttributeNamesForSpans() Returns the set of agent attribute names that are marked to be added to span events.
java.util.Map<java.lang.String,java.lang.Object>	getAgentAttributes() A map of attributes used to store extra information about the invocation (Like the sql statement for a sql tracer).
abstract ClassMethodSignature	getClassMethodSignature()
java.lang.Object	getCustomAttribute(java.lang.String key)
java.util.Map<java.lang.String,java.lang.Object>	getCustomAttributes() A map of attributes the customer has added to the tracer
java.lang.Throwable	getException() Returns the exception, if any, that was noticed by the API or thrown by the tracer.
protected java.util.Set<java.lang.String>	getExclusiveRollupMetricNames()
com.newrelic.api.agent.ExternalParameters	getExternalParameters()
protected java.lang.Object	getInvocationTarget()
com.newrelic.agent.bridge.TracedMethod	getParentTracedMethod()
static Tracer	getParentTracerWithSpan(Tracer tracer)
protected java.util.Set<java.lang.String>	getRollupMetricNames()
long	getStartTimeInMillis()
Transaction	getTransaction() Get the transaction that currently owns the activity that owns this tracer.
TransactionActivity	getTransactionActivity() Get the transaction activity that owns this tracer.
java.lang.Object	invoke(java.lang.Object methodName, java.lang.reflect.Method method, java.lang.Object[] args)
boolean	isAsync()
boolean	isChildHasStackTrace() True means a child has taken a stack trace and therefore this tracer should not take one.
boolean	isLeaf()
boolean	isTrackCallbackRunnable()
void	markFinishTime()
void	nameTransaction(com.newrelic.agent.bridge.TransactionNamePriority priority)
void	readInboundResponseHeaders(com.newrelic.api.agent.InboundHeaders inboundResponseHeaders)
void	removeAgentAttribute(java.lang.String key) Remove attribute.
void	reportAsExternal(com.newrelic.api.agent.ExternalParameters externalParameters)
void	reportAsExternal(com.newrelic.agent.bridge.external.ExternalParameters externalParameters)
void	setAgentAttribute(java.lang.String key, java.lang.Object value) Add some extra information to the invocation (Like the sql statement for a sql tracer).
void	setAgentAttribute(java.lang.String key, java.lang.Object value, boolean addToSpan) Add some extra information to the invocation (Like the sql statement for a sql tracer).
void	setAttribute(java.lang.String key, java.lang.Object value, boolean checkLimits, boolean isCustom, boolean addAgentAttrToSpan)
void	setCustomMetricPrefix(java.lang.String prefix)
void	setNoticedError(java.lang.Throwable throwable) Sets an error that was identified by the public API.
void	setRollupMetricNames(java.lang.String... metricNames)
void	setThrownException(java.lang.Throwable throwable) Captures the exception that the was thrown during the tracer's execution.
void	setTrackCallbackRunnable(boolean shouldTrack)
void	setTrackChildThreads(boolean shouldTrack)
boolean	trackChildThreads()
boolean	wasExceptionSetByAPI() Returns true if the exception was set by ErrorTracer.setNoticedError(Throwable)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.newrelic.agent.tracers.Tracer

childTracerFinished, getChildCount, getEndTime, getEndTimeInMilliseconds, getExclusiveDuration, getGuid, getMetricName, getParentTracer, getRunningDurationInNanos, getStartTime, getStartTimeInMilliseconds, getTransactionSegment, getTransactionSegmentName, getTransactionSegmentUri, isParent, isTransactionSegment, removeTransactionSegment, setParentTracer

Methods inherited from interface com.newrelic.agent.tracers.TimedItem

getDuration, getDurationInMilliseconds

Methods inherited from interface com.newrelic.agent.bridge.ExitTracer

finish, finish

Methods inherited from interface com.newrelic.agent.bridge.TracedMethod

isMetricProducer, setMetricNameFormatInfo

Methods inherited from interface com.newrelic.api.agent.TracedMethod

setMetricName

Field Detail

ATTRIBUTE_TYPE

protected static final java.lang.String ATTRIBUTE_TYPE

See Also:

Constant Field Values

Constructor Detail

AbstractTracer

public AbstractTracer(Transaction transaction)

Create a tracer on the current thread.

Parameters:

transaction - the transaction that owns the activity on the current thread. Must not be null.

AbstractTracer

public AbstractTracer(TransactionActivity txa,
                      AttributeValidator attributeValidator)

Create a tracer on the current thread.

Parameters:

txa - the activity for the current thread. The value is allowed to be null.

Method Detail

getTransaction

public final Transaction getTransaction()

Get the transaction that currently owns the activity that owns this tracer.

Returns:

the transaction that currently owns the activity that owns this tracer.

getTransactionActivity

public final TransactionActivity getTransactionActivity()

Get the transaction activity that owns this tracer.

Specified by:

getTransactionActivity in interface Tracer

Returns:

the transaction activity that owns this tracer. This value does not change during the life of the tracer.

getInvocationTarget

protected java.lang.Object getInvocationTarget()

invoke

public final java.lang.Object invoke(java.lang.Object methodName,
                                     java.lang.reflect.Method method,
                                     java.lang.Object[] args)

Specified by:

invoke in interface java.lang.reflect.InvocationHandler

getClassMethodSignature

public abstract ClassMethodSignature getClassMethodSignature()

Specified by:

getClassMethodSignature in interface Tracer

isChildHasStackTrace

public boolean isChildHasStackTrace()

Description copied from interface: Tracer

True means a child has taken a stack trace and therefore this tracer should not take one.

Specified by:

isChildHasStackTrace in interface Tracer

Returns:

True if a child has taken a stack trace for the transaction segment, else false.

nameTransaction

public void nameTransaction(com.newrelic.agent.bridge.TransactionNamePriority priority)

getParentTracedMethod

public com.newrelic.agent.bridge.TracedMethod getParentTracedMethod()

isLeaf

public boolean isLeaf()

Specified by:

isLeaf in interface Tracer

excludeLeaf

public void excludeLeaf()

isAsync

public boolean isAsync()

Specified by:

isAsync in interface Tracer

getRollupMetricNames

protected java.util.Set<java.lang.String> getRollupMetricNames()

getExclusiveRollupMetricNames

protected java.util.Set<java.lang.String> getExclusiveRollupMetricNames()

addRollupMetricName

public void addRollupMetricName(java.lang.String... metricNameParts)

Specified by:

addRollupMetricName in interface com.newrelic.api.agent.TracedMethod

setRollupMetricNames

public void setRollupMetricNames(java.lang.String... metricNames)

addExclusiveRollupMetricName

public void addExclusiveRollupMetricName(java.lang.String... metricNameParts)

setCustomMetricPrefix

public void setCustomMetricPrefix(java.lang.String prefix)

setTrackChildThreads

public void setTrackChildThreads(boolean shouldTrack)

trackChildThreads

public boolean trackChildThreads()

setTrackCallbackRunnable

public void setTrackCallbackRunnable(boolean shouldTrack)

isTrackCallbackRunnable

public boolean isTrackCallbackRunnable()

addOutboundRequestHeaders

public void addOutboundRequestHeaders(com.newrelic.api.agent.OutboundHeaders outboundHeaders)

Specified by:

addOutboundRequestHeaders in interface com.newrelic.api.agent.TracedMethod

readInboundResponseHeaders

public void readInboundResponseHeaders(com.newrelic.api.agent.InboundHeaders inboundResponseHeaders)

reportAsExternal

public void reportAsExternal(com.newrelic.api.agent.ExternalParameters externalParameters)

Specified by:

reportAsExternal in interface com.newrelic.api.agent.TracedMethod

reportAsExternal

public void reportAsExternal(com.newrelic.agent.bridge.external.ExternalParameters externalParameters)

markFinishTime

public void markFinishTime()

Specified by:

markFinishTime in interface Tracer

getStartTimeInMillis

public long getStartTimeInMillis()

Specified by:

getStartTimeInMillis in interface Tracer

getExternalParameters

public com.newrelic.api.agent.ExternalParameters getExternalParameters()

Specified by:

getExternalParameters in interface Tracer

setNoticedError

public void setNoticedError(java.lang.Throwable throwable)

Description copied from interface: ErrorTracer

Sets an error that was identified by the public API.

Specified by:

setNoticedError in interface ErrorTracer

setThrownException

public void setThrownException(java.lang.Throwable throwable)

Description copied from interface: ErrorTracer

Captures the exception that the was thrown during the tracer's execution.

Specified by:

setThrownException in interface ErrorTracer

wasExceptionSetByAPI

public boolean wasExceptionSetByAPI()

Description copied from interface: ErrorTracer

Returns true if the exception was set by ErrorTracer.setNoticedError(Throwable)

Specified by:

wasExceptionSetByAPI in interface ErrorTracer

getException

public java.lang.Throwable getException()

Description copied from interface: ErrorTracer

Returns the exception, if any, that was noticed by the API or thrown by the tracer.

Specified by:

getException in interface ErrorTracer

addCustomAttribute

public void addCustomAttribute(java.lang.String key,
                               java.lang.Number value)

Specified by:

addCustomAttribute in interface com.newrelic.api.agent.AttributeHolder

addCustomAttribute

public void addCustomAttribute(java.lang.String key,
                               java.lang.String value)

Specified by:

addCustomAttribute in interface com.newrelic.api.agent.AttributeHolder

addCustomAttribute

public void addCustomAttribute(java.lang.String key,
                               boolean value)

Specified by:

addCustomAttribute in interface com.newrelic.api.agent.AttributeHolder

addCustomAttributes

public void addCustomAttributes(java.util.Map<java.lang.String,java.lang.Object> attributes)

Specified by:

addCustomAttributes in interface com.newrelic.api.agent.AttributeHolder

setAttribute

public void setAttribute(java.lang.String key,
                         java.lang.Object value,
                         boolean checkLimits,
                         boolean isCustom,
                         boolean addAgentAttrToSpan)

setAgentAttribute

public void setAgentAttribute(java.lang.String key,
                              java.lang.Object value)

Description copied from interface: Tracer

Add some extra information to the invocation (Like the sql statement for a sql tracer).

Specified by:

setAgentAttribute in interface Tracer

setAgentAttribute

public void setAgentAttribute(java.lang.String key,
                              java.lang.Object value,
                              boolean addToSpan)

Description copied from interface: Tracer

Add some extra information to the invocation (Like the sql statement for a sql tracer).

Specified by:

setAgentAttribute in interface Tracer

removeAgentAttribute

public void removeAgentAttribute(java.lang.String key)

Description copied from interface: Tracer

Remove attribute.

Specified by:

removeAgentAttribute in interface Tracer

Parameters:

key - attribute to remove

getAgentAttribute

public java.lang.Object getAgentAttribute(java.lang.String key)

Description copied from interface: Tracer

Returns the specific object for the input key in the map of attributes used to store extra information about the invocation (Like the sql statement for a sql tracer). If the key is not present, then null will be returned.

Specified by:

getAgentAttribute in interface Tracer

getAgentAttributes

public java.util.Map<java.lang.String,java.lang.Object> getAgentAttributes()

Description copied from interface: Tracer

A map of attributes used to store extra information about the invocation (Like the sql statement for a sql tracer). An empty collection will be returned if there are no parameters. Do not use this to add parameters.

Specified by:

getAgentAttributes in interface Tracer

getCustomAttributes

public java.util.Map<java.lang.String,java.lang.Object> getCustomAttributes()

Description copied from interface: Tracer

A map of attributes the customer has added to the tracer

Specified by:

getCustomAttributes in interface Tracer

getAgentAttributeNamesForSpans

public java.util.Set<java.lang.String> getAgentAttributeNamesForSpans()

Description copied from interface: Tracer

Returns the set of agent attribute names that are marked to be added to span events.

Note: Some attributes will be added to spans even if they are not in the returned set.

Specified by:

getAgentAttributeNamesForSpans in interface Tracer

getCustomAttribute

public java.lang.Object getCustomAttribute(java.lang.String key)

getParentTracerWithSpan

public static Tracer getParentTracerWithSpan(Tracer tracer)