com.newrelic.agent.tracers

Class DefaultTracer

java.lang.Object

com.newrelic.agent.tracers.AbstractTracer

com.newrelic.agent.tracers.DefaultTracer

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:

AbstractExternalComponentTracer, BasicRequestRootTracer, DefaultSqlTracer, OtherRootTracer

public class DefaultTracer
extends AbstractTracer

The default tracer implementation.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BACKTRACE_PARAMETER_NAME
static int	DEFAULT_TRACER_FLAGS By default tracers generate scoped metrics and generate transaction tracer segments.
static MetricNameFormat	NULL_METRIC_NAME_FORMATTER Convenience formatter

Fields inherited from class com.newrelic.agent.tracers.AbstractTracer

ATTRIBUTE_TYPE

Constructor Summary

Constructors

Constructor and Description
DefaultTracer(TransactionActivity txa, ClassMethodSignature sig, java.lang.Object object, MetricNameFormat metricNameFormatter, int tracerFlags)
DefaultTracer(TransactionActivity txa, ClassMethodSignature sig, java.lang.Object object, MetricNameFormat metricNameFormatter, int tracerFlags, long pStartTime) Primary constructor for tracers created from weaved code or XML instrumentation.
DefaultTracer(TransactionActivity txa, ClassMethodSignature sig, java.lang.Object object, MetricNameFormat metricNameFormatter, long pStartTime)
DefaultTracer(Transaction transaction, ClassMethodSignature sig, java.lang.Object object)
DefaultTracer(Transaction transaction, ClassMethodSignature sig, java.lang.Object object, MetricNameFormat metricNameFormatter)
DefaultTracer(Transaction transaction, ClassMethodSignature sig, java.lang.Object object, MetricNameFormat metricNameFormatter, int tracerFlags) Compatibility constructor for old code.

Method Summary

Modifier and Type	Method and Description
void	addOutboundRequestHeaders(com.newrelic.api.agent.OutboundHeaders outboundHeaders)
void	childTracerFinished(long childDurationInNanos)
void	childTracerFinished(Tracer child) Tells the tracer when a child tracer finished.
protected void	doFinish(int opcode, java.lang.Object returnValue) Subclasses may override.
protected void	doFinish(java.lang.Throwable throwable) Subclasses may override.
protected void	doRecordMetrics(TransactionStats transactionStats) Generate additional metrics.
void	finish(int opcode, java.lang.Object returnValue)
void	finish(java.lang.Throwable throwable)
int	getChildCount()
ClassMethodSignature	getClassMethodSignature()
long	getDuration() Get the duration of the method invocation in nanoseconds.
long	getDurationInMilliseconds() Get the duration of the method invocation in milliseconds.
long	getEndTime() Get the end time of the method invocation in nanoseconds.
long	getEndTimeInMilliseconds() Get the end time of the method invocation in milliseconds.
long	getExclusiveDuration() Get the duration in nanoseconds of the tracer minus the duration of all child tracers.
com.newrelic.api.agent.ExternalParameters	getExternalParameters()
java.lang.String	getGuid() Gets the random identifier of this Tracer.
protected java.lang.Object	getInvocationTarget()
java.lang.String	getMetricName() The metric name of this tracer.
protected MetricNameFormat	getMetricNameFormat()
Tracer	getParentTracer() Returns the parent tracer or null if this is the root tracer.
java.lang.String	getRequestMetricName()
long	getRunningDurationInNanos() Returns the elapsed time since the start time of the transaction up until now if the tracer is still running, or the final duration if the tracer has finished.
long	getStartTime() Get the start time of the method invocation in nanoseconds.
long	getStartTimeInMillis()
long	getStartTimeInMilliseconds() Get the start time of the method invocation in milliseconds.
TransactionSegment	getTransactionSegment(TransactionTracerConfig ttConfig, SqlObfuscator sqlObfuscator, long startTime, TransactionSegment lastSibling)
java.lang.String	getTransactionSegmentName() The name of this tracer in a transaction trace segment.
java.lang.String	getTransactionSegmentUri() The uri of this tracer in a tranaction trace segment.
boolean	isAsync()
boolean	isChildHasStackTrace() Gets the field childHasStackTrace.
boolean	isLeaf()
boolean	isMetricProducer()
boolean	isParent() Does the tracer have any children?
boolean	isTransactionSegment() Returns true if this tracer should participate in transaction trace.
void	performFinishWork(long finishTime, int opcode, java.lang.Object returnValue)
void	readInboundResponseHeaders(com.newrelic.api.agent.InboundHeaders inboundResponseHeaders)
protected void	recordMetrics(TransactionStats transactionStats) Record response time metrics.
void	removeTransactionSegment()
void	reportAsExternal(com.newrelic.agent.bridge.external.ExternalParameters externalParameters)
void	reportAsExternal(com.newrelic.api.agent.ExternalParameters externalParameters)
protected void	reset()
void	setMetricName(java.lang.String... metricNameParts)
void	setMetricNameFormat(MetricNameFormat nameFormat)
void	setMetricNameFormatInfo(java.lang.String metricName, java.lang.String transactionSegmentName, java.lang.String transactionSegmentUri)
void	setParentTracer(Tracer tracer)
protected boolean	shouldStoreStackTrace()
void	storeStackTrace() Stores the stack trace.

Methods inherited from class com.newrelic.agent.tracers.AbstractTracer

addCustomAttribute, addCustomAttribute, addCustomAttribute, addCustomAttributes, addExclusiveRollupMetricName, addRollupMetricName, getAgentAttribute, getAgentAttributes, getCustomAttribute, getCustomAttributes, getException, getExclusiveRollupMetricNames, getParentTracedMethod, getParentTracerWithSpan, getRollupMetricNames, getTransaction, getTransactionActivity, invoke, isTrackCallbackRunnable, markFinishTime, nameTransaction, removeAgentAttribute, setAgentAttribute, setAttribute, setCustomMetricPrefix, setNoticedError, setRollupMetricNames, setThrownException, setTrackCallbackRunnable, setTrackChildThreads, trackChildThreads, wasExceptionSetByAPI

Methods inherited from class java.lang.Object

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

Field Detail

NULL_METRIC_NAME_FORMATTER

public static final MetricNameFormat NULL_METRIC_NAME_FORMATTER

Convenience formatter

BACKTRACE_PARAMETER_NAME

public static final java.lang.String BACKTRACE_PARAMETER_NAME

See Also:

Constant Field Values

DEFAULT_TRACER_FLAGS

public static final int DEFAULT_TRACER_FLAGS

By default tracers generate scoped metrics and generate transaction tracer segments.

See Also:

Constant Field Values

Constructor Detail

DefaultTracer

public DefaultTracer(Transaction transaction,
                     ClassMethodSignature sig,
                     java.lang.Object object,
                     MetricNameFormat metricNameFormatter,
                     int tracerFlags)

Compatibility constructor for old code. Tracers are always bound to the thread they're created on, while transactions are multithreaded. So in theory, we should completely ignore the transaction argument and grab the activity from the current thread. Unfortunately, there are unit tests that pass mocks here, and it's preferable that these tests not have to set up thread local storage in order to exercise the tracer code. So we actually call getTransactionActivity() on the transaction, because the test code can mock this to return to the mock TransactionActivity. (In a real setting, the call transaction.getTransactionActivity() also digs the Activity out of the thread local; the mapping from transactions to activities is one-to-many, so there's no other way to do it.)

Parameters:

transaction - transaction, must not be null.

sig -

object -

metricNameFormatter -

tracerFlags -

DefaultTracer

public DefaultTracer(TransactionActivity txa,
                     ClassMethodSignature sig,
                     java.lang.Object object,
                     MetricNameFormat metricNameFormatter,
                     int tracerFlags)

DefaultTracer

public DefaultTracer(TransactionActivity txa,
                     ClassMethodSignature sig,
                     java.lang.Object object,
                     MetricNameFormat metricNameFormatter,
                     int tracerFlags,
                     long pStartTime)

Primary constructor for tracers created from weaved code or XML instrumentation.

Parameters:

txa - activity, must not be null.

sig -

object -

metricNameFormatter -

tracerFlags -

DefaultTracer

public DefaultTracer(TransactionActivity txa,
                     ClassMethodSignature sig,
                     java.lang.Object object,
                     MetricNameFormat metricNameFormatter,
                     long pStartTime)

DefaultTracer

public DefaultTracer(Transaction transaction,
                     ClassMethodSignature sig,
                     java.lang.Object object,
                     MetricNameFormat metricNameFormatter)

DefaultTracer

public DefaultTracer(Transaction transaction,
                     ClassMethodSignature sig,
                     java.lang.Object object)

Method Detail

removeTransactionSegment

public void removeTransactionSegment()

getGuid

public java.lang.String getGuid()

Description copied from interface: ErrorTracer

Gets the random identifier of this Tracer.

finish

public void finish(java.lang.Throwable throwable)

reset

protected void reset()

finish

public void finish(int opcode,
                   java.lang.Object returnValue)

performFinishWork

public void performFinishWork(long finishTime,
                              int opcode,
                              java.lang.Object returnValue)

getStartTimeInMillis

public long getStartTimeInMillis()

Specified by:

getStartTimeInMillis in interface Tracer

Overrides:

getStartTimeInMillis in class AbstractTracer

getExternalParameters

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

Specified by:

getExternalParameters in interface Tracer

Overrides:

getExternalParameters in class AbstractTracer

doFinish

protected void doFinish(java.lang.Throwable throwable)

Subclasses may override.

doFinish

protected void doFinish(int opcode,
                        java.lang.Object returnValue)

Subclasses may override.

shouldStoreStackTrace

protected boolean shouldStoreStackTrace()

storeStackTrace

public void storeStackTrace()

Stores the stack trace. This is public for testing, but really should be private and so please do not call it unless you are in a test.

getRunningDurationInNanos

public long getRunningDurationInNanos()

Description copied from interface: Tracer

Returns the elapsed time since the start time of the transaction up until now if the tracer is still running, or the final duration if the tracer has finished.

getDurationInMilliseconds

public long getDurationInMilliseconds()

Description copied from interface: TimedItem

Get the duration of the method invocation in milliseconds.

getDuration

public long getDuration()

Description copied from interface: TimedItem

Get the duration of the method invocation in nanoseconds.

getExclusiveDuration

public long getExclusiveDuration()

Description copied from interface: Tracer

Get the duration in nanoseconds of the tracer minus the duration of all child tracers. This measures the amount of time spent in the method itself or in untraced method calls.

getEndTime

public long getEndTime()

Description copied from interface: Tracer

Get the end time of the method invocation in nanoseconds.

getEndTimeInMilliseconds

public long getEndTimeInMilliseconds()

Description copied from interface: Tracer

Get the end time of the method invocation in milliseconds.

getStartTime

public long getStartTime()

Description copied from interface: Tracer

Get the start time of the method invocation in nanoseconds.

getStartTimeInMilliseconds

public long getStartTimeInMilliseconds()

Description copied from interface: Tracer

Get the start time of the method invocation in milliseconds.

getInvocationTarget

protected final java.lang.Object getInvocationTarget()

Overrides:

getInvocationTarget in class AbstractTracer

getParentTracer

public Tracer getParentTracer()

Description copied from interface: Tracer

Returns the parent tracer or null if this is the root tracer.

setParentTracer

public void setParentTracer(Tracer tracer)

getRequestMetricName

public java.lang.String getRequestMetricName()

setMetricNameFormat

public void setMetricNameFormat(MetricNameFormat nameFormat)

getMetricNameFormat

protected final MetricNameFormat getMetricNameFormat()

getMetricName

public final java.lang.String getMetricName()

Description copied from interface: Tracer

The metric name of this tracer. Null is an acceptable value if this tracer does not generate a metric.

getTransactionSegmentName

public final java.lang.String getTransactionSegmentName()

Description copied from interface: Tracer

The name of this tracer in a transaction trace segment. Defaults to the metric name.

getTransactionSegmentUri

public final java.lang.String getTransactionSegmentUri()

Description copied from interface: Tracer

The uri of this tracer in a tranaction trace segment. Defaults to null.

recordMetrics

protected void recordMetrics(TransactionStats transactionStats)

Record response time metrics.

doRecordMetrics

protected void doRecordMetrics(TransactionStats transactionStats)

Generate additional metrics. Subclasses may override.

isParent

public final boolean isParent()

Description copied from interface: Tracer

Does the tracer have any children?

childTracerFinished

public void childTracerFinished(Tracer child)

Description copied from interface: Tracer

Tells the tracer when a child tracer finished. Useful in computing the exclusive time for the tracer.

getChildCount

public int getChildCount()

childTracerFinished

public void childTracerFinished(long childDurationInNanos)

getClassMethodSignature

public ClassMethodSignature getClassMethodSignature()

Specified by:

getClassMethodSignature in interface Tracer

Specified by:

getClassMethodSignature in class AbstractTracer

isTransactionSegment

public final boolean isTransactionSegment()

Description copied from interface: Tracer

Returns true if this tracer should participate in transaction trace.

isMetricProducer

public boolean isMetricProducer()

isLeaf

public final boolean isLeaf()

Specified by:

isLeaf in interface Tracer

Overrides:

isLeaf in class AbstractTracer

isAsync

public final boolean isAsync()

Specified by:

isAsync in interface Tracer

Overrides:

isAsync in class AbstractTracer

isChildHasStackTrace

public boolean isChildHasStackTrace()

Gets the field childHasStackTrace.

Specified by:

isChildHasStackTrace in interface Tracer

Overrides:

isChildHasStackTrace in class AbstractTracer

Returns:

the childHasStackTrace

getTransactionSegment

public TransactionSegment getTransactionSegment(TransactionTracerConfig ttConfig,
                                                SqlObfuscator sqlObfuscator,
                                                long startTime,
                                                TransactionSegment lastSibling)

setMetricName

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

setMetricNameFormatInfo

public void setMetricNameFormatInfo(java.lang.String metricName,
                                    java.lang.String transactionSegmentName,
                                    java.lang.String transactionSegmentUri)

addOutboundRequestHeaders

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

Specified by:

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

Overrides:

addOutboundRequestHeaders in class AbstractTracer

readInboundResponseHeaders

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

Overrides:

readInboundResponseHeaders in class AbstractTracer

reportAsExternal

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

Overrides:

reportAsExternal in class AbstractTracer

reportAsExternal

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

Specified by:

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

Overrides:

reportAsExternal in class AbstractTracer