com.newrelic.agent.tracers

Interface Tracer

All Superinterfaces:

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

All Known Subinterfaces:

IOTracer, SkipTracer, SqlTracer

All Known Implementing Classes:

AbstractExternalComponentTracer, AbstractTracer, BasicRequestRootTracer, DefaultSqlTracer, DefaultTracer, ExternalComponentTracer, MethodExitTracer, MethodExitTracerNoSkip, NoOpTracer, OtherRootSqlTracer, OtherRootTracer, UltraLightTracer

public interface Tracer
extends TimedItem, com.newrelic.agent.bridge.ExitTracer, ErrorTracer

A tracer records information about a method invocation - primarily the start and stop time of the invocation. A tracer instance is associated with a single method invocation. Tracers are created by TracerFactory instances.

Method Summary

Modifier and Type	Method and Description
void	childTracerFinished(Tracer child) Tells the tracer when a child tracer finished.
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	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.
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	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.
boolean	isAsync()
boolean	isChildHasStackTrace() True means a child has taken a stack trace and therefore this tracer should not take one.
boolean	isLeaf()
boolean	isParent() Does the tracer have any children?
boolean	isTransactionSegment() Returns true if this tracer should participate in transaction trace.
void	markFinishTime()
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	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	setParentTracer(Tracer tracer)

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 java.lang.reflect.InvocationHandler

invoke

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

addExclusiveRollupMetricName, addOutboundRequestHeaders, excludeLeaf, getParentTracedMethod, isMetricProducer, isTrackCallbackRunnable, nameTransaction, readInboundResponseHeaders, reportAsExternal, setCustomMetricPrefix, setMetricNameFormatInfo, setRollupMetricNames, setTrackCallbackRunnable, setTrackChildThreads, trackChildThreads

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

addRollupMetricName, reportAsExternal, setMetricName

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

addCustomAttribute, addCustomAttribute, addCustomAttribute, addCustomAttributes

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

getException, setNoticedError, setThrownException, wasExceptionSetByAPI

Method Detail

getTransactionActivity

TransactionActivity getTransactionActivity()

getStartTime

long getStartTime()

Get the start time of the method invocation in nanoseconds.

getStartTimeInMilliseconds

long getStartTimeInMilliseconds()

Get the start time of the method invocation in milliseconds.

getEndTime

long getEndTime()

Get the end time of the method invocation in nanoseconds.

getEndTimeInMilliseconds

long getEndTimeInMilliseconds()

Get the end time of the method invocation in milliseconds.

getExclusiveDuration

long getExclusiveDuration()

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

getRunningDurationInNanos

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.

getMetricName

java.lang.String getMetricName()

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

Specified by:

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

getTransactionSegmentName

java.lang.String getTransactionSegmentName()

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

getTransactionSegmentUri

java.lang.String getTransactionSegmentUri()

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

getCustomAttributes

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

A map of attributes the customer has added to the tracer

getAgentAttributes

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). An empty collection will be returned if there are no parameters. Do not use this to add parameters.

setAgentAttribute

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

setAgentAttribute

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

removeAgentAttribute

void removeAgentAttribute(java.lang.String key)

Remove attribute.

Parameters:

key - attribute to remove

getAgentAttribute

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). If the key is not present, then null will be returned.

childTracerFinished

void childTracerFinished(Tracer child)

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

getChildCount

int getChildCount()

getParentTracer

Tracer getParentTracer()

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

setParentTracer

void setParentTracer(Tracer tracer)

isParent

boolean isParent()

Does the tracer have any children?

getClassMethodSignature

ClassMethodSignature getClassMethodSignature()

isTransactionSegment

boolean isTransactionSegment()

Returns true if this tracer should participate in transaction trace.

isChildHasStackTrace

boolean isChildHasStackTrace()

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

Returns:

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

getTransactionSegment

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

isLeaf

boolean isLeaf()

isAsync

boolean isAsync()

removeTransactionSegment

void removeTransactionSegment()

markFinishTime

void markFinishTime()

getGuid

java.lang.String getGuid()

Description copied from interface: ErrorTracer

Gets the random identifier of this Tracer.

Specified by:

getGuid in interface ErrorTracer

getStartTimeInMillis

long getStartTimeInMillis()

getExternalParameters

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

getAgentAttributeNamesForSpans

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

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.