feat: [AI-5975] add sql_quality telemetry for issue prevention metrics

suryaiyer95 · claude · suryaiyer95 · commit 7b7471368ccc · 2026-03-24T15:05:18.000-07:00
Add a new `sql_quality` telemetry event that fires whenever tools
successfully detect SQL issues — turning findings into measurable
"issues prevented" data in App Insights.

Architecture:
- New `sql_quality` event type in `Telemetry.Event` with `finding_count`,
  `by_severity`, `by_category`, `has_schema`, `dialect`, `duration_ms`
- New `Telemetry.Finding` interface and `aggregateFindings()` helper
- Centralized emission in `tool.ts` — checks `metadata.findings` array
  after any tool completes, aggregates counts, emits event
- Tools populate `metadata.findings` with `{category, severity}` pairs:
  - `sql_analyze`: issue type + severity from lint/semantic/safety analysis
  - `altimate_core_validate`: classified validation errors (missing_table,
    missing_column, syntax_error, type_mismatch)
  - `altimate_core_semantics`: rule/type + severity from semantic checks
  - `altimate_core_fix`: fix_applied / unfixable_error categories
  - `altimate_core_correct`: correction_applied findings
  - `altimate_core_equivalence`: equivalence_difference findings

PII-safe: only category names and severity levels flow to telemetry,
never SQL content.

Co-Authored-By: Claude Opus 4.6 &lt;noreply@anthropic.com&gt;
diff --git a/packages/opencode/src/altimate/telemetry/index.ts b/packages/opencode/src/altimate/telemetry/index.ts
@@ -405,6 +405,23 @@ export namespace Telemetry {
         masked_args?: string
         duration_ms: number
       }
+    // altimate_change start — sql quality telemetry for issue prevention metrics
+    | {
+        type: "sql_quality"
+        timestamp: number
+        session_id: string
+        tool_name: string
+        tool_category: string
+        finding_count: number
+        /** JSON-encoded Record<string, number> — count per severity level */
+        by_severity: string
+        /** JSON-encoded Record<string, number> — count per issue category */
+        by_category: string
+        has_schema: boolean
+        dialect: string
+        duration_ms: number
+      }
+    // altimate_change end
 
   const ERROR_PATTERNS: Array<{
     class: Telemetry.Event & { type: "core_failure" } extends { error_class: infer C } ? C : never
@@ -774,6 +791,28 @@ export namespace Telemetry {
     }
   }
 
+  // altimate_change start — sql quality telemetry types
+  /** Lightweight finding record for quality telemetry. Only category/severity — never SQL content. */
+  export interface Finding {
+    category: string
+    severity: string
+  }
+
+  /** Aggregate an array of findings into counts suitable for the sql_quality event. */
+  export function aggregateFindings(findings: Finding[]): {
+    by_severity: Record<string, number>
+    by_category: Record<string, number>
+  } {
+    const by_severity: Record<string, number> = {}
+    const by_category: Record<string, number> = {}
+    for (const f of findings) {
+      by_severity[f.severity] = (by_severity[f.severity] ?? 0) + 1
+      by_category[f.category] = (by_category[f.category] ?? 0) + 1
+    }
+    return { by_severity, by_category }
+  }
+  // altimate_change end
+
   export async function shutdown() {
     // Wait for init to complete so we know whether telemetry is enabled
     // and have a valid endpoint to flush to.  init() is fire-and-forget
diff --git a/packages/opencode/src/altimate/tools/altimate-core-correct.ts b/packages/opencode/src/altimate/tools/altimate-core-correct.ts
@@ -1,6 +1,7 @@
 import z from "zod"
 import { Tool } from "../../tool/tool"
 import { Dispatcher } from "../native"
+import type { Telemetry } from "../telemetry"
 
 export const AltimateCoreCorrectTool = Tool.define("altimate_core_correct", {
   description:
@@ -11,6 +12,7 @@ export const AltimateCoreCorrectTool = Tool.define("altimate_core_correct", {
     schema_context: z.record(z.string(), z.any()).optional().describe("Inline schema definition"),
   }),
   async execute(args, ctx) {
+    const hasSchema = !!(args.schema_path || (args.schema_context && Object.keys(args.schema_context).length > 0))
     try {
       const result = await Dispatcher.call("altimate_core.correct", {
         sql: args.sql,
@@ -19,14 +21,26 @@ export const AltimateCoreCorrectTool = Tool.define("altimate_core_correct", {
       })
       const data = (result.data ?? {}) as Record<string, any>
       const error = result.error ?? data.error ?? extractCorrectErrors(data)
+      // altimate_change start — sql quality findings for telemetry
+      const findings: Telemetry.Finding[] = (data.changes ?? []).map(() => ({
+        category: "correction_applied",
+      }))
+      // altimate_change end
       return {
         title: `Correct: ${data.success ? "CORRECTED" : "COULD NOT CORRECT"}`,
-        metadata: { success: result.success, iterations: data.iterations, ...(error && { error }) },
+        metadata: {
+          success: result.success,
+          iterations: data.iterations,
+          has_schema: hasSchema,
+          dialect: "snowflake",
+          ...(error && { error }),
+          ...(findings.length > 0 && { findings }),
+        },
         output: formatCorrect(data),
       }
     } catch (e) {
       const msg = e instanceof Error ? e.message : String(e)
-      return { title: "Correct: ERROR", metadata: { success: false, iterations: 0, error: msg }, output: `Failed: ${msg}` }
+      return { title: "Correct: ERROR", metadata: { success: false, iterations: 0, has_schema: hasSchema, dialect: "snowflake", error: msg }, output: `Failed: ${msg}` }
     }
   },
 })
diff --git a/packages/opencode/src/altimate/tools/altimate-core-equivalence.ts b/packages/opencode/src/altimate/tools/altimate-core-equivalence.ts
@@ -1,6 +1,7 @@
 import z from "zod"
 import { Tool } from "../../tool/tool"
 import { Dispatcher } from "../native"
+import type { Telemetry } from "../telemetry"
 
 export const AltimateCoreEquivalenceTool = Tool.define("altimate_core_equivalence", {
   description:
@@ -12,9 +13,10 @@ export const AltimateCoreEquivalenceTool = Tool.define("altimate_core_equivalenc
     schema_context: z.record(z.string(), z.any()).optional().describe("Inline schema definition"),
   }),
   async execute(args, ctx) {
-    if (!args.schema_path && (!args.schema_context || Object.keys(args.schema_context).length === 0)) {
+    const hasSchema = !!(args.schema_path || (args.schema_context && Object.keys(args.schema_context).length > 0))
+    if (!hasSchema) {
       const error = "No schema provided. Provide schema_context or schema_path so table/column references can be resolved."
-      return { title: "Equivalence: NO SCHEMA", metadata: { success: false, equivalent: false, error }, output: `Error: ${error}` }
+      return { title: "Equivalence: NO SCHEMA", metadata: { success: false, equivalent: false, has_schema: false, dialect: "snowflake", error }, output: `Error: ${error}` }
     }
     try {
       const result = await Dispatcher.call("altimate_core.equivalence", {
@@ -28,14 +30,29 @@ export const AltimateCoreEquivalenceTool = Tool.define("altimate_core_equivalenc
       // "Not equivalent" is a valid analysis result, not a failure.
       // Only treat it as failure when there's an actual error.
       const isRealFailure = !!error
+      // altimate_change start — sql quality findings for telemetry
+      const findings: Telemetry.Finding[] = []
+      if (!data.equivalent && data.differences?.length) {
+        for (const d of data.differences) {
+          findings.push({ category: "equivalence_difference" })
+        }
+      }
+      // altimate_change end
       return {
         title: isRealFailure ? "Equivalence: ERROR" : `Equivalence: ${data.equivalent ? "EQUIVALENT" : "DIFFERENT"}`,
-        metadata: { success: !isRealFailure, equivalent: data.equivalent, ...(error && { error }) },
+        metadata: {
+          success: !isRealFailure,
+          equivalent: data.equivalent,
+          has_schema: hasSchema,
+          dialect: "snowflake",
+          ...(error && { error }),
+          ...(findings.length > 0 && { findings }),
+        },
         output: formatEquivalence(data),
       }
     } catch (e) {
       const msg = e instanceof Error ? e.message : String(e)
-      return { title: "Equivalence: ERROR", metadata: { success: false, equivalent: false, error: msg }, output: `Failed: ${msg}` }
+      return { title: "Equivalence: ERROR", metadata: { success: false, equivalent: false, has_schema: hasSchema, dialect: "snowflake", error: msg }, output: `Failed: ${msg}` }
     }
   },
 })
diff --git a/packages/opencode/src/altimate/tools/altimate-core-fix.ts b/packages/opencode/src/altimate/tools/altimate-core-fix.ts
@@ -1,6 +1,7 @@
 import z from "zod"
 import { Tool } from "../../tool/tool"
 import { Dispatcher } from "../native"
+import type { Telemetry } from "../telemetry"
 
 export const AltimateCoreFixTool = Tool.define("altimate_core_fix", {
   description:
@@ -12,6 +13,7 @@ export const AltimateCoreFixTool = Tool.define("altimate_core_fix", {
     max_iterations: z.number().optional().describe("Maximum fix iterations (default: 5)"),
   }),
   async execute(args, ctx) {
+    const hasSchema = !!(args.schema_path || (args.schema_context && Object.keys(args.schema_context).length > 0))
     try {
       const result = await Dispatcher.call("altimate_core.fix", {
         sql: args.sql,
@@ -24,14 +26,30 @@ export const AltimateCoreFixTool = Tool.define("altimate_core_fix", {
       // post_fix_valid=true with no errors means SQL was already valid (nothing to fix)
       const alreadyValid = data.post_fix_valid && !error
       const success = result.success || alreadyValid
+      // altimate_change start — sql quality findings for telemetry
+      const findings: Telemetry.Finding[] = []
+      for (const fix of data.fixes_applied ?? data.changes ?? []) {
+        findings.push({ category: "fix_applied" })
+      }
+      for (const err of data.unfixable_errors ?? []) {
+        findings.push({ category: "unfixable_error" })
+      }
+      // altimate_change end
       return {
         title: `Fix: ${alreadyValid ? "ALREADY VALID" : data.fixed ? "FIXED" : "COULD NOT FIX"}`,
-        metadata: { success, fixed: !!data.fixed_sql, ...(error && { error }) },
+        metadata: {
+          success,
+          fixed: !!data.fixed_sql,
+          has_schema: hasSchema,
+          dialect: "snowflake",
+          ...(error && { error }),
+          ...(findings.length > 0 && { findings }),
+        },
         output: formatFix(data),
       }
     } catch (e) {
       const msg = e instanceof Error ? e.message : String(e)
-      return { title: "Fix: ERROR", metadata: { success: false, fixed: false, error: msg }, output: `Failed: ${msg}` }
+      return { title: "Fix: ERROR", metadata: { success: false, fixed: false, has_schema: hasSchema, dialect: "snowflake", error: msg }, output: `Failed: ${msg}` }
     }
   },
 })
diff --git a/packages/opencode/src/altimate/tools/altimate-core-policy.ts b/packages/opencode/src/altimate/tools/altimate-core-policy.ts
@@ -1,6 +1,7 @@
 import z from "zod"
 import { Tool } from "../../tool/tool"
 import { Dispatcher } from "../native"
+import type { Telemetry } from "../telemetry"
 
 export const AltimateCorePolicyTool = Tool.define("altimate_core_policy", {
   description:
@@ -12,6 +13,7 @@ export const AltimateCorePolicyTool = Tool.define("altimate_core_policy", {
     schema_context: z.record(z.string(), z.any()).optional().describe("Inline schema definition"),
   }),
   async execute(args, ctx) {
+    const hasSchema = !!(args.schema_path || (args.schema_context && Object.keys(args.schema_context).length > 0))
     try {
       const result = await Dispatcher.call("altimate_core.policy", {
         sql: args.sql,
@@ -21,14 +23,26 @@ export const AltimateCorePolicyTool = Tool.define("altimate_core_policy", {
       })
       const data = (result.data ?? {}) as Record<string, any>
       const error = result.error ?? data.error
+      // altimate_change start — sql quality findings for telemetry
+      const findings: Telemetry.Finding[] = (data.violations ?? []).map((v: any) => ({
+        category: v.rule ?? "policy_violation",
+      }))
+      // altimate_change end
       return {
         title: `Policy: ${data.pass ? "PASS" : "VIOLATIONS FOUND"}`,
-        metadata: { success: result.success, pass: data.pass, ...(error && { error }) },
+        metadata: {
+          success: result.success,
+          pass: data.pass,
+          has_schema: hasSchema,
+          dialect: "snowflake",
+          ...(error && { error }),
+          ...(findings.length > 0 && { findings }),
+        },
         output: formatPolicy(data),
       }
     } catch (e) {
       const msg = e instanceof Error ? e.message : String(e)
-      return { title: "Policy: ERROR", metadata: { success: false, pass: false, error: msg }, output: `Failed: ${msg}` }
+      return { title: "Policy: ERROR", metadata: { success: false, pass: false, has_schema: hasSchema, dialect: "snowflake", error: msg }, output: `Failed: ${msg}` }
     }
   },
 })
diff --git a/packages/opencode/src/altimate/tools/altimate-core-semantics.ts b/packages/opencode/src/altimate/tools/altimate-core-semantics.ts
@@ -1,6 +1,7 @@
 import z from "zod"
 import { Tool } from "../../tool/tool"
 import { Dispatcher } from "../native"
+import type { Telemetry } from "../telemetry"
 
 export const AltimateCoreSemanticsTool = Tool.define("altimate_core_semantics", {
   description:
@@ -11,9 +12,10 @@ export const AltimateCoreSemanticsTool = Tool.define("altimate_core_semantics",
     schema_context: z.record(z.string(), z.any()).optional().describe("Inline schema definition"),
   }),
   async execute(args, ctx) {
-    if (!args.schema_path && (!args.schema_context || Object.keys(args.schema_context).length === 0)) {
+    const hasSchema = !!(args.schema_path || (args.schema_context && Object.keys(args.schema_context).length > 0))
+    if (!hasSchema) {
       const error = "No schema provided. Provide schema_context or schema_path so table/column references can be resolved."
-      return { title: "Semantics: NO SCHEMA", metadata: { success: false, valid: false, issue_count: 0, error }, output: `Error: ${error}` }
+      return { title: "Semantics: NO SCHEMA", metadata: { success: false, valid: false, issue_count: 0, has_schema: false, dialect: "snowflake", error }, output: `Error: ${error}` }
     }
     try {
       const result = await Dispatcher.call("altimate_core.semantics", {
@@ -25,14 +27,27 @@ export const AltimateCoreSemanticsTool = Tool.define("altimate_core_semantics",
       const issueCount = data.issues?.length ?? 0
       const error = result.error ?? data.error ?? extractSemanticsErrors(data)
       const hasError = Boolean(error)
+      // altimate_change start — sql quality findings for telemetry
+      const findings: Telemetry.Finding[] = (data.issues ?? []).map(() => ({
+        category: "semantic_issue",
+      }))
+      // altimate_change end
       return {
         title: hasError ? "Semantics: ERROR" : `Semantics: ${data.valid ? "VALID" : `${issueCount} issues`}`,
-        metadata: { success: result.success, valid: data.valid, issue_count: issueCount, ...(error && { error }) },
+        metadata: {
+          success: result.success,
+          valid: data.valid,
+          issue_count: issueCount,
+          has_schema: hasSchema,
+          dialect: "snowflake",
+          ...(error && { error }),
+          ...(findings.length > 0 && { findings }),
+        },
         output: formatSemantics(hasError ? { ...data, error } : data),
       }
     } catch (e) {
       const msg = e instanceof Error ? e.message : String(e)
-      return { title: "Semantics: ERROR", metadata: { success: false, valid: false, issue_count: 0, error: msg }, output: `Failed: ${msg}` }
+      return { title: "Semantics: ERROR", metadata: { success: false, valid: false, issue_count: 0, has_schema: hasSchema, dialect: "snowflake", error: msg }, output: `Failed: ${msg}` }
     }
   },
 })
diff --git a/packages/opencode/src/altimate/tools/altimate-core-validate.ts b/packages/opencode/src/altimate/tools/altimate-core-validate.ts
@@ -1,6 +1,7 @@
 import z from "zod"
 import { Tool } from "../../tool/tool"
 import { Dispatcher } from "../native"
+import type { Telemetry } from "../telemetry"
 
 export const AltimateCoreValidateTool = Tool.define("altimate_core_validate", {
   description:
@@ -11,10 +12,11 @@ export const AltimateCoreValidateTool = Tool.define("altimate_core_validate", {
     schema_context: z.record(z.string(), z.any()).optional().describe("Inline schema definition"),
   }),
   async execute(args, ctx) {
-    const noSchema = !args.schema_path && (!args.schema_context || Object.keys(args.schema_context).length === 0)
+    const hasSchema = !!(args.schema_path || (args.schema_context && Object.keys(args.schema_context).length > 0))
+    const noSchema = !hasSchema
     if (noSchema) {
       const error = "No schema provided. Provide schema_context or schema_path so table/column references can be resolved."
-      return { title: "Validate: NO SCHEMA", metadata: { success: false, valid: false, error }, output: `Error: ${error}` }
+      return { title: "Validate: NO SCHEMA", metadata: { success: false, valid: false, has_schema: false, dialect: "snowflake", error }, output: `Error: ${error}` }
     }
     try {
       const result = await Dispatcher.call("altimate_core.validate", {
@@ -24,14 +26,26 @@ export const AltimateCoreValidateTool = Tool.define("altimate_core_validate", {
       })
       const data = (result.data ?? {}) as Record<string, any>
       const error = result.error ?? data.error ?? extractValidationErrors(data)
+      // altimate_change start — sql quality findings for telemetry
+      const findings: Telemetry.Finding[] = (data.errors ?? []).map((err: any) => ({
+        category: classifyValidationError(err.message ?? ""),
+      }))
+      // altimate_change end
       return {
         title: `Validate: ${data.valid ? "VALID" : "INVALID"}`,
-        metadata: { success: result.success, valid: data.valid, ...(error && { error }) },
+        metadata: {
+          success: result.success,
+          valid: data.valid,
+          has_schema: hasSchema,
+          dialect: "snowflake",
+          ...(error && { error }),
+          ...(findings.length > 0 && { findings }),
+        },
         output: formatValidate(data),
       }
     } catch (e) {
       const msg = e instanceof Error ? e.message : String(e)
-      return { title: "Validate: ERROR", metadata: { success: false, valid: false, error: msg }, output: `Failed: ${msg}` }
+      return { title: "Validate: ERROR", metadata: { success: false, valid: false, has_schema: hasSchema, dialect: "snowflake", error: msg }, output: `Failed: ${msg}` }
     }
   },
 })
@@ -44,6 +58,16 @@ function extractValidationErrors(data: Record<string, any>): string | undefined
   return undefined
 }
 
+function classifyValidationError(message: string): string {
+  const lower = message.toLowerCase()
+  // Column check before table — "column not found in table" would match both
+  if (lower.includes("column") && lower.includes("not found")) return "missing_column"
+  if (lower.includes("table") && lower.includes("not found")) return "missing_table"
+  if (lower.includes("syntax")) return "syntax_error"
+  if (lower.includes("type")) return "type_mismatch"
+  return "validation_error"
+}
+
 function formatValidate(data: Record<string, any>): string {
   if (data.error) return `Error: ${data.error}`
   if (data.valid) return "SQL is valid."
diff --git a/packages/opencode/src/altimate/tools/sql-analyze.ts b/packages/opencode/src/altimate/tools/sql-analyze.ts
diff --git a/packages/opencode/src/tool/tool.ts b/packages/opencode/src/tool/tool.ts
diff --git a/packages/opencode/test/altimate/sql-quality-telemetry.test.ts b/packages/opencode/test/altimate/sql-quality-telemetry.test.ts
