com.newrelic.agent.tracers

Class MethodExitTracerNoSkip

java.lang.Object

com.newrelic.agent.tracers.AbstractTracer

com.newrelic.agent.tracers.MethodExitTracerNoSkip

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:

MethodExitTracer

public abstract class MethodExitTracerNoSkip
extends AbstractTracer

A very lightweight tracer used to add code to the exit of a method invocation. It does not generate metrics and it doesn't participate in transaction trace (or even the Transaction tracer stack).

These methods getDuration(), getStartTime() and getEndTime() do not return accurate time information as this tracer is not meant to measure invocation times.

Field Summary

Fields

Modifier and Type	Field and Description
protected Tracer	parentTracer

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

ATTRIBUTE_TYPE

Constructor Summary

Constructors

Constructor and Description
MethodExitTracerNoSkip(ClassMethodSignature signature, Transaction transaction) Create from transaction.
MethodExitTracerNoSkip(ClassMethodSignature signature, TransactionActivity activity) Create from TransactionActivity.

Method Summary

Modifier and Type	Method and Description
void	childTracerFinished(Tracer child) Tells the tracer when a child tracer finished.
protected abstract void	doFinish(int opcode, java.lang.Object returnValue)
void	finish(int opcode, java.lang.Object returnValue)
void	finish(java.lang.Throwable throwable)
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.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).
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.
java.lang.String	getGuid() Gets the random identifier of this Tracer.
java.lang.String	getMetricName() The metric name of this tracer.
Tracer	getParentTracer() Returns the parent tracer or null if this is the root tracer.
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	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	isMetricProducer()
boolean	isParent() Does the tracer have any children?
boolean	isTransactionSegment() Returns true if this tracer should participate in transaction trace.
void	removeAgentAttribute(java.lang.String key) Remove attribute.
void	removeTransactionSegment()
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	setMetricName(java.lang.String... metricNameParts)
void	setMetricNameFormatInfo(java.lang.String metricName, java.lang.String transactionSegmentName, java.lang.String transactionSegmentUri)
void	setParentTracer(Tracer tracer)

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

addCustomAttribute, addCustomAttribute, addCustomAttribute, addCustomAttributes, addExclusiveRollupMetricName, addOutboundRequestHeaders, addRollupMetricName, excludeLeaf, getAgentAttributeNamesForSpans, getCustomAttribute, getCustomAttributes, getException, getExclusiveRollupMetricNames, getExternalParameters, getInvocationTarget, getParentTracedMethod, getParentTracerWithSpan, getRollupMetricNames, getStartTimeInMillis, getTransaction, getTransactionActivity, invoke, isAsync, isChildHasStackTrace, isLeaf, isTrackCallbackRunnable, markFinishTime, nameTransaction, readInboundResponseHeaders, reportAsExternal, reportAsExternal, 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

parentTracer

protected Tracer parentTracer

Constructor Detail

MethodExitTracerNoSkip

public MethodExitTracerNoSkip(ClassMethodSignature signature,
                              Transaction transaction)

Create from transaction. The transaction must not be null, because it will be dereferenced in the superclass constructor to grab the TransactionActivity

Parameters:

signature -

transaction -

MethodExitTracerNoSkip

public MethodExitTracerNoSkip(ClassMethodSignature signature,
                              TransactionActivity activity)

Create from TransactionActivity. For the benefit of legacy Play instrumentation, the activity may be null.

Parameters:

signature -

activity -

Method Detail

doFinish

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

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()

finish

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

finish

public void finish(java.lang.Throwable throwable)

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)

getClassMethodSignature

public final ClassMethodSignature getClassMethodSignature()

Specified by:

getClassMethodSignature in interface Tracer

Specified by:

getClassMethodSignature in class AbstractTracer

getDurationInMilliseconds

public final long getDurationInMilliseconds()

Description copied from interface: TimedItem

Get the duration of the method invocation in milliseconds.

getRunningDurationInNanos

public final 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.

getDuration

public final long getDuration()

Description copied from interface: TimedItem

Get the duration of the method invocation in nanoseconds.

getExclusiveDuration

public final 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.

getStartTime

public final long getStartTime()

Description copied from interface: Tracer

Get the start time of the method invocation in nanoseconds.

getStartTimeInMilliseconds

public final long getStartTimeInMilliseconds()

Description copied from interface: Tracer

Get the start time of the method invocation in milliseconds.

getEndTime

public final long getEndTime()

Description copied from interface: Tracer

Get the end time of the method invocation in nanoseconds.

getEndTimeInMilliseconds

public final long getEndTimeInMilliseconds()

Description copied from interface: Tracer

Get the end time of the method invocation in milliseconds.

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 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 java.lang.String getTransactionSegmentUri()

Description copied from interface: Tracer

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

getAgentAttributes

public final 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

Overrides:

getAgentAttributes in class AbstractTracer

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

Overrides:

getAgentAttribute in class AbstractTracer

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

Overrides:

setAgentAttribute in class AbstractTracer

isTransactionSegment

public final boolean isTransactionSegment()

Description copied from interface: Tracer

Returns true if this tracer should participate in transaction trace.

removeAgentAttribute

public void removeAgentAttribute(java.lang.String key)

Description copied from interface: Tracer

Remove attribute.

Specified by:

removeAgentAttribute in interface Tracer

Overrides:

removeAgentAttribute in class AbstractTracer

Parameters:

key - attribute to remove

isMetricProducer

public final boolean isMetricProducer()

isParent

public boolean isParent()

Description copied from interface: Tracer

Does the tracer have any children?

removeTransactionSegment

public void removeTransactionSegment()

getTransactionSegment

public final 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)

getGuid

public java.lang.String getGuid()

Description copied from interface: ErrorTracer

Gets the random identifier of this Tracer.