com.newrelic.agent.tracers

Class UltraLightTracer

java.lang.Object

com.newrelic.agent.tracers.UltraLightTracer

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

public class UltraLightTracer
extends java.lang.Object
implements Tracer

This tracer is the simplest tracer that money can buy. It currently only tracks duration of the method, and does not allow creation of children. It is akin to the bytecode generated by the FlyweightTraceMethodVisitor in the Weaver.

Also note: this tracer will never be included in transaction traces.

See Also:

FlyweightTraceMethodVisitor

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	childTracerFinished(Tracer child) Tells the tracer when a child tracer finished.
static UltraLightTracer	createClampedSegment(TransactionActivity txa, ClassMethodSignature classMethodSignature)
void	excludeLeaf()
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.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).
int	getChildCount()
ClassMethodSignature	getClassMethodSignature()
java.util.Map<java.lang.String,java.lang.Object>	getCustomAttributes() A map of attributes the customer has added to the tracer
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.
java.lang.Throwable	getException() Returns the exception, if any, that was noticed by the API or thrown by the tracer.
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.
java.lang.String	getMetricName() The metric name of this tracer.
com.newrelic.agent.bridge.TracedMethod	getParentTracedMethod()
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	getStartTimeInMillis()
long	getStartTimeInMilliseconds() Get the start time of the method invocation in milliseconds.
TransactionActivity	getTransactionActivity()
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.
java.lang.Object	invoke(java.lang.Object proxy, 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	isMetricProducer()
boolean	isParent() Does the tracer have any children?
boolean	isTrackCallbackRunnable()
boolean	isTransactionSegment() Returns true if this tracer should participate in transaction trace.
void	markFinishTime()
void	nameTransaction(com.newrelic.agent.bridge.TransactionNamePriority namePriority)
void	readInboundResponseHeaders(com.newrelic.api.agent.InboundHeaders inboundResponseHeaders)
void	removeAgentAttribute(java.lang.String key) Remove attribute.
void	removeTransactionSegment()
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	setCustomMetricPrefix(java.lang.String prefix)
void	setMetricName(java.lang.String... metricNameParts)
void	setMetricNameFormatInfo(java.lang.String metricName, java.lang.String transactionSegmentName, java.lang.String transactionSegmentUri)
void	setNoticedError(java.lang.Throwable throwable) Sets an error that was identified by the public API.
void	setParentTracer(Tracer tracer)
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

Method Detail

createClampedSegment

public static UltraLightTracer createClampedSegment(TransactionActivity txa,
                                                    ClassMethodSignature classMethodSignature)

finish

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

Specified by:

finish in interface com.newrelic.agent.bridge.ExitTracer

finish

public void finish(java.lang.Throwable throwable)

Specified by:

finish in interface com.newrelic.agent.bridge.ExitTracer

isMetricProducer

public boolean isMetricProducer()

getTransactionActivity

public TransactionActivity getTransactionActivity()

Specified by:

getTransactionActivity in interface Tracer

getParentTracer

public Tracer getParentTracer()

Description copied from interface: Tracer

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

Specified by:

getParentTracer in interface Tracer

getTransactionSegment

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

Specified by:

getTransactionSegment in interface Tracer

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.

Specified by:

getTransactionSegmentName 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

getClassMethodSignature

public ClassMethodSignature getClassMethodSignature()

Specified by:

getClassMethodSignature in interface Tracer

isTransactionSegment

public boolean isTransactionSegment()

Description copied from interface: Tracer

Returns true if this tracer should participate in transaction trace.

Specified by:

isTransactionSegment in interface Tracer

getStartTimeInMillis

public long getStartTimeInMillis()

Specified by:

getStartTimeInMillis in interface Tracer

getStartTimeInMilliseconds

public long getStartTimeInMilliseconds()

Description copied from interface: Tracer

Get the start time of the method invocation in milliseconds.

Specified by:

getStartTimeInMilliseconds in interface Tracer

getEndTimeInMilliseconds

public long getEndTimeInMilliseconds()

Description copied from interface: Tracer

Get the end time of the method invocation in milliseconds.

Specified by:

getEndTimeInMilliseconds in interface Tracer

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.

Specified by:

getExclusiveDuration in interface TimedItem

Specified by:

getExclusiveDuration in interface Tracer

getDuration

public long getDuration()

Description copied from interface: TimedItem

Get the duration of the method invocation in nanoseconds.

Specified by:

getDuration in interface TimedItem

getMetricName

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

Specified by:

getMetricName in interface Tracer

Specified by:

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

excludeLeaf

public void excludeLeaf()

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

getStartTime

public long getStartTime()

Description copied from interface: Tracer

Get the start time of the method invocation in nanoseconds.

Specified by:

getStartTime in interface Tracer

getEndTime

public long getEndTime()

Description copied from interface: Tracer

Get the end time of the method invocation in nanoseconds.

Specified by:

getEndTime in interface Tracer

getDurationInMilliseconds

public long getDurationInMilliseconds()

Description copied from interface: TimedItem

Get the duration of the method invocation in milliseconds.

Specified by:

getDurationInMilliseconds in interface TimedItem

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.

Specified by:

getRunningDurationInNanos in interface Tracer

getParentTracedMethod

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

setRollupMetricNames

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

setMetricNameFormatInfo

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

addExclusiveRollupMetricName

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

nameTransaction

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

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

getTransactionSegmentUri

public java.lang.String getTransactionSegmentUri()

Description copied from interface: Tracer

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

Specified by:

getTransactionSegmentUri in interface Tracer

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

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.

Specified by:

childTracerFinished in interface Tracer

getChildCount

public int getChildCount()

Specified by:

getChildCount in interface Tracer

setParentTracer

public void setParentTracer(Tracer tracer)

Specified by:

setParentTracer in interface Tracer

isParent

public boolean isParent()

Description copied from interface: Tracer

Does the tracer have any children?

Specified by:

isParent 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.

isLeaf

public boolean isLeaf()

Specified by:

isLeaf in interface Tracer

isAsync

public boolean isAsync()

Specified by:

isAsync in interface Tracer

removeTransactionSegment

public void removeTransactionSegment()

Specified by:

removeTransactionSegment in interface Tracer

markFinishTime

public void markFinishTime()

Specified by:

markFinishTime in interface Tracer

getGuid

public java.lang.String getGuid()

Description copied from interface: ErrorTracer

Gets the random identifier of this Tracer.

Specified by:

getGuid in interface ErrorTracer

Specified by:

getGuid in interface Tracer

getExternalParameters

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

Specified by:

getExternalParameters 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

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

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

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

setMetricName

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

Specified by:

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

addRollupMetricName

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

Specified by:

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

reportAsExternal

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

Specified by:

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

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.agent.bridge.external.ExternalParameters externalParameters)

invoke

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

Specified by:

invoke in interface java.lang.reflect.InvocationHandler