Added sample apps and updated readme/deps

niemyjski · niemyjski · commit 477b328a7ec8 · 2020-12-09T09:04:49.000-06:00
diff --git a/.gitignore b/.gitignore
@@ -234,3 +234,6 @@ _Pvt_Extensions
 
 # FAKE - F# Make
 .fake/
+.idea/
+.DS_Store
+*.DotSettings
diff --git a/README.md b/README.md
@@ -2,25 +2,36 @@
 
 [![Build status](https://ci.appveyor.com/api/projects/status/bvmfe8muijhgkb9j?svg=true)](https://ci.appveyor.com/project/serilog/serilog-sinks-exceptionless)
 
-Serilog sink to publish to Exceptionless
 
-```
-PM> Install-Package Serilog.Sinks.Exceptionless
+### Getting started
+
+To use the Exceptionless sink, first install the [NuGet package](https://www.nuget.org/packages/Serilog.Sinks.Exceptionless/):
+
+```powershell
+Install-Package Serilog.Sinks.Exceptionless
 ``` 
 
-Read the Exceptionless configuration
+Next, we need to ensure that Exceptionless is configured with an API Key. If you are
+already using Exceptionless you can skip this step.
+
+The Exceptionless sink will use the default `ExceptionlessClient` client instance. This ensures
+that all of your Exceptionless configuration is shared with the sink and also enables logging
+of unhandled exceptions to Exceptionless. 
+
+> For advanced users who wish to configure the sink to use custom `ExceptionlessClient` instance 
+> you can provide an API Key or `ExceptionlessClient` instance to `WriteTo.Exceptionless()`.
+
 ```csharp
 using Exceptionless;
-Exceptionless.ExceptionlessClient.Default.Startup();
+ExceptionlessClient.Default.Startup("API_KEY");
 ```
 
+Next, enable the sink using `WriteTo.Exceptionless()`
+
 ```csharp
 Log.Logger = new LoggerConfiguration()
-    .WriteTo.Exceptionless(b => b.AddTags("ASP.NET Core Example Logger"))
+    .WriteTo.Exceptionless(b => b.AddTags("Serilog Example"))
     .CreateLogger();
-
-var log = Log.ForContext<HomeController>();
-log.Information("Info Log that also contains HttpContext request info and default tags");
 ```
 
 * [Documentation](https://github.com/serilog/serilog/wiki)
diff --git a/Serilog.Sinks.Exceptionless.sln b/Serilog.Sinks.Exceptionless.sln
@@ -15,6 +15,12 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "assets", "assets", "{E9D1B5
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Serilog.Sinks.Exceptionless", "src\Serilog.Sinks.Exceptionless\Serilog.Sinks.Exceptionless.csproj", "{E85ABEC7-9B4C-432C-9A04-AC5BE9205D9F}"
 EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "sample", "sample", "{C63B899E-A823-48E4-B29D-A26014911A9D}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ConsoleDemo", "sample\ConsoleDemo\ConsoleDemo.csproj", "{411E131D-34F5-4B51-A217-B4FD6E2E01B4}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "SampleWeb", "sample\SampleWeb\SampleWeb.csproj", "{2637C70D-5166-473F-91FD-C5312310466D}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -25,11 +31,21 @@ Global
 		{E85ABEC7-9B4C-432C-9A04-AC5BE9205D9F}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{E85ABEC7-9B4C-432C-9A04-AC5BE9205D9F}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{E85ABEC7-9B4C-432C-9A04-AC5BE9205D9F}.Release|Any CPU.Build.0 = Release|Any CPU
+		{411E131D-34F5-4B51-A217-B4FD6E2E01B4}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{411E131D-34F5-4B51-A217-B4FD6E2E01B4}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{411E131D-34F5-4B51-A217-B4FD6E2E01B4}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{411E131D-34F5-4B51-A217-B4FD6E2E01B4}.Release|Any CPU.Build.0 = Release|Any CPU
+		{2637C70D-5166-473F-91FD-C5312310466D}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{2637C70D-5166-473F-91FD-C5312310466D}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{2637C70D-5166-473F-91FD-C5312310466D}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{2637C70D-5166-473F-91FD-C5312310466D}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
 	EndGlobalSection
 	GlobalSection(NestedProjects) = preSolution
 		{E85ABEC7-9B4C-432C-9A04-AC5BE9205D9F} = {037440DE-440B-4129-9F7A-09B42D00397E}
+		{411E131D-34F5-4B51-A217-B4FD6E2E01B4} = {C63B899E-A823-48E4-B29D-A26014911A9D}
+		{2637C70D-5166-473F-91FD-C5312310466D} = {C63B899E-A823-48E4-B29D-A26014911A9D}
 	EndGlobalSection
 EndGlobal
diff --git a/sample/ConsoleDemo/ConsoleDemo.csproj b/sample/ConsoleDemo/ConsoleDemo.csproj
@@ -0,0 +1,12 @@
+<Project Sdk="Microsoft.NET.Sdk">
+    <PropertyGroup>
+        <OutputType>Exe</OutputType>
+        <TargetFrameworks>net452;net50</TargetFrameworks>
+    </PropertyGroup>
+    <ItemGroup>
+      <ProjectReference Include="..\..\src\Serilog.Sinks.Exceptionless\Serilog.Sinks.Exceptionless.csproj" />
+    </ItemGroup>
+    <ItemGroup>
+      <PackageReference Include="Serilog.Sinks.Console" Version="3.1.1" />
+    </ItemGroup>
+</Project>
diff --git a/sample/ConsoleDemo/Program.cs b/sample/ConsoleDemo/Program.cs
@@ -0,0 +1,42 @@
+﻿using Serilog;
+using System;
+using System.Threading;
+using Exceptionless;
+using Serilog.Sinks.SystemConsole.Themes;
+
+namespace ConsoleDemo
+{
+    public class Program
+    {
+        public static void Main()
+        {
+            ExceptionlessClient.Default.Startup("API_KEY");
+            
+            Log.Logger = new LoggerConfiguration()
+                .MinimumLevel.Verbose()
+                .WriteTo.Console(theme: AnsiConsoleTheme.Code)
+                .WriteTo.Exceptionless(c => c.AddTags("Serilog Sample"))
+                .CreateLogger();
+
+            try
+            {
+                Log.Debug("Getting started");
+                Log.Information("Hello {Name} from thread {ThreadId}", Environment.GetEnvironmentVariable("USERNAME"), Thread.CurrentThread.ManagedThreadId);
+                Log.Warning("No coins remain at position {@Position}", new { Lat = 25, Long = 134 });
+
+                Fail();
+            }
+            catch (Exception ex)
+            {
+                Log.Error(ex, "Something went wrong");
+            }
+
+            Log.CloseAndFlush();
+        }
+
+        private static void Fail()
+        {
+            throw new DivideByZeroException();
+        }
+    }
+}
diff --git a/sample/SampleWeb/Authentication/TestAuthenticationHandler.cs b/sample/SampleWeb/Authentication/TestAuthenticationHandler.cs
@@ -0,0 +1,32 @@
+using System;
+using System.Security.Claims;
+using System.Text.Encodings.Web;
+using System.Threading.Tasks;
+using Microsoft.AspNetCore.Authentication;
+using Microsoft.Extensions.Logging;
+using Microsoft.Extensions.Options;
+
+namespace SampleWeb.Authentication
+{
+    public class TestAuthenticationHandler : AuthenticationHandler<AuthenticationSchemeOptions>
+    {
+        public TestAuthenticationHandler(IOptionsMonitor<AuthenticationSchemeOptions> options,
+            ILoggerFactory logger, UrlEncoder encoder, ISystemClock clock)
+            : base(options, logger, encoder, clock)
+        {
+        }
+
+        protected override Task<AuthenticateResult> HandleAuthenticateAsync()
+        {
+            var claims = new[]
+            {
+                new Claim(ClaimTypes.Name, "Test user"),
+                new Claim(ClaimTypes.NameIdentifier, Guid.NewGuid().ToString())
+            };
+            var identity = new ClaimsIdentity(claims, "Test");
+            var principal = new ClaimsPrincipal(identity);
+            var ticket = new AuthenticationTicket(principal, "Test");
+            return Task.FromResult(AuthenticateResult.Success(ticket));
+        }
+    }
+}
diff --git a/sample/SampleWeb/Controllers/ValuesController.cs b/sample/SampleWeb/Controllers/ValuesController.cs
@@ -0,0 +1,25 @@
+﻿using System.Diagnostics;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.Extensions.Logging;
+
+namespace SampleWeb.Controllers
+{
+    [ApiController]
+    [Route("[controller]")]
+    public class ValuesController : ControllerBase
+    {
+        private readonly ILogger<ValuesController> _logger;
+        
+        public ValuesController(ILogger<ValuesController> logger)
+        {
+            _logger = logger;
+        }
+
+        [HttpGet]
+        public string Get()
+        {
+            _logger.LogInformation("Get was called");
+            return $"[{Activity.Current?.Id}] {User.Identity?.Name}";
+        }
+    }
+}
diff --git a/sample/SampleWeb/Program.cs b/sample/SampleWeb/Program.cs
@@ -0,0 +1,33 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Threading.Tasks;
+using Microsoft.AspNetCore.Hosting;
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.Hosting;
+using Microsoft.Extensions.Logging;
+using Serilog;
+
+namespace SampleWeb
+{
+    public class Program
+    {
+        public static void Main(string[] args)
+        {
+            CreateHostBuilder(args).Build().Run();
+        }
+
+        public static IHostBuilder CreateHostBuilder(string[] args)
+        {
+            return Host.CreateDefaultBuilder(args)
+                .ConfigureWebHostDefaults(webBuilder => webBuilder.UseStartup<Startup>())
+                .UseSerilog((hostingContext, services, loggerConfiguration) => loggerConfiguration
+                    .ReadFrom.Configuration(hostingContext.Configuration)
+                    .Enrich.FromLogContext()
+                    .WriteTo.Debug()
+                    .WriteTo.Console()
+                    .WriteTo.Exceptionless()
+                );
+        }
+    }
+}
diff --git a/sample/SampleWeb/Properties/launchSettings.json b/sample/SampleWeb/Properties/launchSettings.json
@@ -0,0 +1,31 @@
+﻿{
+  "$schema": "http://json.schemastore.org/launchsettings.json",
+  "iisSettings": {
+    "windowsAuthentication": false,
+    "anonymousAuthentication": true,
+    "iisExpress": {
+      "applicationUrl": "http://localhost:59081",
+      "sslPort": 44340
+    }
+  },
+  "profiles": {
+    "IIS Express": {
+      "commandName": "IISExpress",
+      "launchBrowser": true,
+      "launchUrl": "values",
+      "environmentVariables": {
+        "ASPNETCORE_ENVIRONMENT": "Development"
+      }
+    },
+    "SampleWeb": {
+      "commandName": "Project",
+      "dotnetRunMessages": "true",
+      "launchBrowser": true,
+      "launchUrl": "values",
+      "applicationUrl": "https://localhost:5001;http://localhost:5000",
+      "environmentVariables": {
+        "ASPNETCORE_ENVIRONMENT": "Development"
+      }
+    }
+  }
+}
diff --git a/sample/SampleWeb/SampleWeb.csproj b/sample/SampleWeb/SampleWeb.csproj
@@ -0,0 +1,14 @@
+<Project Sdk="Microsoft.NET.Sdk.Web">
+    <PropertyGroup>
+        <TargetFramework>net5.0</TargetFramework>
+    </PropertyGroup>
+    
+    <ItemGroup>
+        <PackageReference Include="Exceptionless.AspNetCore" Version="4.5.0" />
+        <PackageReference Include="Serilog.AspNetCore" Version="3.4.0" />
+    </ItemGroup>
+    
+    <ItemGroup>
+      <ProjectReference Include="..\..\src\Serilog.Sinks.Exceptionless\Serilog.Sinks.Exceptionless.csproj" />
+    </ItemGroup>
+</Project>
diff --git a/sample/SampleWeb/Startup.cs b/sample/SampleWeb/Startup.cs
@@ -0,0 +1,46 @@
+using Exceptionless;
+using Microsoft.AspNetCore.Authentication;
+using Microsoft.AspNetCore.Builder;
+using Microsoft.AspNetCore.Hosting;
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Hosting;
+using SampleWeb.Authentication;
+using Serilog;
+
+namespace SampleWeb
+{
+    public class Startup
+    {
+        public Startup(IConfiguration configuration)
+        {
+            Configuration = configuration;
+        }
+
+        public IConfiguration Configuration { get; }
+
+        // This method gets called by the runtime. Use this method to add services to the container.
+        public void ConfigureServices(IServiceCollection services)
+        {
+            services.AddAuthentication("Test").AddScheme<AuthenticationSchemeOptions, TestAuthenticationHandler>("Test", options => {});
+            services.AddAuthorization();
+            services.AddControllers();
+            services.AddHttpContextAccessor();
+        }
+
+        // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
+        public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
+        {
+            if (env.IsDevelopment())
+                app.UseDeveloperExceptionPage();
+
+            app.UseExceptionless("API_KEY");
+            app.UseSerilogRequestLogging();
+            app.UseHttpsRedirection();
+            app.UseRouting();
+            app.UseAuthentication();
+            app.UseAuthorization();
+            app.UseEndpoints(endpoints => { endpoints.MapControllers(); });
+        }
+    }
+}
diff --git a/sample/SampleWeb/appsettings.Development.json b/sample/SampleWeb/appsettings.Development.json
@@ -0,0 +1,7 @@
+{
+    "Serilog": {
+        "MinimumLevel": {
+            "Default": "Debug"
+        }
+    }
+}
diff --git a/sample/SampleWeb/appsettings.json b/sample/SampleWeb/appsettings.json
@@ -0,0 +1,13 @@
+{
+    "Serilog": {
+        "MinimumLevel": {
+            "Default": "Information",
+            "Override": {
+                "Microsoft": "Warning",
+                "System": "Warning"
+                "SampleWeb.Authentication.TestAuthenticationHandler": "Warning"
+            }
+        }
+    },
+    "AllowedHosts": "*"
+}
diff --git a/src/Serilog.Sinks.Exceptionless/LoggerSinkConfigurationExtensions.cs b/src/Serilog.Sinks.Exceptionless/LoggerSinkConfigurationExtensions.cs
@@ -11,6 +11,30 @@ namespace Serilog
     /// </summary>
     public static class LoggerSinkConfigurationExtensions
     {
+        /// <summary>Creates a new Exceptionless sink with the specified <paramref name="apiKey"/>.</summary>
+        /// <param name="loggerConfiguration">The logger configuration.</param>
+        /// <param name="apiKey">The API key that will be used when sending events to the server.</param>
+        /// <param name="additionalOperation">Any additional operation to run against the build exceptions</param>
+        /// <param name="includeProperties">If false it suppressed sending the Serilog properties to Exceptionless</param>
+        /// <param name="restrictedToMinimumLevel">The minimum log event level required in order to write an event to the sink.</param>
+        /// <returns>The <see cref="LoggerConfiguration"/>.</returns>
+        /// <exception cref="ArgumentNullException"></exception>
+        public static LoggerConfiguration Exceptionless(
+            this LoggerSinkConfiguration loggerConfiguration,
+            string apiKey,
+            Func<EventBuilder, EventBuilder> additionalOperation = null,
+            bool includeProperties = true,
+            LogEventLevel restrictedToMinimumLevel = LevelAlias.Minimum
+        )
+        {
+            if (loggerConfiguration == null)
+                throw new ArgumentNullException(nameof(loggerConfiguration));
+            if (apiKey == null)
+                throw new ArgumentNullException(nameof(apiKey));
+
+            return loggerConfiguration.Sink(new ExceptionlessSink(apiKey, null, additionalOperation, includeProperties), restrictedToMinimumLevel);
+        }
+        
         /// <summary>Creates a new Exceptionless sink with the specified <paramref name="apiKey"/>.</summary>
         /// <param name="loggerConfiguration">The logger configuration.</param>
         /// <param name="apiKey">The API key that will be used when sending events to the server.</param>
diff --git a/src/Serilog.Sinks.Exceptionless/Serilog.Sinks.Exceptionless.csproj b/src/Serilog.Sinks.Exceptionless/Serilog.Sinks.Exceptionless.csproj
