Merge pull request #76 from exceptionless/feature-useragentbots

#73 Added plugin to ignore events that match a user agent bot filter

Author: ejsmith

Source/Platforms/Mvc/ExceptionlessModule.cs

@@ -3,6 +3,7 @@
 using System.Web;
 using System.Web.Mvc;
 using Exceptionless.Dependency;
+using Exceptionless.Plugins;
 using Exceptionless.Web;
 using Exceptionless.Web.Extensions;
 
@@ -14,6 +15,7 @@ public virtual void Init(HttpApplication app) {
             ExceptionlessClient.Default.Startup();
             ExceptionlessClient.Default.RegisterHttpApplicationErrorHandler(app);
             ExceptionlessClient.Default.Configuration.AddPlugin<ExceptionlessWebPlugin>();
+            ExceptionlessClient.Default.Configuration.AddPlugin<IgnoreUserAgentPlugin>();
             ExceptionlessClient.Default.Configuration.Resolver.Register<ILastReferenceIdManager, WebLastReferenceIdManager>();
 
             _app = app;

Source/Platforms/Nancy/ExceptionlessNancyExtensions.cs

@@ -20,6 +20,7 @@ public static class ExceptionlessNancyExtensions {
         public static void RegisterNancy(this ExceptionlessClient client, IPipelines pipelines) {
             client.Startup();
             client.Configuration.AddPlugin<ExceptionlessNancyPlugin>();
+            client.Configuration.AddPlugin<IgnoreUserAgentPlugin>();
 
             pipelines.OnError += OnError;
             pipelines.AfterRequest += AfterRequest;

Source/Platforms/Web/ExceptionlessModule.cs

@@ -1,6 +1,7 @@
 using System;
 using System.Web;
 using Exceptionless.Dependency;
+using Exceptionless.Plugins;
 using Exceptionless.Web.Extensions;
 
 namespace Exceptionless.Web {
@@ -11,6 +12,7 @@ public virtual void Init(HttpApplication app) {
             ExceptionlessClient.Default.Startup();
             ExceptionlessClient.Default.RegisterHttpApplicationErrorHandler(app);
             ExceptionlessClient.Default.Configuration.AddPlugin<ExceptionlessWebPlugin>();
+            ExceptionlessClient.Default.Configuration.AddPlugin<IgnoreUserAgentPlugin>();
             ExceptionlessClient.Default.Configuration.Resolver.Register<ILastReferenceIdManager, WebLastReferenceIdManager>();
 
             _app = app;

Source/Platforms/WebApi/ExceptionlessWebApiExtensions.cs

@@ -7,6 +7,7 @@
 using Exceptionless.ExtendedData;
 using Exceptionless.Models;
 using Exceptionless.Models.Data;
+using Exceptionless.Plugins;
 using Exceptionless.WebApi;
 
 namespace Exceptionless {
@@ -19,6 +20,7 @@ public static class ExceptionlessWebApiExtensions {
         public static void RegisterWebApi(this ExceptionlessClient client, HttpConfiguration config) {
             client.Startup();
             client.Configuration.AddPlugin<ExceptionlessWebApiPlugin>();
+            client.Configuration.AddPlugin<IgnoreUserAgentPlugin>();
 
 #if WEBAPI21
             config.Services.Add(typeof(IExceptionLogger), new ExceptionlessExceptionLogger());

Source/Shared/Configuration/ExceptionlessConfiguration.cs

@@ -20,7 +20,8 @@ public class ExceptionlessConfiguration {
         private string _serverUrl;
         private int _submissionBatchSize;
         private ValidationResult _validationResult;
-        private readonly List<string> _exclusions = new List<string>(); 
+        private readonly List<string> _exclusions = new List<string>();
+        private readonly List<string> _userAgentBotPatterns = new List<string>();
 
         public ExceptionlessConfiguration(IDependencyResolver resolver) {
             if (resolver == null)
@@ -159,12 +160,7 @@ public int SubmissionBatchSize {
         /// parameters from the report.
         /// </summary>
         public IEnumerable<string> DataExclusions {
-            get {
-                if (Settings.ContainsKey(SettingsDictionary.KnownKeys.DataExclusions))
-                    return _exclusions.Union(Settings.GetStringCollection(SettingsDictionary.KnownKeys.DataExclusions));
-                
-                return _exclusions.ToArray();
-            }
+            get { return _exclusions.Union(Settings.GetStringCollection(SettingsDictionary.KnownKeys.DataExclusions)); }
         }
 
         /// <summary>
@@ -187,6 +183,32 @@ public void AddDataExclusions(IEnumerable<string> exclusions) {
             _exclusions.AddRange(exclusions);
         }
 
+        /// <summary>
+        /// A list of user agent patterns that will cause any event with a matching user agent to not be submitted.
+        /// For example, entering *Bot* will cause any events that contains a user agent of Bot will not be submitted.
+        /// </summary>
+        public IEnumerable<string> UserAgentBotPatterns {
+            get { return _userAgentBotPatterns.Union(Settings.GetStringCollection(SettingsDictionary.KnownKeys.UserAgentBotPatterns)); }
+        }
+
+        /// <summary>
+        /// Add items to the list of user agent patterns that will cause any event with a matching user agent to not be submitted.
+        /// For example, entering *Bot* will cause any events that contains a user agent of Bot will not be submitted.
+        /// </summary>
+        /// <param name="userAgentBotPatterns">The list of user agent bot patterns to add.</param>
+        public void AddUserAgentBotPatterns(params string[] userAgentBotPatterns) {
+            _userAgentBotPatterns.AddRange(userAgentBotPatterns);
+        }
+
+        /// <summary>
+        /// Add items to the list of user agent patterns that will cause any event with a matching user agent to not be submitted.
+        /// For example, entering *Bot* will cause any events that contains a user agent of Bot will not be submitted.
+        /// </summary>
+        /// <param name="userAgentBotPatterns">The list of user agent bot patterns to add.</param>
+        public void AddUserAgentBotPatterns(IEnumerable<string> userAgentBotPatterns) {
+            _userAgentBotPatterns.AddRange(userAgentBotPatterns);
+        }
+        
         /// <summary>
         /// The dependency resolver to use for this configuration.
         /// </summary>

Source/Shared/Exceptionless.Portable.csproj

@@ -64,6 +64,7 @@
     <Compile Include="Plugins\ContextData.cs" />
     <Compile Include="Plugins\Default\1000_CancelSessionsWithNoUserPlugin.cs" />
     <Compile Include="Plugins\Default\100_HeartbeatPlugin.cs" />
+    <Compile Include="Plugins\Default\110_IgnoreUserAgentPlugin.cs" />
     <Compile Include="Plugins\Default\ActionPlugin.cs" />
     <Compile Include="Plugins\Default\010_ConfigurationDefaultsPlugin.cs" />
     <Compile Include="Plugins\Default\090_SubmissionMethodPlugin.cs" />

Source/Shared/Plugins/Default/110_IgnoreUserAgentPlugin.cs

@@ -0,0 +1,18 @@
+using System;
+using Exceptionless.Extensions;
+
+namespace Exceptionless.Plugins {
+    [Priority(110)]
+    public class IgnoreUserAgentPlugin : IEventPlugin {
+        public void Run(EventPluginContext context) {
+            var request = context.Event.GetRequestInfo();
+            if (request == null)
+                return;
+
+            if (request.UserAgent.AnyWildcardMatches(context.Client.Configuration.UserAgentBotPatterns, true)) {
+                context.Log.Info(String.Concat("Cancelling event as the request infos user agent matches a known bot pattern: ", request.UserAgent), typeof(IgnoreUserAgentPlugin).Name);
+                context.Cancel = true;
+            }
+        }
+    }
+}