com.newrelic.agent.tracers

Interface SqlTracer

All Superinterfaces:

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

All Known Implementing Classes:

DefaultSqlTracer, OtherRootSqlTracer

public interface SqlTracer
extends SqlTracerExplainInfo, Tracer

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DATABASE_VENDOR_PARAMETER_NAME
static java.lang.String	EXPLAIN_PLAN_FORMAT_PARAMETER_NAME
static java.lang.String	EXPLAIN_PLAN_PARAMETER_NAME
static java.lang.String	SQL_OBFUSCATED_PARAMETER_NAME
static java.lang.String	SQL_PARAMETER_NAME

Method Summary

Modifier and Type	Method and Description
com.newrelic.agent.bridge.datastore.ConnectionFactory	getConnectionFactory() Returns a ConnectionFactory instance which can create a database connection on demand.
java.lang.String	getHost() Returns the host of database instance used to run the query.
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.
Transaction	getTransaction() Return the Transaction that this SqlTracer is participating in.
void	provideConnection(java.sql.Connection conn) Grab the host and port from the connection and store it on this tracer.
void	setConnectionFactory(com.newrelic.agent.bridge.datastore.ConnectionFactory connectionFactory) Store a connection factory instance on this SqlTracer for later use.
void	setParams(java.lang.Object[] params) Store the parameters for this sql statement (must be in order).
void	setRawSql(java.lang.String rawSql) Store the raw sql string on this tracer.

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

getExplainPlanExecutor, getSql, hasExplainPlan, setExplainPlan

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, 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

Field Detail

EXPLAIN_PLAN_PARAMETER_NAME

static final java.lang.String EXPLAIN_PLAN_PARAMETER_NAME

See Also:

Constant Field Values

EXPLAIN_PLAN_FORMAT_PARAMETER_NAME

static final java.lang.String EXPLAIN_PLAN_FORMAT_PARAMETER_NAME

See Also:

Constant Field Values

DATABASE_VENDOR_PARAMETER_NAME

static final java.lang.String DATABASE_VENDOR_PARAMETER_NAME

See Also:

Constant Field Values

SQL_PARAMETER_NAME

static final java.lang.String SQL_PARAMETER_NAME

See Also:

Constant Field Values

SQL_OBFUSCATED_PARAMETER_NAME

static final java.lang.String SQL_OBFUSCATED_PARAMETER_NAME

See Also:

Constant Field Values

Method Detail

getConnectionFactory

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

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.

Returns:

ConnectionFactory instance

setConnectionFactory

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

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

Parameters:

connectionFactory - The ConnectionFactory instance to store

getRawSql

java.lang.String getRawSql()

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.

Returns:

The raw sql string

provideConnection

void provideConnection(java.sql.Connection conn)

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

Parameters:

conn - the connection instance to grab from

setRawSql

void setRawSql(java.lang.String rawSql)

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

Parameters:

rawSql - the raw sql string to store

getParams

java.lang.Object[] getParams()

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.

Returns:

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

setParams

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

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

Parameters:

params - the parameters of this sql statement

getTransaction

Transaction getTransaction()

Return the Transaction that this SqlTracer is participating in.

Returns:

the current Transaction

getHost

java.lang.String getHost()

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

Returns:

host of database instance used to run the query.

getPort

java.lang.Integer getPort()

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

Returns:

port of the database instance used to run the query.