Instrumented library and example project

Author: Bart Koelman

JsonApiDotNetCore.sln.DotSettings

@@ -620,6 +620,7 @@ $left$ = $right$;</s:String>
 	<s:String x:Key="/Default/PatternsAndTemplates/StructuralSearch/Pattern/=B3D9EE6B4EC62A4F961EB15F9ADEC2C6/ReplacePattern/@EntryValue">$collection$.IsNullOrEmpty()</s:String>
 	<s:String x:Key="/Default/PatternsAndTemplates/StructuralSearch/Pattern/=B3D9EE6B4EC62A4F961EB15F9ADEC2C6/SearchPattern/@EntryValue">$collection$ == null || !$collection$.Any()</s:String>
 	<s:String x:Key="/Default/PatternsAndTemplates/StructuralSearch/Pattern/=B3D9EE6B4EC62A4F961EB15F9ADEC2C6/Severity/@EntryValue">WARNING</s:String>
+	<s:Boolean x:Key="/Default/UserDictionary/Words/=appsettings/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Assignee/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Injectables/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=linebreaks/@EntryIndexedValue">True</s:Boolean>

src/Examples/JsonApiDotNetCoreExample/Startups/EmptyStartup.cs

@@ -1,6 +1,7 @@
 using Microsoft.AspNetCore.Builder;
 using Microsoft.AspNetCore.Hosting;
 using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Logging;
 
 namespace JsonApiDotNetCoreExample.Startups
 {
@@ -14,7 +15,7 @@ public virtual void ConfigureServices(IServiceCollection services)
         {
         }
 
-        public virtual void Configure(IApplicationBuilder app, IWebHostEnvironment environment)
+        public virtual void Configure(IApplicationBuilder app, IWebHostEnvironment environment, ILoggerFactory loggerFactory)
         {
         }
     }

src/Examples/JsonApiDotNetCoreExample/Startups/Startup.cs

@@ -1,67 +1,97 @@
 using System;
 using JsonApiDotNetCore.Configuration;
+using JsonApiDotNetCore.Diagnostics;
 using JsonApiDotNetCoreExample.Data;
 using Microsoft.AspNetCore.Authentication;
 using Microsoft.AspNetCore.Builder;
 using Microsoft.AspNetCore.Hosting;
 using Microsoft.EntityFrameworkCore;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Logging;
 using Newtonsoft.Json;
 using Newtonsoft.Json.Converters;
 
 namespace JsonApiDotNetCoreExample.Startups
 {
     public sealed class Startup : EmptyStartup
     {
+        private readonly ICodeTimerSession _codeTimingSession;
         private readonly string _connectionString;
 
         public Startup(IConfiguration configuration)
         {
+            _codeTimingSession = new DefaultCodeTimerSession();
+            CodeTimingSessionManager.Capture(_codeTimingSession);
+
             string postgresPassword = Environment.GetEnvironmentVariable("PGPASSWORD") ?? "postgres";
             _connectionString = configuration["Data:DefaultConnection"].Replace("###", postgresPassword);
         }
 
         // This method gets called by the runtime. Use this method to add services to the container.
         public override void ConfigureServices(IServiceCollection services)
         {
-            services.AddSingleton<ISystemClock, SystemClock>();
-
-            services.AddDbContext<AppDbContext>(options =>
+            using (CodeTimingSessionManager.Current.Measure("Configure other (startup)"))
             {
-                options.UseNpgsql(_connectionString);
+                services.AddSingleton<ISystemClock, SystemClock>();
+
+                services.AddDbContext<AppDbContext>(options =>
+                {
+                    options.UseNpgsql(_connectionString);
 #if DEBUG
-                options.EnableSensitiveDataLogging();
-                options.EnableDetailedErrors();
+                    options.EnableSensitiveDataLogging();
+                    options.EnableDetailedErrors();
 #endif
-            });
+                });
 
-            services.AddJsonApi<AppDbContext>(options =>
-            {
-                options.Namespace = "api/v1";
-                options.UseRelativeLinks = true;
-                options.ValidateModelState = true;
-                options.IncludeTotalResourceCount = true;
-                options.SerializerSettings.Formatting = Formatting.Indented;
-                options.SerializerSettings.Converters.Add(new StringEnumConverter());
+                using (CodeTimingSessionManager.Current.Measure("Configure JSON:API (startup)"))
+                {
+                    services.AddJsonApi<AppDbContext>(options =>
+                    {
+                        options.Namespace = "api/v1";
+                        options.UseRelativeLinks = true;
+                        options.ValidateModelState = true;
+                        options.IncludeTotalResourceCount = true;
+                        options.SerializerSettings.Formatting = Formatting.Indented;
+                        options.SerializerSettings.Converters.Add(new StringEnumConverter());
 #if DEBUG
-                options.IncludeExceptionStackTraceInErrors = true;
+                        options.IncludeExceptionStackTraceInErrors = true;
 #endif
-            }, discovery => discovery.AddCurrentAssembly());
+                    }, discovery => discovery.AddCurrentAssembly());
+                }
+            }
         }
 
         // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
-        public override void Configure(IApplicationBuilder app, IWebHostEnvironment environment)
+        public override void Configure(IApplicationBuilder app, IWebHostEnvironment environment, ILoggerFactory loggerFactory)
         {
-            using (IServiceScope scope = app.ApplicationServices.CreateScope())
+            ILogger<Startup> logger = loggerFactory.CreateLogger<Startup>();
+
+            using (CodeTimingSessionManager.Current.Measure("Initialize other (startup)"))
+            {
+                using (IServiceScope scope = app.ApplicationServices.CreateScope())
+                {
+                    var appDbContext = scope.ServiceProvider.GetRequiredService<AppDbContext>();
+                    appDbContext.Database.EnsureCreated();
+                }
+
+                app.UseRouting();
+
+                using (CodeTimingSessionManager.Current.Measure("Initialize JSON:API (startup)"))
+                {
+                    app.UseJsonApi();
+                }
+
+                app.UseEndpoints(endpoints => endpoints.MapControllers());
+            }
+
+            if (CodeTimingSessionManager.IsEnabled)
             {
-                var appDbContext = scope.ServiceProvider.GetRequiredService<AppDbContext>();
-                appDbContext.Database.EnsureCreated();
+                string timingResults = CodeTimingSessionManager.Current.GetResults();
+                logger.LogInformation($"Measurement results for application startup:{Environment.NewLine}{timingResults}");
             }
 
-            app.UseRouting();
-            app.UseJsonApi();
-            app.UseEndpoints(endpoints => endpoints.MapControllers());
+            _codeTimingSession.Dispose();
         }
     }
 }

src/Examples/JsonApiDotNetCoreExample/appsettings.json

@@ -7,7 +7,9 @@
       "Default": "Warning",
       "Microsoft.Hosting.Lifetime": "Warning",
       "Microsoft.EntityFrameworkCore.Update": "Critical",
-      "Microsoft.EntityFrameworkCore.Database.Command": "Critical"
+      "Microsoft.EntityFrameworkCore.Database.Command": "Critical",
+      "JsonApiDotNetCore": "Information",
+      "JsonApiDotNetCoreExample": "Information"
     }
   },
   "AllowedHosts": "*"

src/JsonApiDotNetCore/Diagnostics/AspNetCodeTimerSession.cs

@@ -1,4 +1,5 @@
 using System;
+using JetBrains.Annotations;
 using Microsoft.AspNetCore.Http;
 
 namespace JsonApiDotNetCore.Diagnostics
@@ -8,7 +9,8 @@ namespace JsonApiDotNetCore.Diagnostics
     /// Can be used with async/wait, but it cannot distinguish between concurrently running threads within a single HTTP request, so you'll need to pass an
     /// <see cref="CascadingCodeTimer" /> instance through the entire call chain in that case.
     /// </summary>
-    internal sealed class AspNetCodeTimerSession : ICodeTimerSession
+    [PublicAPI]
+    public sealed class AspNetCodeTimerSession : ICodeTimerSession
     {
         private const string HttpContextItemKey = "CascadingCodeTimer:Session";
 

src/JsonApiDotNetCore/Diagnostics/CascadingCodeTimer.cs

@@ -69,7 +69,7 @@ private void Close(MeasureScope scope)
         }
 
         /// <inheritdoc />
-        public string GetResult()
+        public string GetResults()
         {
             int paddingLength = GetPaddingLength();
 

src/JsonApiDotNetCore/Diagnostics/CodeTimingSessionManager.cs

@@ -9,9 +9,9 @@ namespace JsonApiDotNetCore.Diagnostics
     /// Provides access to the "current" measurement, which removes the need to pass along a <see cref="CascadingCodeTimer" /> instance through the entire
     /// call chain.
     /// </summary>
-    internal static class CodeTimingSessionManager
+    public static class CodeTimingSessionManager
     {
-        private static readonly bool IsEnabled;
+        public static readonly bool IsEnabled;
         private static ICodeTimerSession _session;
 
         public static ICodeTimer Current
@@ -38,6 +38,7 @@ static CodeTimingSessionManager()
 #endif
         }
 
+        // ReSharper disable once UnusedMember.Local
         private static bool IsRunningInTest()
         {
             const string testAssemblyName = "xunit.core";

src/JsonApiDotNetCore/Diagnostics/DefaultCodeTimerSession.cs

@@ -7,7 +7,7 @@ namespace JsonApiDotNetCore.Diagnostics
     /// General code timing session management. Can be used with async/wait, but it cannot distinguish between concurrently running threads, so you'll need
     /// to pass an <see cref="CascadingCodeTimer" /> instance through the entire call chain in that case.
     /// </summary>
-    internal sealed class DefaultCodeTimerSession : ICodeTimerSession
+    public sealed class DefaultCodeTimerSession : ICodeTimerSession
     {
         private readonly AsyncLocal<ICodeTimer> _codeTimerInContext = new();
 

src/JsonApiDotNetCore/Diagnostics/DisabledCodeTimer.cs

@@ -18,7 +18,7 @@ public IDisposable Measure(string name, bool excludeInRelativeCost = false)
             return this;
         }
 
-        public string GetResult()
+        public string GetResults()
         {
             return string.Empty;
         }

src/JsonApiDotNetCore/Diagnostics/ICodeTimer.cs

@@ -5,7 +5,7 @@ namespace JsonApiDotNetCore.Diagnostics
     /// <summary>
     /// Records execution times for code blocks.
     /// </summary>
-    internal interface ICodeTimer : IDisposable
+    public interface ICodeTimer : IDisposable
     {
         /// <summary>
         /// Starts recording the duration of a code block. Wrap this call in a <c>using</c> statement, so the recording stops when the return value goes out of
@@ -22,6 +22,6 @@ internal interface ICodeTimer : IDisposable
         /// <summary>
         /// Returns intermediate or final results.
         /// </summary>
-        string GetResult();
+        string GetResults();
     }
 }