com.newrelic.agent.tracers

Class DefaultSqlTracer

java.lang.Object

com.newrelic.agent.tracers.AbstractTracer

com.newrelic.agent.tracers.DefaultTracer

com.newrelic.agent.tracers.DefaultSqlTracer

All Implemented Interfaces:

com.newrelic.agent.bridge.ExitTracer, ErrorTracer, SqlTracer, SqlTracerExplainInfo, TimedItem, Tracer, com.newrelic.api.agent.AttributeHolder, com.newrelic.api.agent.TracedMethod, java.lang.Comparable<DefaultSqlTracer>, java.lang.reflect.InvocationHandler

Direct Known Subclasses:

OtherRootSqlTracer

public class DefaultSqlTracer
extends DefaultTracer
implements SqlTracer, java.lang.Comparable<DefaultSqlTracer>

Field Summary

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

BACKTRACE_PARAMETER_NAME, DEFAULT_TRACER_FLAGS, NULL_METRIC_NAME_FORMATTER

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

ATTRIBUTE_TYPE

Fields inherited from interface com.newrelic.agent.tracers.SqlTracer

DATABASE_VENDOR_PARAMETER_NAME, EXPLAIN_PLAN_FORMAT_PARAMETER_NAME, EXPLAIN_PLAN_PARAMETER_NAME, SQL_OBFUSCATED_PARAMETER_NAME, SQL_PARAMETER_NAME

Constructor Summary

Constructors

Constructor and Description
DefaultSqlTracer(TransactionActivity txa, ClassMethodSignature sig, java.lang.Object object, MetricNameFormat metricNameFormatter, int tracerFlags)
DefaultSqlTracer(TransactionActivity txa, ClassMethodSignature sig, java.lang.Object object, MetricNameFormat metricNameFormatter, int tracerFlags, long pStartTime)
DefaultSqlTracer(Transaction transaction, ClassMethodSignature sig, java.lang.Object object, MetricNameFormat metricNameFormatter, int tracerFlags)
DefaultSqlTracer(Transaction transaction, ClassMethodSignature sig, java.lang.Object object, MetricNameFormat metricNameFormatter, int tracerFlags, long time)

Method Summary

Modifier and Type	Method and Description
int	compareTo(DefaultSqlTracer otherTracer)
protected ExplainPlanExecutor	createExplainPlanExecutor(java.lang.String sql)
protected void	doFinish(int opcode, java.lang.Object returnValue) Subclasses may override.
protected void	doFinish(java.lang.Throwable throwable) Subclasses may override.
com.newrelic.agent.bridge.datastore.ConnectionFactory	getConnectionFactory() Returns a ConnectionFactory instance which can create a database connection on demand.
java.lang.String	getDatabaseName()
protected com.newrelic.agent.bridge.datastore.DatabaseVendor	getDatabaseVendor()
ExplainPlanExecutor	getExplainPlanExecutor() Return an executor class that can run explain plans for the given (Prepared)Statement.
java.lang.String	getHost() Returns the host of database instance used to run the query.
java.lang.String	getIdentifier()
java.lang.Object[]	getParams() Returns an Object array containing the parameters (in order) that were set on a PreparedStatement.
java.lang.Integer	getPort() Returns the port of database instance used to run the query.
java.lang.String	getRawSql() Returns the raw sql string that was used for a given query.
java.lang.Object	getSql() Returns the sql for the statement instrumented by this driver.
boolean	hasExplainPlan() Verify if this SqlTracer has an explain plan associated with it.
boolean	isMetricProducer()
static java.lang.String	parameterizeSql(java.lang.String sql, java.lang.Object[] parameters) Substitute values from the parameter map in the SQL.
void	provideConnection(java.sql.Connection conn) Grab the host and port from the connection and store it on this tracer.
protected void	recordMetrics(TransactionStats transactionStats) Need to override this method to record Datastore metrics before the scoped metric name is recorded
void	setConnectionFactory(com.newrelic.agent.bridge.datastore.ConnectionFactory connectionFactory) Store a connection factory instance on this SqlTracer for later use.
void	setDatabaseName(java.lang.String databaseName)
void	setExplainPlan(java.lang.Object... explainPlan)
void	setHost(java.lang.String host)
void	setIdentifier(java.lang.String identifier)
void	setParams(java.lang.Object[] params) Store the parameters for this sql statement (must be in order).
void	setPort(int port)
void	setRawSql(java.lang.String sql) Store the raw sql string on this tracer.
protected boolean	shouldStoreStackTrace()

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

addOutboundRequestHeaders, childTracerFinished, childTracerFinished, doRecordMetrics, finish, finish, getChildCount, getClassMethodSignature, getDuration, getDurationInMilliseconds, getEndTime, getEndTimeInMilliseconds, getExclusiveDuration, getExternalParameters, getGuid, getInvocationTarget, getMetricName, getMetricNameFormat, getParentTracer, getRequestMetricName, getRunningDurationInNanos, getStartTime, getStartTimeInMillis, getStartTimeInMilliseconds, getTransactionSegment, getTransactionSegmentName, getTransactionSegmentUri, isAsync, isChildHasStackTrace, isLeaf, isParent, isTransactionSegment, performFinishWork, readInboundResponseHeaders, removeTransactionSegment, reportAsExternal, reportAsExternal, reset, setMetricName, setMetricNameFormat, setMetricNameFormatInfo, setParentTracer, storeStackTrace

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

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

getTransaction

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

childTracerFinished, getAgentAttribute, getAgentAttributes, getChildCount, getClassMethodSignature, getCustomAttributes, getEndTime, getEndTimeInMilliseconds, getExclusiveDuration, getExternalParameters, getGuid, getMetricName, getParentTracer, getRunningDurationInNanos, getStartTime, getStartTimeInMillis, getStartTimeInMilliseconds, getTransactionActivity, getTransactionSegment, getTransactionSegmentName, getTransactionSegmentUri, isAsync, isChildHasStackTrace, isLeaf, isParent, isTransactionSegment, markFinishTime, removeAgentAttribute, removeTransactionSegment, setAgentAttribute, 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 java.lang.reflect.InvocationHandler

invoke

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

addExclusiveRollupMetricName, addOutboundRequestHeaders, getParentTracedMethod, 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

Constructor Detail

DefaultSqlTracer

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

DefaultSqlTracer

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

DefaultSqlTracer

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

DefaultSqlTracer

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

Method Detail

getConnectionFactory

public com.newrelic.agent.bridge.datastore.ConnectionFactory getConnectionFactory()

Description copied from interface: SqlTracer

Returns a ConnectionFactory instance which can create a database connection on demand. This will generally be used for running explain plans after a query has already executed.

Specified by:

getConnectionFactory in interface SqlTracer

Returns:

ConnectionFactory instance

setConnectionFactory

public void setConnectionFactory(com.newrelic.agent.bridge.datastore.ConnectionFactory connectionFactory)

Description copied from interface: SqlTracer

Store a connection factory instance on this SqlTracer for later use. Note: A call to this method is automatically wired up in NoticeSqlVisitor

Specified by:

setConnectionFactory in interface SqlTracer

Parameters:

connectionFactory - The ConnectionFactory instance to store

setHost

public void setHost(java.lang.String host)

setPort

public void setPort(int port)

getRawSql

public java.lang.String getRawSql()

Description copied from interface: SqlTracer

Returns the raw sql string that was used for a given query. This string does NOT include parameter values when a PreparedStatement is used, just the raw sql passed in. However, if a Statement is crafted manually this will return everything passed in.

Specified by:

getRawSql in interface SqlTracer

Returns:

The raw sql string

provideConnection

public void provideConnection(java.sql.Connection conn)

Description copied from interface: SqlTracer

Grab the host and port from the connection and store it on this tracer.

Specified by:

provideConnection in interface SqlTracer

Parameters:

conn - the connection instance to grab from

getHost

public java.lang.String getHost()

Description copied from interface: SqlTracer

Returns the host of database instance used to run the query.

Specified by:

getHost in interface SqlTracer

Returns:

host of database instance used to run the query.

getPort

public java.lang.Integer getPort()

Description copied from interface: SqlTracer

Returns the port of database instance used to run the query.

Specified by:

getPort in interface SqlTracer

Returns:

port of the database instance used to run the query.

setRawSql

public void setRawSql(java.lang.String sql)

Description copied from interface: SqlTracer

Store the raw sql string on this tracer. Note: A call to this method is automatically wired up in NoticeSqlVisitor

Specified by:

setRawSql in interface SqlTracer

Parameters:

sql - the raw sql string to store

getParams

public java.lang.Object[] getParams()

Description copied from interface: SqlTracer

Returns an Object array containing the parameters (in order) that were set on a PreparedStatement. If the query is using the Statement class or no parameters were passed in, this will return null.

Specified by:

getParams in interface SqlTracer

Returns:

Object array containing all parameter values in order, or null if none exist

setParams

public void setParams(java.lang.Object[] params)

Description copied from interface: SqlTracer

Store the parameters for this sql statement (must be in order). Note: A call to this method is automatically wired up in NoticeSqlVisitor

Specified by:

setParams in interface SqlTracer

Parameters:

params - the parameters of this sql statement

getDatabaseVendor

protected com.newrelic.agent.bridge.datastore.DatabaseVendor getDatabaseVendor()

doFinish

protected void doFinish(java.lang.Throwable throwable)

Description copied from class: DefaultTracer

Subclasses may override.

Overrides:

doFinish in class DefaultTracer

doFinish

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

Description copied from class: DefaultTracer

Subclasses may override.

Overrides:

doFinish in class DefaultTracer

shouldStoreStackTrace

protected boolean shouldStoreStackTrace()

Overrides:

shouldStoreStackTrace in class DefaultTracer

isMetricProducer

public boolean isMetricProducer()

Overrides:

isMetricProducer in class DefaultTracer

recordMetrics

protected void recordMetrics(TransactionStats transactionStats)

Need to override this method to record Datastore metrics before the scoped metric name is recorded

Overrides:

recordMetrics in class DefaultTracer

getSql

public java.lang.Object getSql()

Returns the sql for the statement instrumented by this driver. This method is overridden by prepared statement tracers which return a sql object that can delay the rendering of the full sql statement with parameters until it is turned to JSON.

Specified by:

getSql in interface SqlTracerExplainInfo

Returns:

Returns a sql object which is either a string or a JSONAware instance.

hasExplainPlan

public boolean hasExplainPlan()

Description copied from interface: SqlTracerExplainInfo

Verify if this SqlTracer has an explain plan associated with it.

Specified by:

hasExplainPlan in interface SqlTracerExplainInfo

Returns:

true if this tracer has explain plan information stored on it, false otherwise

getExplainPlanExecutor

public ExplainPlanExecutor getExplainPlanExecutor()

Description copied from interface: SqlTracerExplainInfo

Return an executor class that can run explain plans for the given (Prepared)Statement.

Specified by:

getExplainPlanExecutor in interface SqlTracerExplainInfo

Returns:

explain plan executor for this statement

createExplainPlanExecutor

protected ExplainPlanExecutor createExplainPlanExecutor(java.lang.String sql)

setExplainPlan

public void setExplainPlan(java.lang.Object... explainPlan)

Specified by:

setExplainPlan in interface SqlTracerExplainInfo

compareTo

public int compareTo(DefaultSqlTracer otherTracer)

Specified by:

compareTo in interface java.lang.Comparable<DefaultSqlTracer>

setIdentifier

public void setIdentifier(java.lang.String identifier)

getIdentifier

public java.lang.String getIdentifier()

setDatabaseName

public void setDatabaseName(java.lang.String databaseName)

getDatabaseName

public java.lang.String getDatabaseName()

parameterizeSql

public static java.lang.String parameterizeSql(java.lang.String sql,
                                               java.lang.Object[] parameters)
                                        throws java.lang.Exception

Substitute values from the parameter map in the SQL.

Parameters:

sql - the SQL

parameters - the parameter map

Returns:

the parameterized SQL

Throws:

java.lang.Exception