Sentry.EntityFramework monorepo

.craft.yml

@@ -30,6 +30,10 @@ targets:
     type: sdk
     config:
       canonical: "nuget:Sentry.AspNet"
+  - name: registry
+    type: sdk
+    config:
+      canonical: "nuget:Sentry.EntityFramework"
   - name: registry
     type: sdk
     config:

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## Unreleased
 
+### Features
+
+- Sentry.EntityFramework moved to this repository ([#1017](https://github.com/getsentry/sentry-dotnet/pull/1017))
+  - Additional `netstandard2.1` target added. Sample with .NET Core 3.1 console app.
+  - `UseBreadcrumbs` is called automatically by `AddEntityFramework`
+
 ### Fixes
 
 - normalize line breaks ([#1016](https://github.com/getsentry/sentry-dotnet/pull/1016))

README.md

@@ -22,6 +22,7 @@ Sentry SDK for .NET
 |     **Sentry.AspNetCore**     | [![Downloads](https://img.shields.io/nuget/dt/Sentry.AspNetCore.svg)](https://www.nuget.org/packages/Sentry.AspNetCore) | [![NuGet](https://img.shields.io/nuget/v/Sentry.AspNetCore.svg)](https://www.nuget.org/packages/Sentry.AspNetCore)   |   [![NuGet](https://img.shields.io/nuget/vpre/Sentry.AspNetCore.svg)](https://www.nuget.org/packages/Sentry.AspNetCore)   | [![Documentation](https://img.shields.io/badge/documentation-sentry.io-green.svg)](https://docs.sentry.io/platforms/dotnet/guides/aspnetcore/) |
 |     **Sentry.AspNetCore.Grpc**     | [![Downloads](https://img.shields.io/nuget/dt/Sentry.AspNetCore.Grpc.svg)](https://www.nuget.org/packages/Sentry.AspNetCore.Grpc) | [![NuGet](https://img.shields.io/nuget/v/Sentry.AspNetCore.Grpc.svg)](https://www.nuget.org/packages/Sentry.AspNetCore.Grpc)   |   [![NuGet](https://img.shields.io/nuget/vpre/Sentry.AspNetCore.Grpc.svg)](https://www.nuget.org/packages/Sentry.AspNetCore.Grpc)   | [![Documentation](https://img.shields.io/badge/documentation-sentry.io-green.svg)](https://docs.sentry.io/platforms/dotnet/guides/aspnetcore/) |
 |     **Sentry.AspNet**     | [![Downloads](https://img.shields.io/nuget/dt/Sentry.AspNet.svg)](https://www.nuget.org/packages/Sentry.AspNet) | [![NuGet](https://img.shields.io/nuget/v/Sentry.AspNet.svg)](https://www.nuget.org/packages/Sentry.AspNet)   |   [![NuGet](https://img.shields.io/nuget/vpre/Sentry.AspNet.svg)](https://www.nuget.org/packages/Sentry.AspNet)   | [![Documentation](https://img.shields.io/badge/documentation-sentry.io-green.svg)](https://docs.sentry.io/platforms/dotnet/guides/aspnet) |
+|     **Sentry.EntityFramework**     | [![Downloads](https://img.shields.io/nuget/dt/Sentry.EntityFramework.svg)](https://www.nuget.org/packages/Sentry.EntityFramework) | [![NuGet](https://img.shields.io/nuget/v/Sentry.EntityFramework.svg)](https://www.nuget.org/packages/Sentry.EntityFramework)   |   [![NuGet](https://img.shields.io/nuget/vpre/Sentry.EntityFramework.svg)](https://www.nuget.org/packages/Sentry.EntityFramework)   | [![Documentation](https://img.shields.io/badge/documentation-sentry.io-green.svg)](https://docs.sentry.io/platforms/dotnet/guides/entityframework) |
 | **Sentry.Serilog**            | [![Downloads](https://img.shields.io/nuget/dt/Sentry.Serilog.svg)](https://www.nuget.org/packages/Serilog) | [![NuGet](https://img.shields.io/nuget/v/Sentry.Serilog.svg)](https://www.nuget.org/packages/Sentry.Serilog)   | [![NuGet](https://img.shields.io/nuget/vpre/Sentry.Serilog.svg)](https://www.nuget.org/packages/Sentry.Serilog)   | [![Documentation](https://img.shields.io/badge/documentation-sentry.io-green.svg)](https://docs.sentry.io/platforms/dotnet/guides/serilog) |
 | **Sentry.Log4Net**            | [![Downloads](https://img.shields.io/nuget/dt/Sentry.Log4Net.svg)](https://www.nuget.org/packages/Sentry.Log4Net) | [![NuGet](https://img.shields.io/nuget/v/Sentry.Log4Net.svg)](https://www.nuget.org/packages/Sentry.Log4Net)   | [![NuGet](https://img.shields.io/nuget/vpre/Sentry.Log4Net.svg)](https://www.nuget.org/packages/Sentry.Log4Net)   | [![Documentation](https://img.shields.io/badge/documentation-sentry.io-green.svg)](https://docs.sentry.io/platforms/dotnet/guides/log4net) |
 | **Sentry.NLog**               | [![Downloads](https://img.shields.io/nuget/dt/Sentry.NLog.svg)](https://www.nuget.org/packages/Sentry.NLog) | [![NuGet](https://img.shields.io/nuget/v/Sentry.NLog.svg)](https://www.nuget.org/packages/Sentry.NLog)   | [![NuGet](https://img.shields.io/nuget/vpre/Sentry.NLog.svg)](https://www.nuget.org/packages/Sentry.NLog)   | [![Documentation](https://img.shields.io/badge/documentation-sentry.io-green.svg)](https://docs.sentry.io/platforms/dotnet/guides/nlog) |
@@ -30,7 +31,6 @@ Sentry SDK for .NET
 
 Sentry offers other integrations that are not part of this repository:
 
-* [Sentry.EntityFramework](https://github.com/getsentry/sentry-dotnet-ef): EF 6 for validation errors and query as breadcrumbs.
 * [Sentry.Minidump](https://github.com/getsentry/sentry-dotnet-minidump): Capture Minidumps on Windows, macOS and Linux.
 * [Sentry.Xamarin](https://github.com/getsentry/sentry-xamarin): `Xamarin` native and `Xamarin.Forms` integration to get device data, breadcrumbs, and more.
 

Sentry.sln

@@ -119,6 +119,12 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Sentry.Samples.AspNetCore.B
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Sentry.Samples.Aws.Lambda.AspNetCoreServer", "samples\Sentry.Samples.Aws.Lambda.AspNetCoreServer\Sentry.Samples.Aws.Lambda.AspNetCoreServer.csproj", "{274CEDC2-2129-469D-B269-649EFA2EF5E0}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Sentry.EntityFramework", "src\Sentry.EntityFramework\Sentry.EntityFramework.csproj", "{8B38F62E-0DD5-486F-96F5-2025AFB9B491}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Sentry.EntityFramework.Tests", "test\Sentry.EntityFramework.Tests\Sentry.EntityFramework.Tests.csproj", "{840B220E-68EC-4ECB-AEA1-67B0151F17FC}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Sentry.Samples.EntityFramework", "samples\Sentry.Samples.EntityFramework\Sentry.Samples.EntityFramework.csproj", "{8E4BA4C7-413C-4668-8F41-32F484FFB7AA}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -253,6 +259,18 @@ Global
 		{274CEDC2-2129-469D-B269-649EFA2EF5E0}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{274CEDC2-2129-469D-B269-649EFA2EF5E0}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{274CEDC2-2129-469D-B269-649EFA2EF5E0}.Release|Any CPU.Build.0 = Release|Any CPU
+		{8B38F62E-0DD5-486F-96F5-2025AFB9B491}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{8B38F62E-0DD5-486F-96F5-2025AFB9B491}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{8B38F62E-0DD5-486F-96F5-2025AFB9B491}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{8B38F62E-0DD5-486F-96F5-2025AFB9B491}.Release|Any CPU.Build.0 = Release|Any CPU
+		{840B220E-68EC-4ECB-AEA1-67B0151F17FC}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{840B220E-68EC-4ECB-AEA1-67B0151F17FC}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{840B220E-68EC-4ECB-AEA1-67B0151F17FC}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{840B220E-68EC-4ECB-AEA1-67B0151F17FC}.Release|Any CPU.Build.0 = Release|Any CPU
+		{8E4BA4C7-413C-4668-8F41-32F484FFB7AA}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{8E4BA4C7-413C-4668-8F41-32F484FFB7AA}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{8E4BA4C7-413C-4668-8F41-32F484FFB7AA}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{8E4BA4C7-413C-4668-8F41-32F484FFB7AA}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -293,6 +311,9 @@ Global
 		{21599C29-C3D4-4DAC-A2D6-6C194600478F} = {77454495-55EE-4B40-A089-71B9E8F82E89}
 		{73FDCE53-75D1-4DCC-933A-8AB93A0E86EA} = {77454495-55EE-4B40-A089-71B9E8F82E89}
 		{274CEDC2-2129-469D-B269-649EFA2EF5E0} = {77454495-55EE-4B40-A089-71B9E8F82E89}
+		{8B38F62E-0DD5-486F-96F5-2025AFB9B491} = {AF6AF4C7-8AA2-4D59-8064-2D79560904EB}
+		{840B220E-68EC-4ECB-AEA1-67B0151F17FC} = {83263231-1A2A-4733-B759-EEFF14E8C5D5}
+		{8E4BA4C7-413C-4668-8F41-32F484FFB7AA} = {77454495-55EE-4B40-A089-71B9E8F82E89}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {0C652B1A-DF72-4EE5-A98B-194FE2C054F6}

samples/Sentry.Samples.EntityFramework/Program.cs

@@ -0,0 +1,40 @@
+using System.ComponentModel.DataAnnotations;
+using System.Configuration;
+using System.Data.Common;
+using System.Data.Entity;
+using Sentry;
+using Sentry.EntityFramework;
+
+var _ = SentrySdk.Init(o =>
+{
+    o.Debug = true; // To see SDK logs on the console
+    o.Dsn = "https://eb18e953812b41c3aeb042e666fd3b5c@o447951.ingest.sentry.io/5428537";
+    // Add the EntityFramework integration to the SentryOptions of your app startup code:
+    o.AddEntityFramework();
+});
+
+var dbConnection = Effort.DbConnectionFactory.CreateTransient();
+using var db = new SampleDbContext(dbConnection, true);
+
+var user = new SampleUser();
+db.Users.Add(user);
+
+// This will throw a DbEntityValidationException and crash the app
+// But Sentry will capture the error.
+db.SaveChanges();
+
+public class SampleUser
+{
+    [Key]
+    public int Id { get; set; }
+    [Required]
+    public string RequiredColumn { get; set; }
+}
+
+public class SampleDbContext : DbContext
+{
+    public DbSet<SampleUser> Users { get; set; }
+    public SampleDbContext(DbConnection connection, bool ownsConnection)
+        : base(connection, ownsConnection)
+    { }
+}

samples/Sentry.Samples.EntityFramework/README.md

@@ -0,0 +1,10 @@
+# Entity Framework 6 sample
+
+If you're using Entity Framework Core, you don't need the package used in this sample.
+Sentry can integrate with EF Core through `Sentry.Extensions.Logging` already.
+Sentry.EntityFramework` is used to integrated with EF 6 only.
+
+![Crash in Sentry](crash.png)
+
+Breadcrumbs for different EF core events:
+![Example in Sentry](ef.png)

samples/Sentry.Samples.EntityFramework/Sentry.Samples.EntityFramework.csproj

@@ -0,0 +1,14 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFramework>netcoreapp3.1</TargetFramework>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Effort.EF6" Version="2.2.13" />
+    <ProjectReference Include="../../src/Sentry.EntityFramework/Sentry.EntityFramework.csproj" />
+    <ProjectReference Include="../../src/Sentry/Sentry.csproj" />
+  </ItemGroup>
+
+</Project>

src/Sentry.EntityFramework/ErrorProcessors/DbConcurrencyExceptionProcessor.cs

@@ -0,0 +1,20 @@
+using System.Data;
+using Sentry.Extensibility;
+
+namespace Sentry.EntityFramework.ErrorProcessors
+{
+    /// <summary>
+    /// Exception processor for Entity Framework <see cref="DBConcurrencyException"/>.
+    /// </summary>
+    public class DbConcurrencyExceptionProcessor : SentryEventExceptionProcessor<DBConcurrencyException>
+    {
+        /// <summary>
+        /// Extracts RowCount and RowError from <see cref="DBConcurrencyException"/>.
+        /// </summary>
+        protected override void ProcessException(DBConcurrencyException exception, SentryEvent sentryEvent)
+        {
+            sentryEvent.SetExtra("Row Count", exception.RowCount);
+            sentryEvent.SetExtra("Row Error", exception.Row.RowError);
+        }
+    }
+}

src/Sentry.EntityFramework/ErrorProcessors/DbEntityValidationExceptionProcessor.cs

@@ -0,0 +1,37 @@
+using System.Collections.Generic;
+using System.Data.Entity.Validation;
+using System.Linq;
+using Sentry.Extensibility;
+
+namespace Sentry.EntityFramework.ErrorProcessors
+{
+    /// <summary>
+    /// Exception processor for <see cref="DbEntityValidationException"/>.
+    /// </summary>
+    public class DbEntityValidationExceptionProcessor : SentryEventExceptionProcessor<DbEntityValidationException>
+    {
+        internal const string EntityValidationErrors = "EntityValidationErrors";
+
+        /// <summary>
+        /// Extracts details from <see cref="DbEntityValidationException"/> into the <see cref="SentryEvent"/>.
+        /// </summary>
+        protected override void ProcessException(DbEntityValidationException exception, SentryEvent sentryEvent)
+        {
+            var errorList = new Dictionary<string, List<string>>();
+            foreach (var error in exception.EntityValidationErrors.SelectMany(x=>x.ValidationErrors))
+            {
+                if (errorList.TryGetValue(error.PropertyName, out var list))
+                {
+                    list.Add(error.ErrorMessage);
+                }
+                else
+                {
+                    list = new List<string> { error.ErrorMessage };
+                    errorList.Add(error.PropertyName, list);
+                }
+            }
+
+            sentryEvent.SetExtra(EntityValidationErrors, errorList);
+        }
+    }
+}

src/Sentry.EntityFramework/IQueryLogger.cs

@@ -0,0 +1,15 @@
+namespace Sentry.EntityFramework
+{
+    /// <summary>
+    /// A query logger interface.
+    /// </summary>
+    public interface IQueryLogger
+    {
+        /// <summary>
+        /// Logs a query with a related level.
+        /// </summary>
+        /// <param name="text">The query text.</param>
+        /// <param name="level">The level.</param>
+        void Log(string text, BreadcrumbLevel level = BreadcrumbLevel.Debug);
+    }
+}

src/Sentry.EntityFramework/Properties/AssemblyInfo.cs

@@ -0,0 +1,3 @@
+using System.Runtime.CompilerServices;
+
+[assembly: InternalsVisibleTo("Sentry.EntityFramework.Tests, PublicKey=002400000480000094000000060200000024000052534131000400000100010059964a931488bcdbd14657f1ee0df32df61b57b3d14d7290c262c2cc9ddaad6ec984044f761f778e1823049d2cb996a4f58c8ea5b46c37891414cb34b4036b1c178d7b582289d2eef3c0f1e9b692c229a306831ee3d371d9e883f0eb0f74aeac6c6ab8c85fd1ec04b267e15a31532c4b4e2191f5980459db4dce0081f1050fb8")]

src/Sentry.EntityFramework/Sentry.EntityFramework.csproj

@@ -0,0 +1,24 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFrameworks>net461;netstandard2.1</TargetFrameworks>
+    <PackageId>Sentry.EntityFramework</PackageId>
+    <AssemblyName>Sentry.EntityFramework</AssemblyName>
+    <RootNamespace>Sentry.EntityFramework</RootNamespace>
+    <Description>Official Entity Framework 6 integration for Sentry - Open-source error tracking that helps developers monitor and fix crashes in real time.</Description>
+    <PackageTags>$(PackageTags);EntityFramework;EF;EF6</PackageTags>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\Sentry\Sentry.csproj" />
+  </ItemGroup>
+
+  <ItemGroup Condition="'$(TargetFramework)' == 'net461'">
+    <PackageReference Include="EntityFramework" Version="6.0.0" />
+  </ItemGroup>
+
+  <ItemGroup Condition="'$(TargetFramework)' == 'netstandard2.1'">
+    <PackageReference Include="EntityFramework" Version="6.3.0" />
+  </ItemGroup>
+
+</Project>

src/Sentry.EntityFramework/SentryCommandInterceptor.cs

@@ -0,0 +1,67 @@
+using System.Data.Common;
+using System.Data.Entity.Infrastructure.Interception;
+
+namespace Sentry.EntityFramework
+{
+    /// <summary>
+    /// A command interceptor to augment data for Sentry.
+    /// </summary>
+    public class SentryCommandInterceptor : IDbCommandInterceptor
+    {
+        private readonly IQueryLogger _queryLogger;
+
+        /// <summary>
+        /// Creates a new instance of <see cref="SentryCommandInterceptor"/>.
+        /// </summary>
+        /// <param name="queryLogger"></param>
+        public SentryCommandInterceptor(IQueryLogger queryLogger) => _queryLogger = queryLogger;
+
+        /// <summary>
+        /// Logs a call to <see cref="NonQueryExecuting"/>.
+        /// </summary>
+        public void NonQueryExecuting(DbCommand command, DbCommandInterceptionContext<int> interceptionContext)
+            => Log(command, interceptionContext);
+
+        /// <summary>
+        /// No Op.
+        /// </summary>
+        public void NonQueryExecuted(DbCommand command, DbCommandInterceptionContext<int> interceptionContext) { }
+
+        /// <summary>
+        /// Logs a call to <see cref="ReaderExecuting"/>.
+        /// </summary>
+        public void ReaderExecuting(DbCommand command, DbCommandInterceptionContext<DbDataReader> interceptionContext)
+            => Log(command, interceptionContext);
+
+        /// <summary>
+        /// No Op.
+        /// </summary>
+        public void ReaderExecuted(DbCommand command, DbCommandInterceptionContext<DbDataReader> interceptionContext) { }
+
+        /// <summary>
+        /// Logs a call to <see cref="ScalarExecuting"/>.
+        /// </summary>
+        public void ScalarExecuting(DbCommand command, DbCommandInterceptionContext<object> interceptionContext)
+            => Log(command, interceptionContext);
+
+        /// <summary>
+        /// Logs a call to <see cref="ScalarExecuted"/>.
+        /// </summary>
+        public void ScalarExecuted(DbCommand command, DbCommandInterceptionContext<object> interceptionContext) { }
+
+        /// <summary>
+        /// Logs the <see cref="DbCommand"/> with the specified context.
+        /// </summary>
+        public virtual void Log<T>(DbCommand command, DbCommandInterceptionContext<T> interceptionContext)
+        {
+            if (interceptionContext.Exception != null)
+            {
+                _queryLogger.Log(command.CommandText, BreadcrumbLevel.Error);
+            }
+            else
+            {
+                _queryLogger.Log(command.CommandText);
+            }
+        }
+    }
+}

src/Sentry.EntityFramework/SentryDatabaseLogging.cs

@@ -0,0 +1,44 @@
+using System;
+using System.Data.Entity.Infrastructure.Interception;
+using System.Threading;
+using Sentry.Extensibility;
+
+namespace Sentry.EntityFramework
+{
+    /// <summary>
+    /// Sentry Database Logger
+    /// </summary>
+    public static class SentryDatabaseLogging
+    {
+        private static int Init = 0;
+
+        /// <summary>
+        /// Adds an instance of <see cref="SentryCommandInterceptor"/> to <see cref="DbInterception"/>
+        /// This is a static setup call, so make sure you only call it once for each <see cref="IQueryLogger"/> instance you want to register globally
+        /// </summary>
+        /// <param name="logger">Query Logger.</param>
+        [Obsolete("This method is called automatically by options.AddEntityFramework. This method will be removed in future versions.")]
+        public static SentryCommandInterceptor? UseBreadcrumbs(IQueryLogger? logger = null) => UseBreadcrumbs(logger);
+
+        internal static SentryCommandInterceptor? UseBreadcrumbs(
+            IQueryLogger? queryLogger = null,
+            bool initOnce = true,
+            IDiagnosticLogger? diagnosticLogger = null)
+        {
+            if (initOnce && Interlocked.Exchange(ref Init, 1) != 0)
+            {
+                diagnosticLogger?.LogWarning("{0}.{1} was already executed.",
+                    nameof(SentryDatabaseLogging), nameof(UseBreadcrumbs));
+                return null;
+            }
+
+            diagnosticLogger?.LogInfo("{0}.{1} adding interceptor.",
+                nameof(SentryDatabaseLogging), nameof(UseBreadcrumbs));
+
+            queryLogger ??= new SentryQueryLogger();
+            var interceptor = new SentryCommandInterceptor(queryLogger);
+            DbInterception.Add(interceptor);
+            return interceptor;
+        }
+    }
+}