Merge pull request #29 from serilog/dev

2.2.0 Release
serilog · Jan 22, 2017 · 26be724 · 26be724
2 parents 7d4f169 + 3d2ef94
commit 26be724
Show file tree

Hide file tree

Showing 7 changed files with 47 additions and 22 deletions.
diff --git a/README.md b/README.md
@@ -10,8 +10,8 @@ Sends log events by SMTP email.
 ```csharp
 var log = new LoggerConfiguration()
     .WriteTo.Email(
-        from: "[email protected]",
-        to: "[email protected]",
+        fromEmail: "[email protected]",
+        toEmail: "[email protected]",
         mailServer: "smtp.example.com")
     .CreateLogger();
 ```

diff --git a/src/Serilog.Sinks.Email/LoggerConfigurationEmailExtensions.cs b/src/Serilog.Sinks.Email/LoggerConfigurationEmailExtensions.cs
@@ -42,7 +42,7 @@ public static class LoggerConfigurationEmailExtensions
         /// <param name="batchPostingLimit">The maximum number of events to post in a single batch.</param>
         /// <param name="period">The time to wait between checking for event batches.</param>
         /// <param name="formatProvider">Supplies culture-specific formatting information, or null.</param>
-        /// <param name="mailSubject">The subject used in error mails</param>
+        /// <param name="mailSubject">The subject, can be a plain string or a template such as {Timestamp} [{Level}] occurred.</param>
         /// <returns>Logger configuration, allowing configuration to continue.</returns>
         /// <exception cref="ArgumentNullException">A required parameter is null.</exception>
         public static LoggerConfiguration Email(
@@ -84,7 +84,7 @@ public static LoggerConfiguration Email(
         /// <param name="batchPostingLimit">The maximum number of events to post in a single batch.</param>
         /// <param name="period">The time to wait between checking for event batches.</param>
         /// <param name="formatProvider">Supplies culture-specific formatting information, or null.</param>
-        /// <param name="mailSubject">The subject used in error mails</param>
+        /// <param name="mailSubject">The subject, can be a plain string or a template such as {Timestamp} [{Level}] occurred.</param>
         /// <returns>Logger configuration, allowing configuration to continue.</returns>
         /// <exception cref="ArgumentNullException">A required parameter is null.</exception>
         public static LoggerConfiguration Email(
@@ -130,7 +130,7 @@ public static LoggerConfiguration Email(
         /// <param name="batchPostingLimit">The maximum number of events to post in a single batch.</param>
         /// <param name="period">The time to wait between checking for event batches.</param>
         /// <param name="formatProvider">Supplies culture-specific formatting information, or null.</param>
-        /// <param name="mailSubject">The subject used in error mails</param>
+        /// <param name="mailSubject">The subject, can be a plain string or a template such as {Timestamp} [{Level}] occurred.</param>
         /// <returns>Logger configuration, allowing configuration to continue.</returns>
         /// <exception cref="ArgumentNullException">A required parameter is null.</exception>
         public static LoggerConfiguration Email(
@@ -173,7 +173,7 @@ public static LoggerConfiguration Email(
         /// <param name="batchPostingLimit">The maximum number of events to post in a single batch.</param>
         /// <param name="period">The time to wait between checking for event batches.</param>
         /// <param name="formatProvider">Supplies culture-specific formatting information, or null.</param>
-        /// <param name="mailSubject">The subject used in error mails</param>
+        /// <param name="mailSubject">The subject, can be a plain string or a template such as {Timestamp} [{Level}] occurred.</param>
         /// <returns>Logger configuration, allowing configuration to continue.</returns>
         /// <exception cref="ArgumentNullException">A required parameter is null.</exception>
         public static LoggerConfiguration Email(
@@ -188,11 +188,17 @@ public static LoggerConfiguration Email(
         {
             if (connectionInfo == null) throw new ArgumentNullException("connectionInfo");
 
+            if (!string.IsNullOrEmpty(connectionInfo.EmailSubject))
+            {
+                mailSubject = connectionInfo.EmailSubject;
+            }
+
             var defaultedPeriod = period ?? EmailSink.DefaultPeriod;
             var formatter = new MessageTemplateTextFormatter(outputTemplate, formatProvider);
+            var subjectLineFormatter = new MessageTemplateTextFormatter(mailSubject, formatProvider);
 
             return loggerConfiguration.Sink(
-                new EmailSink(connectionInfo, batchPostingLimit, defaultedPeriod, formatter),
+                new EmailSink(connectionInfo, batchPostingLimit, defaultedPeriod, formatter, subjectLineFormatter),
                 restrictedToMinimumLevel);
         }
 
@@ -205,7 +211,7 @@ public static LoggerConfiguration Email(
         /// <param name="batchPostingLimit">The maximum number of events to post in a single batch.</param>
         /// <param name="period">The time to wait between checking for event batches.</param>
         /// <param name="textFormatter">ITextFormatter implementation to write log entry to email.</param>
-        /// <param name="mailSubject">The subject used in error mails</param>
+        /// <param name="mailSubject">The subject, can be a plain string or a template such as {Timestamp} [{Level}] occurred.</param>
         /// <returns>Logger configuration, allowing configuration to continue.</returns>
         /// <exception cref="ArgumentNullException">A required parameter is null.</exception>
         public static LoggerConfiguration Email(
@@ -220,10 +226,12 @@ public static LoggerConfiguration Email(
             if (connectionInfo == null) throw new ArgumentNullException("connectionInfo");
             if (textFormatter == null) throw new ArgumentNullException("textFormatter");
 
+            ITextFormatter mailSubjectFormatter = new MessageTemplateTextFormatter(mailSubject, null);
+
             var defaultedPeriod = period ?? EmailSink.DefaultPeriod;
 
             return loggerConfiguration.Sink(
-                new EmailSink(connectionInfo, batchPostingLimit, defaultedPeriod, textFormatter),
+                new EmailSink(connectionInfo, batchPostingLimit, defaultedPeriod, textFormatter, mailSubjectFormatter),
                 restrictedToMinimumLevel);
         }
     }

diff --git a/src/Serilog.Sinks.Email/Sinks/Email/EmailConnectionInfo.cs b/src/Serilog.Sinks.Email/Sinks/Email/EmailConnectionInfo.cs
@@ -65,7 +65,7 @@ public EmailConnectionInfo()
         public string ToEmail { get; set; }
 
         /// <summary>
-        /// The subject to use for the email.
+        /// The subject to use for the email, this can be a template.
         /// </summary>
         [DefaultValue(DefaultSubject)]
         public string EmailSubject { get; set; }

diff --git a/src/Serilog.Sinks.Email/Sinks/Email/EmailSink.cs b/src/Serilog.Sinks.Email/Sinks/Email/EmailSink.cs
@@ -23,6 +23,8 @@
 using Serilog.Events;
 using Serilog.Formatting;
 using Serilog.Sinks.PeriodicBatching;
+using Serilog.Formatting.Display;
+using System.Linq;
 
 namespace Serilog.Sinks.Email
 {
@@ -34,6 +36,8 @@ class EmailSink : PeriodicBatchingSink
 
         readonly ITextFormatter _textFormatter;
 
+        readonly ITextFormatter _subjectLineFormatter;
+
         /// <summary>
         /// A reasonable default for the number of events posted in
         /// each batch.
@@ -52,13 +56,15 @@ class EmailSink : PeriodicBatchingSink
         /// <param name="batchSizeLimit">The maximum number of events to post in a single batch.</param>
         /// <param name="period">The time to wait between checking for event batches.</param>
         /// <param name="textFormatter">Supplies culture-specific formatting information, or null.</param>
-        public EmailSink(EmailConnectionInfo connectionInfo, int batchSizeLimit, TimeSpan period, ITextFormatter textFormatter)
+        /// <param name="subjectLineFormatter">Supplies culture-specific formatting information, or null.</param>
+        public EmailSink(EmailConnectionInfo connectionInfo, int batchSizeLimit, TimeSpan period, ITextFormatter textFormatter, ITextFormatter subjectLineFormatter)
             : base(batchSizeLimit, period)
         {
             if (connectionInfo == null) throw new ArgumentNullException(nameof(connectionInfo));
 
             _connectionInfo = connectionInfo;
             _textFormatter = textFormatter;
+            _subjectLineFormatter = subjectLineFormatter;
             _smtpClient = CreateSmtpClient();
             _smtpClient.SendCompleted += SendCompletedCallback;
         }
@@ -112,10 +118,13 @@ protected override async Task EmitBatchAsync(IEnumerable<LogEvent> events)
                 _textFormatter.Format(logEvent, payload);
             }
 
+            var subject = new StringWriter();
+            _subjectLineFormatter.Format(events.OrderByDescending(e => e.Level).First(), subject);
+
             var mailMessage = new MailMessage
             {
                 From = new MailAddress(_connectionInfo.FromEmail),
-                Subject = _connectionInfo.EmailSubject,
+                Subject = subject.ToString(),
                 Body = payload.ToString(),
                 BodyEncoding = Encoding.UTF8,
                 SubjectEncoding = Encoding.UTF8,

diff --git a/src/Serilog.Sinks.Email/Sinks/Email/MailKitEmailSink.cs b/src/Serilog.Sinks.Email/Sinks/Email/MailKitEmailSink.cs
@@ -37,6 +37,8 @@ class EmailSink : PeriodicBatchingSink
 
         readonly ITextFormatter _textFormatter;
 
+        readonly ITextFormatter _subjectFormatter;
+
         /// <summary>
         /// A reasonable default for the number of events posted in
         /// each batch.
@@ -55,7 +57,9 @@ class EmailSink : PeriodicBatchingSink
         /// <param name="batchSizeLimit">The maximum number of events to post in a single batch.</param>
         /// <param name="period">The time to wait between checking for event batches.</param>
         /// <param name="textFormatter">Supplies culture-specific formatting information, or null.</param>
-        public EmailSink(EmailConnectionInfo connectionInfo, int batchSizeLimit, TimeSpan period, ITextFormatter textFormatter)
+        /// <param name="subjectLineFormatter">The subject line formatter.</param>
+        /// <exception cref="System.ArgumentNullException">connectionInfo</exception>
+        public EmailSink(EmailConnectionInfo connectionInfo, int batchSizeLimit, TimeSpan period, ITextFormatter textFormatter, ITextFormatter subjectLineFormatter)
             : base(batchSizeLimit, period)
         {
             if (connectionInfo == null) throw new ArgumentNullException(nameof(connectionInfo));
@@ -69,14 +73,15 @@ public EmailSink(EmailConnectionInfo connectionInfo, int batchSizeLimit, TimeSpa
                 .ToArray();
 
             _textFormatter = textFormatter;
+            _subjectFormatter = subjectLineFormatter;
         }
 
-        private MimeKit.MimeMessage CreateMailMessage(string payload)
+        private MimeKit.MimeMessage CreateMailMessage(string payload, string subject)
         {
             var mailMessage = new MimeKit.MimeMessage();
             mailMessage.From.Add(_fromAddress);
             mailMessage.To.AddRange(_toAddresses);
-            mailMessage.Subject = _connectionInfo.EmailSubject;
+            mailMessage.Subject = subject;
             mailMessage.Body = _connectionInfo.IsBodyHtml
                 ? new MimeKit.BodyBuilder { HtmlBody = payload }.ToMessageBody()
                 : new MimeKit.BodyBuilder { TextBody = payload }.ToMessageBody();
@@ -101,7 +106,10 @@ protected override async Task EmitBatchAsync(IEnumerable<LogEvent> events)
                 _textFormatter.Format(logEvent, payload);
             }
 
-            var mailMessage = CreateMailMessage(payload.ToString());
+            var subject = new StringWriter();
+            _subjectFormatter.Format(events.OrderByDescending(e => e.Level).First(), subject);
+
+            var mailMessage = CreateMailMessage(payload.ToString(), subject.ToString());
 
             try
             {

diff --git a/src/Serilog.Sinks.Email/project.json b/src/Serilog.Sinks.Email/project.json
@@ -1,5 +1,5 @@
-{
-  "version": "2.1.0-*",
+{
+  "version": "2.2.0-*",
   "description": "The file sink for Serilog",
   "authors": [ "Serilog Contributors" ],
   "packOptions": {
@@ -38,4 +38,4 @@
       }
     }
   }
-}
+}
diff --git a/test/Serilog.Sinks.Email.Tests/project.json b/test/Serilog.Sinks.Email.Tests/project.json
@@ -31,9 +31,9 @@
               "portable-net45+win8"
           ],
           "dependencies": {
-              "Microsoft.NETCore.App": {
-                  "type": "platform",
-                  "version": "1.0.0"
+            "Microsoft.NETCore.App": {
+                "type": "platform",
+                "version": "1.0.0"
               },
               "System.Linq": "4.1.0",
               "System.Threading": "4.0.11"