Enrich installation with environment variables and made an OnInstallation hook available in options

Author: ThomasArdal

samples/Elmah.Io.Extensions.Logging.AspNetCore90/Program.cs

@@ -27,6 +27,14 @@
 
     // Remove comment on the following line to log through a proxy (in this case Fiddler).
     //options.WebProxy = new WebProxy("localhost", 8888);
+
+    // Enrich installation when notifying elmah.io after launch:
+    //options.OnInstallation = installation =>
+    //{
+    //    installation.Name = "ASP.NET Core 9.0 Application";
+    //    var logger = installation.Loggers.FirstOrDefault(l => l.Type == "Elmah.Io.Extensions.Logging");
+    //    logger?.Properties.Add(new Elmah.Io.Client.Item("Foo", "Bar"));
+    //};
 });
 
 // The elmah.io provider can log any log level, but we recommend only to log warning and up

samples/Elmah.Io.Extensions.Logging.Console90/Program.cs

@@ -16,6 +16,14 @@
     //options.BatchPostingLimit = 20;
     //options.BackgroundQueueSize = 200;
     //options.Period = TimeSpan.FromSeconds(1);
+
+    // Enrich installation when notifying elmah.io after launch:
+    //options.OnInstallation = installation =>
+    //{
+    //    installation.Name = "ASP.NET Core 9.0 Application";
+    //    var logger = installation.Loggers.FirstOrDefault(l => l.Type == "Elmah.Io.Extensions.Logging");
+    //    logger?.Properties.Add(new Elmah.Io.Client.Item("Foo", "Bar"));
+    //};
 }));
 
 using (var serviceProvider = services.BuildServiceProvider())

src/Elmah.Io.Extensions.Logging/ElmahIoLoggerProvider.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Collections.Generic;
 using System.IO;
 using System.Reflection;
 using Elmah.Io.Client;
@@ -120,6 +121,7 @@ private void CreateInstallation()
                         new AssemblyInfo { Name = "Elmah.Io.Client", Version = typeof(IElmahioAPI).GetTypeInfo().Assembly.GetCustomAttribute<AssemblyFileVersionAttribute>().Version },
                         new AssemblyInfo { Name = "Microsoft.Extensions.Logging", Version = typeof(ILoggerProvider).GetTypeInfo().Assembly.GetCustomAttribute<AssemblyFileVersionAttribute>().Version }
                     ],
+                    EnvironmentVariables = [],
                 };
 
                 var installation = new CreateInstallation
@@ -160,7 +162,14 @@ private void CreateInstallation()
                     }
                 }
 
-                api.Installations.Create(_options.LogId.ToString(), installation);
+                if (EnvironmentVariablesHelper.TryGetElmahIoAppSettingsEnvironmentVariables(out List<Item> elmahIoVariables)) elmahIoVariables.ForEach(v => logger.EnvironmentVariables.Add(v));
+                if (EnvironmentVariablesHelper.TryGetAspNetCoreEnvironmentVariables(out List<Item> aspNetCoreVariables)) aspNetCoreVariables.ForEach(v => logger.EnvironmentVariables.Add(v));
+                if (EnvironmentVariablesHelper.TryGetDotNetEnvironmentVariables(out List<Item> dotNetVariables)) dotNetVariables.ForEach(v => logger.EnvironmentVariables.Add(v));
+                if (EnvironmentVariablesHelper.TryGetAzureEnvironmentVariables(out List<Item> azureVariables)) azureVariables.ForEach(v => logger.EnvironmentVariables.Add(v));
+
+                _options.OnInstallation?.Invoke(installation);
+
+                api.Installations.CreateAndNotify(_options.LogId, installation);
             }
             catch
             {

src/Elmah.Io.Extensions.Logging/ElmahIoProviderOptions.cs

@@ -30,6 +30,11 @@ public class ElmahIoProviderOptions
         /// </summary>
         public Action<CreateMessage> OnMessage { get; set; }
         /// <summary>
+        /// Register an action to be called before creating an installation. Use the OnInstallation
+        /// action to decorate installations with additional information related to your environment.
+        /// </summary>
+        public Action<CreateInstallation> OnInstallation { get; set; }
+        /// <summary>
         /// Specify an action to be called on all (not filtered) messages if communication with the elmah.io API fails.
         /// </summary>
         public Action<CreateMessage, Exception> OnError { get; set; }