remove todo and add comments

newrelic · Dec 1, 2021 · a1d2622 · a1d2622
1 parent e620325
commit a1d2622
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 9 deletions.
diff --git a/newrelic-agent/src/main/java/com/newrelic/agent/sql/DefaultSlowQueryListener.java b/newrelic-agent/src/main/java/com/newrelic/agent/sql/DefaultSlowQueryListener.java
@@ -55,8 +55,8 @@ public <T> void noticeTracer(Tracer tracer, SlowQueryDatastoreParameters<T> slow
             }
 
             // This allows transaction traces to show slow queries directly in the trace details
-            //todo: obfuscatedQueryString isn't correct, it could be Raw or Obfuscated. The queryConverter
-            // has conditional obfuscation, respecting recrod_sql setting.
+            // Unfortunately, SQL_OBFUSCATED_PARAMETER_NAME is misleading. Before reaching here, the query has already
+            // been processed by SqlQueryConverter in DefaultSqlTracer.  The result could be Raw, Obfuscated, or null.
             tracer.setAgentAttribute(SqlTracer.SQL_OBFUSCATED_PARAMETER_NAME, query);
 
             DatastoreConfig datastoreConfig = ServiceFactory.getConfigService().getDefaultAgentConfig().getDatastoreConfig();

diff --git a/newrelic-agent/src/main/java/com/newrelic/agent/tracers/DefaultSqlTracer.java b/newrelic-agent/src/main/java/com/newrelic/agent/tracers/DefaultSqlTracer.java
@@ -305,13 +305,8 @@ protected void recordMetrics(TransactionStats transactionStats) {
     }
 
     /**
-     * This method is named this way because the docs on toObfuscatedQueryString imply obfuscation certainty.
-     * The reality is the SqlQueryConverter implementation of this method has introduced conditional
-     * logic that respects the agent configuration setting `record_sql`.
-     *
-     * If OBFUSCATED, sql is obfuscated.
-     * If RAW, sql is returned, unchanged.
-     * If OFF, null is returned.
+     * This method is named this way because {@link SqlQueryConverter#toObfuscatedQueryString(String)} has
+     * unexpected conditional logic.
      */
     private String getNoRawOrObfuscatedSql(String rawSql, String appName) {
         SqlQueryConverter converter = new SqlQueryConverter(appName, getDatabaseVendor());
@@ -559,6 +554,12 @@ public String toRawQueryString(String rawQuery) {
             return rawQuery;
         }
 
+        /**
+         * For this implementation, the getSqlfuscator has conditional
+         * logic to return an obfuscator that respects the agent configuration setting `record_sql`
+         *
+         * See {@link com.newrelic.agent.database.DatabaseService#createSqlObfuscator(TransactionTracerConfig) }
+         */
         @Override
         public String toObfuscatedQueryString(String rawQuery) {
             SqlObfuscator sqlObfuscator = ServiceFactory.getDatabaseService().getSqlObfuscator(appName);