Added the ability to send a heartbeat event

niemyjski · niemyjski · commit 619870c68100 · 2015-12-21T14:38:44.000-06:00
exceptionless/Exceptionless#166
diff --git a/Source/Extras/Exceptionless.Extras.csproj b/Source/Extras/Exceptionless.Extras.csproj
@@ -54,7 +54,6 @@
     <Compile Include="Plugins\20_ErrorPlugin.cs" />
     <Compile Include="Plugins\15_PrivateInformationPlugin.cs" />
     <Compile Include="Plugins\70_TraceLogPlugin.cs" />
-    <Compile Include="Plugins\90_SessionIdManagerPlugin.cs" />
     <Compile Include="Plugins\80_VersionPlugin.cs" />
     <Compile Include="ExceptionlessSection.cs" />
     <Compile Include="Extensions\EventBuilderExtensions.cs" />
diff --git a/Source/Extras/Extensions/ExceptionlessExtraConfigurationExtensions.cs b/Source/Extras/Extensions/ExceptionlessExtraConfigurationExtensions.cs
@@ -13,7 +13,6 @@
 using Exceptionless.Extras.Storage;
 using Exceptionless.Extras.Utility;
 using Exceptionless.Logging;
-using Exceptionless.Plugins;
 using Exceptionless.Storage;
 
 namespace Exceptionless {
@@ -28,14 +27,6 @@ public static void UseErrorPlugin(this ExceptionlessConfiguration config) {
             config.RemovePlugin<SimpleErrorPlugin>();
             config.AddPlugin<Plugins.ErrorPlugin>();
         }
-
-        /// <summary>
-        /// Ensures only a single user session will be created unless you specify a session id via the event builder.
-        /// NOTE: This should only be used on deskop applications. Using this in web farm scenarios is not advisable.
-        /// </summary>
-        public static void UseSessionIdManagementPlugin(this ExceptionlessConfiguration config) {
-            config.AddPlugin<SessionIdManagerPlugin>();
-        }
         
         public static void UseIsolatedStorage(this ExceptionlessConfiguration config) {
             config.Resolver.Register<IObjectStorage>(new IsolatedStorageObjectStorage(config.Resolver));
diff --git a/Source/Platforms/Console/ExceptionlessExtensions.cs b/Source/Platforms/Console/ExceptionlessExtensions.cs
@@ -11,7 +11,7 @@ public static class ExceptionlessExtensions {
         /// </summary>
         /// <param name="client">The ExceptionlessClient.</param>
         public static void Register(this ExceptionlessClient client) {
-            client.Configuration.UseSessionIdManagementPlugin();
+            client.Configuration.UseSessions();
             client.Startup();
             client.SubmitSessionStart();
 
diff --git a/Source/Platforms/Windows/ExceptionlessWindowsExtensions.cs b/Source/Platforms/Windows/ExceptionlessWindowsExtensions.cs
@@ -15,7 +15,7 @@ public static class ExceptionlessWindowsExtensions {
         /// <param name="client">The ExceptionlessClient.</param>
         /// <param name="showDialog">Controls whether a dialog is shown when an unhandled exception occurs.</param>
         public static void Register(this ExceptionlessClient client, bool showDialog = true) {
-            client.Configuration.UseSessionIdManagementPlugin();
+            client.Configuration.UseSessions();
             client.Startup();
             client.SubmitSessionStart();
             client.RegisterApplicationThreadExceptionHandler();
diff --git a/Source/Platforms/Wpf/ExceptionlessWpfExtensions.cs b/Source/Platforms/Wpf/ExceptionlessWpfExtensions.cs
@@ -16,7 +16,7 @@ public static class ExceptionlessWpfExtensions {
         /// <param name="client">The ExceptionlessClient.</param>
         /// <param name="showDialog">Controls whether a dialog is shown when an unhandled exception occurs.</param>
         public static void Register(this ExceptionlessClient client, bool showDialog = true) {
-            client.Configuration.UseSessionIdManagementPlugin();
+            client.Configuration.UseSessions();
             client.Startup();
             client.SubmitSessionStart();
             client.RegisterApplicationThreadExceptionHandler();
diff --git a/Source/Shared/Dependency/DefaultDependencyResolver.cs b/Source/Shared/Dependency/DefaultDependencyResolver.cs
@@ -7,7 +7,7 @@ public sealed class DefaultDependencyResolver : IDependencyResolver {
 
         public object Resolve(Type serviceType) {
             if (serviceType == null)
-                throw new ArgumentNullException("serviceType");
+                throw new ArgumentNullException(nameof(serviceType));
 
             return _container.Resolve(serviceType);
         }
diff --git a/Source/Shared/Exceptionless.Portable.csproj b/Source/Shared/Exceptionless.Portable.csproj
@@ -61,9 +61,11 @@
     <Compile Include="Events\EventSubmittedEventArgs.cs" />
     <Compile Include="Plugins\Default\30_DuplicateCheckerPlugin.cs" />
     <Compile Include="Plugins\ContextData.cs" />
+    <Compile Include="Plugins\Default\110 _HeartbeatPlugin.cs" />
+    <Compile Include="Plugins\Default\100_SessionIdManagerPlugin.cs" />
     <Compile Include="Plugins\Default\ActionPlugin.cs" />
     <Compile Include="Plugins\Default\10_ConfigurationDefaultsPlugin.cs" />
-    <Compile Include="Plugins\Default\100_SubmissionMethodPlugin.cs" />
+    <Compile Include="Plugins\Default\90_SubmissionMethodPlugin.cs" />
     <Compile Include="Plugins\Default\40_ReferenceIdPlugin.cs" />
     <Compile Include="Plugins\Default\20_SimpleErrorPlugin.cs" />
     <Compile Include="Plugins\Default\50_EnvironmentInfoPlugin.cs" />
diff --git a/Source/Shared/Extensions/ExceptionlessConfigurationExtensions.cs b/Source/Shared/Extensions/ExceptionlessConfigurationExtensions.cs
@@ -8,6 +8,7 @@
 using Exceptionless.Logging;
 using Exceptionless.Models;
 using Exceptionless.Models.Data;
+using Exceptionless.Plugins;
 using Exceptionless.Storage;
 
 namespace Exceptionless {
@@ -83,6 +84,15 @@ public static string GetInstallId(this ExceptionlessConfiguration config) {
             return persistedClientData[INSTALL_ID_KEY];
         }
 
+        /// <summary>
+        /// Ensures only a single user session will be created unless you specify a session id via the event builder.
+        /// NOTE: This should only be used on deskop applications. Using this in web farm scenarios is not advisable.
+        /// </summary>
+        public static void UseSessions(this ExceptionlessConfiguration config) {
+            config.AddPlugin<SessionIdManagerPlugin>();
+            config.AddPlugin<HeartbeatPlugin>();
+        }
+        
         public static void UseDebugLogger(this ExceptionlessConfiguration config, LogLevel minLogLevel = LogLevel.Info) {
             config.Resolver.Register<IExceptionlessLog>(new DebugExceptionlessLog { MinimumLogLevel = minLogLevel });
         }
diff --git a/Source/Shared/Models/Client/Event.cs b/Source/Shared/Models/Client/Event.cs
@@ -59,9 +59,10 @@ public Event() {
 
         public static class KnownTypes {
             public const string Error = "error";
-            public const string NotFound = "404";
-            public const string Log = "log";
             public const string FeatureUsage = "usage";
+            public const string Heartbeat = "heart";
+            public const string Log = "log";
+            public const string NotFound = "404";
             public const string SessionStart = "start";
             public const string SessionEnd = "end";
         }
diff --git a/Source/Shared/Plugins/Default/100_SessionIdManagerPlugin.cs b/Source/Shared/Plugins/Default/100_SessionIdManagerPlugin.cs
@@ -1,10 +1,10 @@
 ﻿using System;
-using System.Collections.Concurrent;
+using System.Collections.Generic;
 
 namespace Exceptionless.Plugins {
-    [Priority(90)]
+    [Priority(100)]
     public class SessionIdManagerPlugin : IEventPlugin {
-        private ConcurrentDictionary<string, string> _sessionIdMap = new ConcurrentDictionary<string, string>();
+        private Dictionary<string, string> _sessionIdMap = new Dictionary<string, string>();
 
         public void Run(EventPluginContext context) {
             string sessionId;
diff --git a/Source/Shared/Plugins/Default/110 _HeartbeatPlugin.cs b/Source/Shared/Plugins/Default/110 _HeartbeatPlugin.cs
@@ -0,0 +1,68 @@
+﻿using System;
+using System.Threading;
+using Exceptionless.Logging;
+using Exceptionless.Models;
+using Exceptionless.Queue;
+
+namespace Exceptionless.Plugins.Default {
+    [Priority(110)]
+    public class HeartbeatPlugin : IEventPlugin, IDisposable {
+        private readonly IEventQueue _eventQueue;
+        private readonly IExceptionlessLog _log;
+        private Timer _timer;
+        private Event _lastEvent;
+
+        public HeartbeatPlugin(IEventQueue eventQueue, IExceptionlessLog log) {
+            _eventQueue = eventQueue;
+            _log = log;
+        }
+
+        public void Run(EventPluginContext context) {
+            var sessionIdentifier = context.Event.SessionId ?? context.Event.GetUserIdentity()?.Identity;
+            if (String.IsNullOrEmpty(sessionIdentifier) || context.Event.IsSessionEnd()) {
+                _timer?.Change(Timeout.Infinite, Timeout.Infinite);
+                _lastEvent = null;
+                return;
+            }
+            
+            if (_timer == null)
+                _timer = new Timer(OnEnqueueHeartbeat, null, TimeSpan.FromSeconds(30), TimeSpan.FromSeconds(30));
+            else
+                _timer.Change(TimeSpan.FromSeconds(30), TimeSpan.FromSeconds(30));
+
+            _lastEvent = context.Event;
+        }
+
+        private void OnEnqueueHeartbeat(object state) {
+            var heartbeatEvent = CreateHeartbeatEvent(_lastEvent);
+            if (heartbeatEvent == null)
+                return;
+
+            _log.Trace(nameof(HeartbeatPlugin), $"Enqueuing heartbeat for session: {_lastEvent.SessionId}");
+            _eventQueue.Enqueue(heartbeatEvent);
+        }
+
+        private Event CreateHeartbeatEvent(Event source) {
+            if (source == null)
+                return null;
+
+            var heartbeatEvent = new Event {
+                Date = DateTimeOffset.Now,
+                Type = Event.KnownTypes.Heartbeat,
+                SessionId = source.SessionId
+            };
+
+            heartbeatEvent.SetUserIdentity(source.GetUserIdentity());
+
+            return heartbeatEvent;
+        }
+
+        public void Dispose() {
+            if (_timer == null)
+                return;
+            
+            _timer.Dispose();
+            _timer = null;
+        }
+    }
+}
diff --git a/Source/Shared/Plugins/Default/90_SubmissionMethodPlugin.cs b/Source/Shared/Plugins/Default/90_SubmissionMethodPlugin.cs
@@ -2,7 +2,7 @@
 using Exceptionless.Models;
 
 namespace Exceptionless.Plugins.Default {
-    [Priority(100)]
+    [Priority(90)]
     public class SubmissionMethodPlugin : IEventPlugin {
         public void Run(EventPluginContext context) {
             string submissionMethod = context.ContextData.GetSubmissionMethod();

Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ public sealed class DefaultDependencyResolver : IDependencyResolver {`
`7`	`7`
`8`	`8`	`public object Resolve(Type serviceType) {`
`9`	`9`	`if (serviceType == null)`
`10`		`- throw new ArgumentNullException("serviceType");`
	`10`	`+ throw new ArgumentNullException(nameof(serviceType));`
`11`	`11`
`12`	`12`	`return _container.Resolve(serviceType);`
`13`	`13`	`}`