[SqlClient/EFCore] summary optimization phase 2 (#3116)

Co-authored-by: Martin Costello <[email protected]>
Co-authored-by: Alan West <[email protected]>

Author: 3 people

src/Shared/SqlProcessor.cs

@@ -3,7 +3,7 @@
 
 namespace OpenTelemetry.Instrumentation;
 
-internal struct SqlStatementInfo
+internal readonly struct SqlStatementInfo
 {
     public SqlStatementInfo(string sanitizedSql, string dbQuerySummaryText)
     {

src/Shared/SqlStatementInfo.cs

@@ -1,16 +1,21 @@
 ```
 
-BenchmarkDotNet v0.13.12, Windows 11 (10.0.26100.4946)
+BenchmarkDotNet v0.15.2, Windows 11 (10.0.26100.6584/24H2/2024Update/HudsonValley)
 Unknown processor
-.NET SDK 9.0.304
-  [Host]     : .NET 9.0.8 (9.0.825.36511), X64 RyuJIT AVX-512F+CD+BW+DQ+VL+VBMI
-  DefaultJob : .NET 9.0.8 (9.0.825.36511), X64 RyuJIT AVX-512F+CD+BW+DQ+VL+VBMI
+.NET SDK 9.0.305
+  [Host]     : .NET 9.0.9 (9.0.925.41916), X64 RyuJIT AVX2
+  DefaultJob : .NET 9.0.9 (9.0.925.41916), X64 RyuJIT AVX2
 
 
 ```
-| Method | Sql                  | Iterations | Mean      | Error     | StdDev    | Allocated |
-|------- |--------------------- |----------- |----------:|----------:|----------:|----------:|
-| **Simple** | **SELEC(...)ls od [39]** | **1**          |  **16.42 ns** |  **0.362 ns** |  **0.818 ns** |         **-** |
-| **Simple** | **SELEC(...)ls od [39]** | **20**         | **335.73 ns** |  **6.616 ns** |  **9.698 ns** |         **-** |
-| **Simple** | **SELE(...)_id) [101]**  | **1**          |  **33.42 ns** |  **0.700 ns** |  **1.445 ns** |         **-** |
-| **Simple** | **SELE(...)_id) [101]**  | **20**         | **654.29 ns** | **12.859 ns** | **13.759 ns** |         **-** |
+| Method          | Sql                  | Mean     | Error   | StdDev  | Allocated |
+|---------------- |--------------------- |---------:|--------:|--------:|----------:|
+| **GetSanitizedSql** | **CREAT(...)s(Id) [56]** | **214.9 ns** | **4.30 ns** | **8.18 ns** |     **248 B** |
+| **GetSanitizedSql** | **DELET(...) = 42 [32]** | **177.8 ns** | **3.53 ns** | **3.47 ns** |     **128 B** |
+| **GetSanitizedSql** | **INSER(...)3e-5) [76]** | **263.4 ns** | **4.11 ns** | **3.85 ns** |     **192 B** |
+| **GetSanitizedSql** | **SELEC(...)ls od [39]** | **153.8 ns** | **1.68 ns** | **1.57 ns** |     **184 B** |
+| **GetSanitizedSql** | **SELE(...)tory [111]**  | **252.8 ns** | **4.04 ns** | **4.33 ns** |     **424 B** |
+| **GetSanitizedSql** | **SELEC(...)table [69]** | **109.7 ns** | **1.29 ns** | **1.14 ns** |     **128 B** |
+| **GetSanitizedSql** | **SELEC(...) c.Id [74]** | **246.8 ns** | **4.52 ns** | **4.23 ns** |     **264 B** |
+| **GetSanitizedSql** | **SELE(...)_id) [101]**  | **291.8 ns** | **5.12 ns** | **4.79 ns** |     **312 B** |
+| **GetSanitizedSql** | **UPDAT(...) = 42 [44]** | **189.6 ns** | **3.69 ns** | **5.05 ns** |     **144 B** |

test/OpenTelemetry.Contrib.Shared.Benchmarks/BenchmarkResults/results/OpenTelemetry.Instrumentation.Benchmarks.SqlProcessorBenchmarks-report-github.md

@@ -5,28 +5,22 @@
 using BenchmarkDotNet.Configs;
 using BenchmarkDotNet.Running;
 using JetBrains.Profiler.Api;
-using OpenTelemetry.Instrumentation.Benchmarks;
+using OpenTelemetry.Instrumentation;
 
 if (Debugger.IsAttached || (args.Length > 0 && args[0] == "execute"))
 {
-    var benchmarks = new SqlProcessorBenchmarks
-    {
-        Sql = "SELECT * FROM Orders o, OrderDetails od",
-        Iterations = 100,
-    };
-
     MemoryProfiler.CollectAllocations(true);
 
     MemoryProfiler.GetSnapshot();
 
-    benchmarks.Simple();
+    SqlProcessor.GetSanitizedSql("SELECT * FROM Orders o, OrderDetails od");
 
     MemoryProfiler.GetSnapshot();
 }
 else
 {
     var config = ManualConfig.Create(DefaultConfig.Instance)
-        .WithArtifactsPath(@"..\..\..\BenchmarkResults");
+        .WithArtifactsPath("BenchmarkResults");
 
     BenchmarkSwitcher.FromAssembly(typeof(Program).Assembly).Run(args, config);
 }

test/OpenTelemetry.Contrib.Shared.Benchmarks/Program.cs

@@ -2,24 +2,25 @@
 // SPDX-License-Identifier: Apache-2.0
 
 using BenchmarkDotNet.Attributes;
+using BenchmarkDotNet.Diagnosers;
 
 namespace OpenTelemetry.Instrumentation.Benchmarks;
 
-[MemoryDiagnoser]
+[MemoryDiagnoser(displayGenColumns: false)]
 public class SqlProcessorBenchmarks
 {
-    [Params("SELECT * FROM Orders o, OrderDetails od", "SELECT order_date\nFROM   (SELECT *\nFROM   orders o\nJOIN customers c\nON o.customer_id = c.customer_id)")]
+    [Params(
+         "SELECT * FROM Orders o, OrderDetails od",
+         "SELECT order_date\nFROM   (SELECT *\nFROM   orders o\nJOIN customers c\nON o.customer_id = c.customer_id)",
+         "INSERT INTO Orders(Id, Name, Bin, Rate) VALUES(1, 'abc''def', 0xFF, 1.23e-5)",
+         "UPDATE Orders SET Name = 'foo' WHERE Id = 42",
+         "DELETE FROM Orders WHERE Id = 42",
+         "CREATE UNIQUE CLUSTERED INDEX IX_Orders_Id ON Orders(Id)",
+         "SELECT DISTINCT o.Id FROM Orders o JOIN Customers c ON o.CustomerId = c.Id",
+         "SELECT column -- end of line comment\nFROM /* block \n comment */ table",
+         "SELECT Col1, Col2, Col3, Col4, Col5 FROM VeryLongTableName_Sales2024_Q4, Another_Very_Long_Table_Name_Inventory")]
     public string Sql { get; set; } = string.Empty;
 
-    [Params(1, 20)]
-    public int Iterations { get; set; }
-
     [Benchmark]
-    public void Simple()
-    {
-        for (int i = 0; i < this.Iterations; i++)
-        {
-            SqlProcessor.GetSanitizedSql(this.Sql);
-        }
-    }
+    public void GetSanitizedSql() => SqlProcessor.GetSanitizedSql(this.Sql);
 }

test/OpenTelemetry.Contrib.Shared.Benchmarks/SqlProcessorBenchmarks.cs

@@ -31,7 +31,7 @@
   </ItemGroup>
 
   <ItemGroup>
-    <EmbeddedResource Include="SqlProcessorTestCases.json" LogicalName="SqlProcessorTestCases.json" />
+    <EmbeddedResource Include="*.json" LogicalName="%(FileName)%(Extension)" />
   </ItemGroup>
 
 </Project>

test/OpenTelemetry.Contrib.Shared.Tests/OpenTelemetry.Contrib.Shared.Tests.csproj

@@ -0,0 +1,10 @@
+# OpenTelemetry Shared Tests
+
+## SqlProcessor Tests
+
+`SqlProcessorTestCases.json` contains test cases for the `SqlProcessor` class.
+This is synced from the [Semantic Conventions repository](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/non-normative/database-test-cases/db-sql-test-cases.json)
+and should not be modified directly.
+
+`SqlProcessorAdditionalTestCases.json` contains additional test cases which
+may be contributed back to the semantic conventions repo.