OTEL implementation, so far matching EventCounters infrastructure.

dotnet · Apr 29, 2024 · 0288f34 · 0288f34
1 parent 385b562
commit 0288f34
Show file tree

Hide file tree

Showing 21 changed files with 714 additions and 194 deletions.
diff --git a/...e.Cosmos/Query/Internal/CosmosShapedQueryCompilingExpressionVisitor.QueryingEnumerable.cs b/...e.Cosmos/Query/Internal/CosmosShapedQueryCompilingExpressionVisitor.QueryingEnumerable.cs
@@ -7,6 +7,7 @@
 using System.Text;
 using Microsoft.EntityFrameworkCore.Cosmos.Internal;
 using Microsoft.EntityFrameworkCore.Cosmos.Storage.Internal;
+using Microsoft.EntityFrameworkCore.Infrastructure.Internal;
 using Newtonsoft.Json.Linq;
 
 namespace Microsoft.EntityFrameworkCore.Cosmos.Query.Internal;
@@ -150,7 +151,9 @@ public bool MoveNext()
                         {
                             var sqlQuery = _queryingEnumerable.GenerateQuery();
 
-                            EntityFrameworkEventSource.Log.QueryExecuting();
+#pragma warning disable EF1001 // Internal EF Core API usage.
+                            EntityFrameworkMetricsData.ReportQueryExecuting();
+#pragma warning restore EF1001 // Internal EF Core API usage.
 
                             _enumerator = _cosmosQueryContext.CosmosClient
                                 .ExecuteSqlQuery(
@@ -248,7 +251,9 @@ public async ValueTask<bool> MoveNextAsync()
                         {
                             var sqlQuery = _queryingEnumerable.GenerateQuery();
 
-                            EntityFrameworkEventSource.Log.QueryExecuting();
+#pragma warning disable EF1001 // Internal EF Core API usage.
+                            EntityFrameworkMetricsData.ReportQueryExecuting();
+#pragma warning restore EF1001 // Internal EF Core API usage.
 
                             _enumerator = _cosmosQueryContext.CosmosClient
                                 .ExecuteSqlQueryAsync(

diff --git a/.../Query/Internal/CosmosShapedQueryCompilingExpressionVisitor.ReadItemQueryingEnumerable.cs b/.../Query/Internal/CosmosShapedQueryCompilingExpressionVisitor.ReadItemQueryingEnumerable.cs
@@ -6,6 +6,7 @@
 using System.Collections;
 using Microsoft.EntityFrameworkCore.ChangeTracking.Internal;
 using Microsoft.EntityFrameworkCore.Cosmos.Internal;
+using Microsoft.EntityFrameworkCore.Infrastructure.Internal;
 using Microsoft.EntityFrameworkCore.Internal;
 using Newtonsoft.Json.Linq;
 
@@ -218,7 +219,9 @@ public bool MoveNext()
                                 throw new InvalidOperationException(CosmosStrings.PartitionKeyMissing);
                             }
 
-                            EntityFrameworkEventSource.Log.QueryExecuting();
+#pragma warning disable EF1001 // Internal EF Core API usage.
+                            EntityFrameworkMetricsData.ReportQueryExecuting();
+#pragma warning restore EF1001 // Internal EF Core API usage.
 
                             _item = _cosmosQueryContext.CosmosClient.ExecuteReadItem(
                                 _readItemExpression.Container,
@@ -270,7 +273,9 @@ public async ValueTask<bool> MoveNextAsync()
                                 throw new InvalidOperationException(CosmosStrings.PartitionKeyMissing);
                             }
 
-                            EntityFrameworkEventSource.Log.QueryExecuting();
+#pragma warning disable EF1001 // Internal EF Core API usage.
+                            EntityFrameworkMetricsData.ReportQueryExecuting();
+#pragma warning restore EF1001 // Internal EF Core API usage.
 
                             _item = await _cosmosQueryContext.CosmosClient.ExecuteReadItemAsync(
                                     _readItemExpression.Container,

diff --git a/...Memory/Query/Internal/InMemoryShapedQueryCompilingExpressionVisitor.QueryingEnumerable.cs b/...Memory/Query/Internal/InMemoryShapedQueryCompilingExpressionVisitor.QueryingEnumerable.cs
@@ -2,6 +2,7 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 using System.Collections;
+using Microsoft.EntityFrameworkCore.Infrastructure.Internal;
 using Microsoft.EntityFrameworkCore.InMemory.Internal;
 
 namespace Microsoft.EntityFrameworkCore.InMemory.Query.Internal;
@@ -155,7 +156,9 @@ private bool MoveNextHelper()
             {
                 if (_enumerator == null)
                 {
-                    EntityFrameworkEventSource.Log.QueryExecuting();
+#pragma warning disable EF1001 // Internal EF Core API usage.
+                    EntityFrameworkMetricsData.ReportQueryExecuting();
+#pragma warning restore EF1001 // Internal EF Core API usage.
 
                     _enumerator = _innerEnumerable.GetEnumerator();
                     _queryContext.InitializeStateManager(_standAloneStateManager);

diff --git a/src/EFCore.Relational/Query/Internal/FromSqlQueryingEnumerable.cs b/src/EFCore.Relational/Query/Internal/FromSqlQueryingEnumerable.cs
@@ -2,6 +2,7 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 using System.Collections;
+using Microsoft.EntityFrameworkCore.Infrastructure.Internal;
 using Microsoft.EntityFrameworkCore.Internal;
 
 namespace Microsoft.EntityFrameworkCore.Query.Internal;
@@ -269,7 +270,9 @@ public bool MoveNext()
 
         private static bool InitializeReader(Enumerator enumerator)
         {
-            EntityFrameworkEventSource.Log.QueryExecuting();
+#pragma warning disable EF1001 // Internal EF Core API usage.
+            EntityFrameworkMetricsData.ReportQueryExecuting();
+#pragma warning restore EF1001 // Internal EF Core API usage.
 
             var relationalCommand = enumerator._relationalCommand =
                 enumerator._relationalCommandCache.RentAndPopulateRelationalCommand(enumerator._relationalQueryContext);
@@ -391,7 +394,9 @@ public async ValueTask<bool> MoveNextAsync()
 
         private static async Task<bool> InitializeReaderAsync(AsyncEnumerator enumerator, CancellationToken cancellationToken)
         {
-            EntityFrameworkEventSource.Log.QueryExecuting();
+#pragma warning disable EF1001 // Internal EF Core API usage.
+            EntityFrameworkMetricsData.ReportQueryExecuting();
+#pragma warning restore EF1001 // Internal EF Core API usage.
 
             var relationalCommand = enumerator._relationalCommand =
                 enumerator._relationalCommandCache.RentAndPopulateRelationalCommand(enumerator._relationalQueryContext);

diff --git a/src/EFCore.Relational/Query/Internal/GroupBySingleQueryingEnumerable.cs b/src/EFCore.Relational/Query/Internal/GroupBySingleQueryingEnumerable.cs
@@ -2,6 +2,7 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 using System.Collections;
+using Microsoft.EntityFrameworkCore.Infrastructure.Internal;
 using Microsoft.EntityFrameworkCore.Internal;
 
 namespace Microsoft.EntityFrameworkCore.Query.Internal;
@@ -339,7 +340,9 @@ public bool MoveNext()
 
         private static bool InitializeReader(Enumerator enumerator)
         {
-            EntityFrameworkEventSource.Log.QueryExecuting();
+#pragma warning disable EF1001 // Internal EF Core API usage.
+            EntityFrameworkMetricsData.ReportQueryExecuting();
+#pragma warning restore EF1001 // Internal EF Core API usage.
 
             var relationalCommand = enumerator._relationalCommand =
                 enumerator._relationalCommandCache.RentAndPopulateRelationalCommand(enumerator._relationalQueryContext);
@@ -526,7 +529,9 @@ public async ValueTask<bool> MoveNextAsync()
 
         private static async Task<bool> InitializeReaderAsync(AsyncEnumerator enumerator, CancellationToken cancellationToken)
         {
-            EntityFrameworkEventSource.Log.QueryExecuting();
+#pragma warning disable EF1001 // Internal EF Core API usage.
+            EntityFrameworkMetricsData.ReportQueryExecuting();
+#pragma warning restore EF1001 // Internal EF Core API usage.
 
             var relationalCommand = enumerator._relationalCommand =
                 enumerator._relationalCommandCache.RentAndPopulateRelationalCommand(enumerator._relationalQueryContext);

diff --git a/src/EFCore.Relational/Query/Internal/GroupBySplitQueryingEnumerable.cs b/src/EFCore.Relational/Query/Internal/GroupBySplitQueryingEnumerable.cs
@@ -2,6 +2,7 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 using System.Collections;
+using Microsoft.EntityFrameworkCore.Infrastructure.Internal;
 using Microsoft.EntityFrameworkCore.Internal;
 
 namespace Microsoft.EntityFrameworkCore.Query.Internal;
@@ -339,7 +340,9 @@ public bool MoveNext()
 
         private static bool InitializeReader(Enumerator enumerator)
         {
-            EntityFrameworkEventSource.Log.QueryExecuting();
+#pragma warning disable EF1001 // Internal EF Core API usage.
+            EntityFrameworkMetricsData.ReportQueryExecuting();
+#pragma warning restore EF1001 // Internal EF Core API usage.
 
             var relationalCommand = enumerator._relationalCommand =
                 enumerator._relationalCommandCache.RentAndPopulateRelationalCommand(enumerator._relationalQueryContext);
@@ -517,7 +520,9 @@ public async ValueTask<bool> MoveNextAsync()
 
         private static async Task<bool> InitializeReaderAsync(AsyncEnumerator enumerator, CancellationToken cancellationToken)
         {
-            EntityFrameworkEventSource.Log.QueryExecuting();
+#pragma warning disable EF1001 // Internal EF Core API usage.
+            EntityFrameworkMetricsData.ReportQueryExecuting();
+#pragma warning restore EF1001 // Internal EF Core API usage.
 
             var relationalCommand = enumerator._relationalCommand =
                 enumerator._relationalCommandCache.RentAndPopulateRelationalCommand(enumerator._relationalQueryContext);

diff --git a/src/EFCore.Relational/Query/Internal/SingleQueryingEnumerable.cs b/src/EFCore.Relational/Query/Internal/SingleQueryingEnumerable.cs
@@ -2,6 +2,7 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 using System.Collections;
+using Microsoft.EntityFrameworkCore.Infrastructure.Internal;
 using Microsoft.EntityFrameworkCore.Internal;
 
 namespace Microsoft.EntityFrameworkCore.Query.Internal;
@@ -266,7 +267,9 @@ public bool MoveNext()
 
         private static bool InitializeReader(Enumerator enumerator)
         {
-            EntityFrameworkEventSource.Log.QueryExecuting();
+#pragma warning disable EF1001 // Internal EF Core API usage.
+            EntityFrameworkMetricsData.ReportQueryExecuting();
+#pragma warning restore EF1001 // Internal EF Core API usage.
 
             var relationalCommand = enumerator._relationalCommand =
                 enumerator._relationalCommandCache.RentAndPopulateRelationalCommand(enumerator._relationalQueryContext);
@@ -427,7 +430,9 @@ public async ValueTask<bool> MoveNextAsync()
 
         private static async Task<bool> InitializeReaderAsync(AsyncEnumerator enumerator, CancellationToken cancellationToken)
         {
-            EntityFrameworkEventSource.Log.QueryExecuting();
+#pragma warning disable EF1001 // Internal EF Core API usage.
+            EntityFrameworkMetricsData.ReportQueryExecuting();
+#pragma warning restore EF1001 // Internal EF Core API usage.
 
             var relationalCommand = enumerator._relationalCommand =
                 enumerator._relationalCommandCache.RentAndPopulateRelationalCommand(enumerator._relationalQueryContext);

diff --git a/src/EFCore.Relational/Query/Internal/SplitQueryingEnumerable.cs b/src/EFCore.Relational/Query/Internal/SplitQueryingEnumerable.cs
@@ -2,6 +2,7 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 using System.Collections;
+using Microsoft.EntityFrameworkCore.Infrastructure.Internal;
 using Microsoft.EntityFrameworkCore.Internal;
 
 namespace Microsoft.EntityFrameworkCore.Query.Internal;
@@ -260,7 +261,9 @@ public bool MoveNext()
 
         private static bool InitializeReader(Enumerator enumerator)
         {
-            EntityFrameworkEventSource.Log.QueryExecuting();
+#pragma warning disable EF1001 // Internal EF Core API usage.
+            EntityFrameworkMetricsData.ReportQueryExecuting();
+#pragma warning restore EF1001 // Internal EF Core API usage.
 
             var relationalCommand = enumerator._relationalCommand =
                 enumerator._relationalCommandCache.RentAndPopulateRelationalCommand(enumerator._relationalQueryContext);
@@ -415,7 +418,9 @@ public async ValueTask<bool> MoveNextAsync()
 
         private static async Task<bool> InitializeReaderAsync(AsyncEnumerator enumerator, CancellationToken cancellationToken)
         {
-            EntityFrameworkEventSource.Log.QueryExecuting();
+#pragma warning disable EF1001 // Internal EF Core API usage.
+            EntityFrameworkMetricsData.ReportQueryExecuting();
+#pragma warning restore EF1001 // Internal EF Core API usage.
 
             var relationalCommand = enumerator._relationalCommand =
                 enumerator._relationalCommandCache.RentAndPopulateRelationalCommand(enumerator._relationalQueryContext);

diff --git a/src/EFCore.Relational/Query/RelationalShapedQueryCompilingExpressionVisitor.cs b/src/EFCore.Relational/Query/RelationalShapedQueryCompilingExpressionVisitor.cs
@@ -1,6 +1,7 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
+using Microsoft.EntityFrameworkCore.Infrastructure.Internal;
 using Microsoft.EntityFrameworkCore.Internal;
 using Microsoft.EntityFrameworkCore.Query.Internal;
 using Microsoft.EntityFrameworkCore.Query.SqlExpressions;
@@ -118,7 +119,9 @@ protected virtual Expression VisitNonQuery(NonQueryExpression nonQueryExpression
                     (relationalQueryContext, relationalCommandCache, commandSource),
                     static (_, state) =>
                     {
-                        EntityFrameworkEventSource.Log.QueryExecuting();
+#pragma warning disable EF1001 // Internal EF Core API usage.
+                        EntityFrameworkMetricsData.ReportQueryExecuting();
+#pragma warning restore EF1001 // Internal EF Core API usage.
 
                         var relationalCommand = state.relationalCommandCache.RentAndPopulateRelationalCommand(state.relationalQueryContext);
 
@@ -196,7 +199,9 @@ protected virtual Expression VisitNonQuery(NonQueryExpression nonQueryExpression
                     (relationalQueryContext, relationalCommandCache, commandSource),
                     static (_, state, cancellationToken) =>
                     {
-                        EntityFrameworkEventSource.Log.QueryExecuting();
+#pragma warning disable EF1001 // Internal EF Core API usage.
+                        EntityFrameworkMetricsData.ReportQueryExecuting();
+#pragma warning restore EF1001 // Internal EF Core API usage.
 
                         var relationalCommand = state.relationalCommandCache.RentAndPopulateRelationalCommand(state.relationalQueryContext);
 

diff --git a/src/EFCore/ChangeTracking/Internal/StateManager.cs b/src/EFCore/ChangeTracking/Internal/StateManager.cs
@@ -1,6 +1,7 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
+using Microsoft.EntityFrameworkCore.Infrastructure.Internal;
 using Microsoft.EntityFrameworkCore.Internal;
 using Microsoft.EntityFrameworkCore.Metadata.Internal;
 
@@ -1282,7 +1283,7 @@ protected virtual int SaveChanges(IList<IUpdateEntry> entriesToSave)
 
         try
         {
-            EntityFrameworkEventSource.Log.SavingChanges();
+            EntityFrameworkMetricsData.ReportSavingChanges();
 
             return _database.SaveChanges(entriesToSave);
         }
@@ -1306,7 +1307,7 @@ protected virtual int SaveChanges(IList<IUpdateEntry> entriesToSave)
 
         try
         {
-            EntityFrameworkEventSource.Log.SavingChanges();
+            EntityFrameworkMetricsData.ReportSavingChanges();
 
             return await _database.SaveChangesAsync(entriesToSave, cancellationToken)
                 .ConfigureAwait(false);

diff --git a/src/EFCore/DbContext.cs b/src/EFCore/DbContext.cs
@@ -6,6 +6,7 @@
 using System.Runtime.CompilerServices;
 using Microsoft.EntityFrameworkCore.ChangeTracking;
 using Microsoft.EntityFrameworkCore.ChangeTracking.Internal;
+using Microsoft.EntityFrameworkCore.Infrastructure.Internal;
 using Microsoft.EntityFrameworkCore.Internal;
 using Microsoft.EntityFrameworkCore.Metadata.Internal;
 
@@ -130,7 +131,7 @@ public DbContext(DbContextOptions options)
             .GetRequiredService<IDbSetInitializer>()
             .InitializeSets(this);
 
-        EntityFrameworkEventSource.Log.DbContextInitializing();
+        EntityFrameworkMetricsData.ReportDbContextInitializing();
     }
 
     /// <summary>
@@ -659,7 +660,7 @@ public virtual int SaveChanges(bool acceptAllChangesOnSuccess)
         }
         catch (DbUpdateConcurrencyException exception)
         {
-            EntityFrameworkEventSource.Log.OptimisticConcurrencyFailure();
+            EntityFrameworkMetricsData.ReportOptimisticConcurrencyFailure();
 
             SaveChangesFailed?.Invoke(this, new SaveChangesFailedEventArgs(acceptAllChangesOnSuccess, exception));
 
@@ -804,7 +805,7 @@ public virtual Task<int> SaveChangesAsync(CancellationToken cancellationToken =
         }
         catch (DbUpdateConcurrencyException exception)
         {
-            EntityFrameworkEventSource.Log.OptimisticConcurrencyFailure();
+            EntityFrameworkMetricsData.ReportOptimisticConcurrencyFailure();
 
             SaveChangesFailed?.Invoke(this, new SaveChangesFailedEventArgs(acceptAllChangesOnSuccess, exception));
 
@@ -1119,7 +1120,7 @@ private bool DisposeSync(bool leaseActive, bool contextShouldBeDisposed)
         }
         else if (!_disposed)
         {
-            EntityFrameworkEventSource.Log.DbContextDisposing();
+            EntityFrameworkMetricsData.ReportDbContextDisposing();
 
             _dbContextDependencies?.InfrastructureLogger.ContextDisposed(this);
 

diff --git a/src/EFCore/EFCore.csproj b/src/EFCore/EFCore.csproj
@@ -46,6 +46,7 @@ Microsoft.EntityFrameworkCore.DbSet
   <ItemGroup>
     <PackageReference Include="Microsoft.Extensions.Caching.Memory" Version="$(MicrosoftExtensionsCachingMemoryVersion)" />
     <PackageReference Include="Microsoft.Extensions.Logging" Version="$(MicrosoftExtensionsLoggingVersion)" />
+    <PackageReference Include="OpenTelemetry" Version="1.8.1" />
   </ItemGroup>
 
   <ItemGroup>

diff --git a/...EFCore/Infrastructure/EntityFrameworkCoreInstrumentationMeterProviderBuilderExtensions.cs b/...EFCore/Infrastructure/EntityFrameworkCoreInstrumentationMeterProviderBuilderExtensions.cs
@@ -0,0 +1,21 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using OpenTelemetry.Metrics;
+
+namespace Microsoft.EntityFrameworkCore.Infrastructure;
+
+/// <summary>
+/// Extension methods to simplify registering of Entity Framework Core instrumentation.
+/// </summary>
+public static class EntityFrameworkCoreInstrumentationMeterProviderBuilderExtensions
+{
+    /// <summary>
+    /// Enables the automatic data collection for Entity Framework Core.
+    /// </summary>
+    /// <param name="builder"><see cref="MeterProviderBuilder"/> being configured.</param>
+    /// <returns>The instance of <see cref="MeterProviderBuilder"/> to chain the calls.</returns>
+    public static MeterProviderBuilder AddEntityFrameworkCoreInstrumentation(this MeterProviderBuilder builder)
+        => builder
+            .AddMeter(EntityFrameworkMetrics.MeterName);
+}