(fix): handle JSON columns in db statement expressions

Author: Perseus

packages/app/src/components/ServiceDashboardEndpointPerformanceChart.tsx

@@ -68,21 +68,22 @@ export default function ServiceDashboardEndpointPerformanceChart({
   // existence of the serverAddress/httpHost to build the span name
   if (jsonColumns.includes(spanAttributesExpression)) {
     spanNameColSql = `
-    concat(
-      ${expressions.spanName}, ' ',
-      if(
-        has(['HTTP DELETE', 'DELETE', 'HTTP GET', 'GET', 'HTTP HEAD', 'HEAD', 'HTTP OPTIONS', 'OPTIONS', 'HTTP PATCH', 'PATCH', 'HTTP POST', 'POST', 'HTTP PUT', 'PUT'], ${expressions.spanName}),
+      concat(
+        ${expressions.spanName}, ' ',
         if(
-            toString(${expressions.serverAddress}) != '',
-            toString(${expressions.serverAddress}),
-            if(
-              toString(${expressions.httpHost}) != '', 
-              toString(${expressions.httpHost}), 
-              ''
-            )
-          ),
-        ''
-    ))`;
+          has(['HTTP DELETE', 'DELETE', 'HTTP GET', 'GET', 'HTTP HEAD', 'HEAD', 'HTTP OPTIONS', 'OPTIONS', 'HTTP PATCH', 'PATCH', 'HTTP POST', 'POST', 'HTTP PUT', 'PUT'], ${expressions.spanName}),
+          if(
+              toString(${expressions.serverAddress}) != '',
+              toString(${expressions.serverAddress}),
+              if(
+                toString(${expressions.httpHost}) != '', 
+                toString(${expressions.httpHost}), 
+                ''
+              )
+            ),
+          ''
+        )
+      )`;
   }
 
   return (

packages/app/src/serviceDashboard.ts

@@ -4,7 +4,6 @@ function getDefaults(jsonColumns: string[] = []) {
   const spanAttributeField = 'SpanAttributes';
   const isJsonColumn = jsonColumns.includes(spanAttributeField);
 
-  // Helper function to format field access based on column type
   const formatFieldAccess = (field: string, key: string) => {
     if (isJsonColumn) {
       return `${field}.\`${key}\``;
@@ -13,6 +12,27 @@ function getDefaults(jsonColumns: string[] = []) {
     }
   };
 
+  let dbStatement = `coalesce(nullif(${formatFieldAccess(spanAttributeField, 'db.query.text')}, ''), nullif(${formatFieldAccess(spanAttributeField, 'db.statement')}, ''))`;
+
+  // ClickHouse does not support NULLIF(some_dynamic_column)
+  // so we instead use toString() and an empty string check to check for
+  // existence of the serverAddress/httpHost to build the span name
+  if (isJsonColumn) {
+    dbStatement = `
+      coalesce(
+        if(
+          toString(${formatFieldAccess(spanAttributeField, 'db.query.text')}) != '',
+          toString(${formatFieldAccess(spanAttributeField, 'db.query.text')}),
+          if(
+            toString(${formatFieldAccess(spanAttributeField, 'db.statement')}) != '',
+            toString(${formatFieldAccess(spanAttributeField, 'db.statement')}), 
+            ''
+          )
+        )
+      )
+    `;
+  }
+
   return {
     duration: 'Duration',
     durationPrecision: 9,
@@ -26,7 +46,7 @@ function getDefaults(jsonColumns: string[] = []) {
     httpScheme: formatFieldAccess(spanAttributeField, 'http.scheme'),
     serverAddress: formatFieldAccess(spanAttributeField, 'server.address'),
     httpHost: formatFieldAccess(spanAttributeField, 'http.host'),
-    dbStatement: `coalesce(nullif(${formatFieldAccess(spanAttributeField, 'db.query.text')}, ''), nullif(${formatFieldAccess(spanAttributeField, 'db.statement')}, ''))`,
+    dbStatement,
   };
 }
 

packages/common-utils/src/metadata.ts

@@ -162,6 +162,7 @@ export class Metadata {
       connectionId,
     });
 
+    // TODO: should we use .includes() to handle Array(JSON) and other variants?
     return columns
       .filter(column => column.type.startsWith('JSON'))
       .map(column => column.name);