Network Logger and Graylog support

Author: akesseler

code/src/Plexdata.LogWriter.Network.Tests/Internals/Sockets/WebClientSocketTests.cs

@@ -31,7 +31,6 @@
 using System;
 using System.Diagnostics.CodeAnalysis;
 using System.Net;
-using System.Threading;
 
 namespace Plexdata.LogWriter.Network.Tests.Internals.Sockets
 {
@@ -71,6 +70,8 @@ public void Setup()
             this.settings.SetupGet(x => x.Host).Returns(() => this.host);
             this.settings.SetupGet(x => x.Port).Returns(() => this.port);
             this.settings.SetupGet(x => x.Timeout).Returns(() => this.timeout);
+            this.settings.SetupGet(x => x.Method).Returns(() => this.method);
+            this.settings.SetupGet(x => x.Content).Returns(() => this.content);
 
             this.factory.Setup(x => x.Create<IClientFacade>(this.target, this.method, this.content, this.timeout)).Returns(this.client.Object);
         }

code/src/Plexdata.LogWriter.Network.Tests/Settings/NetworkLoggerSettingsTests.cs

@@ -79,6 +79,8 @@ public void NetworkLoggerSettings_ValidateDefaultSettings_DefaultSettingsAsExpec
             Assert.That(instance.Maximum, Is.EqualTo(8192));
             Assert.That(instance.Termination, Is.False);
             Assert.That(instance.Timeout, Is.EqualTo(100000));
+            Assert.That(instance.Method, Is.EqualTo("POST"));
+            Assert.That(instance.Content, Is.EqualTo("application/json"));
         }
 
         [Test]
@@ -96,6 +98,8 @@ public void NetworkLoggerSettings_ValidateDefaultSettingsForInvalidConfiguration
             Assert.That(instance.Maximum, Is.EqualTo(8192));
             Assert.That(instance.Termination, Is.False);
             Assert.That(instance.Timeout, Is.EqualTo(100000));
+            Assert.That(instance.Method, Is.EqualTo("POST"));
+            Assert.That(instance.Content, Is.EqualTo("application/json"));
         }
 
         [Test]
@@ -288,6 +292,33 @@ public void NetworkLoggerSettings_ConfigurationValid_GetSectionValueForTimeoutAs
             Assert.That(instance.Timeout, Is.EqualTo(expected));
         }
 
+        [TestCase(null, "POST")]
+        [TestCase("", "POST")]
+        [TestCase(" ", "POST")]
+        [TestCase("post", "post")]
+        [TestCase("GET", "GET")]
+        public void NetworkLoggerSettings_ConfigurationValid_GetSectionValueForMethodAsExpected(String value, Object expected)
+        {
+            this.section.SetupGet(x => x["Method"]).Returns(value);
+
+            NetworkLoggerSettings instance = new NetworkLoggerSettings(this.configuration.Object);
+
+            Assert.That(instance.Method, Is.EqualTo(expected));
+        }
+
+        [TestCase(null, "application/json")]
+        [TestCase("", "application/json")]
+        [TestCase(" ", "application/json")]
+        [TestCase("something/else", "something/else")]
+        public void NetworkLoggerSettings_ConfigurationValid_GetSectionValueForContentAsExpected(String value, Object expected)
+        {
+            this.section.SetupGet(x => x["Content"]).Returns(value);
+
+            NetworkLoggerSettings instance = new NetworkLoggerSettings(this.configuration.Object);
+
+            Assert.That(instance.Content, Is.EqualTo(expected));
+        }
+
         #endregion
 
         #region Host
@@ -590,6 +621,66 @@ public void Timeout_ValueUnchanged_PropertyChangedNotFired()
 
         #endregion
 
+        #region Method
+
+        [Test]
+        public void Method_ValueChanged_PropertyChangedFired()
+        {
+            Boolean fired = false;
+            NetworkLoggerSettings instance = new NetworkLoggerSettings();
+
+            instance.Method = "POST";
+            instance.PropertyChanged += (sender, args) => { fired = true; };
+            instance.Method = "GET";
+
+            Assert.That(fired, Is.True);
+        }
+
+        [Test]
+        public void Method_ValueUnchanged_PropertyChangedNotFired()
+        {
+            Boolean fired = false;
+            NetworkLoggerSettings instance = new NetworkLoggerSettings();
+
+            instance.Method = "POST";
+            instance.PropertyChanged += (sender, args) => { fired = true; };
+            instance.Method = "POST";
+
+            Assert.That(fired, Is.False);
+        }
+
+        #endregion
+
+        #region Content
+
+        [Test]
+        public void Content_ValueChanged_PropertyChangedFired()
+        {
+            Boolean fired = false;
+            NetworkLoggerSettings instance = new NetworkLoggerSettings();
+
+            instance.Content = "application/json";
+            instance.PropertyChanged += (sender, args) => { fired = true; };
+            instance.Content = "something/else";
+
+            Assert.That(fired, Is.True);
+        }
+
+        [Test]
+        public void Content_ValueUnchanged_PropertyChangedNotFired()
+        {
+            Boolean fired = false;
+            NetworkLoggerSettings instance = new NetworkLoggerSettings();
+
+            instance.Content = "application/json";
+            instance.PropertyChanged += (sender, args) => { fired = true; };
+            instance.Content = "application/json";
+
+            Assert.That(fired, Is.False);
+        }
+
+        #endregion
+
         #region Other privates
 
         private class EncodingTestItem

code/src/Plexdata.LogWriter.Network/Abstraction/INetworkLoggerSettings.cs

@@ -149,7 +149,7 @@ public interface INetworkLoggerSettings : ILoggerSettings
         ///   <td><see cref="Protocol.Udp"/>, <see cref="Protocol.Tcp"/></td>
         ///   <td><see cref="Address.IPv4"/></td><td>DNS&#160;name</td>
         ///   <td>The <em>Host</em> property can contain a DNS host name, such as <c>localhost</c> for example, 
-        ///   and will resolve to an IPv4 address. In this case the remote server must allow access over IPv4.</td>
+        ///   and will be resolved to an IPv4 address. In this case the remote server must allow access over IPv4.</td>
         /// </tr>
         /// <tr>
         ///   <td><see cref="Protocol.Udp"/>, <see cref="Protocol.Tcp"/></td>
@@ -161,7 +161,7 @@ public interface INetworkLoggerSettings : ILoggerSettings
         ///   <td><see cref="Protocol.Udp"/>, <see cref="Protocol.Tcp"/></td>
         ///   <td><see cref="Address.IPv6"/></td><td>DNS&#160;name</td>
         ///   <td>The <em>Host</em> property can contain a DNS host name, such as <c>localhost</c> for example, 
-        ///   and will resolve to an IPv6 address. In this case the remote server must allow access over IPv6.</td>
+        ///   and will be resolved to an IPv6 address. In this case the remote server must allow access over IPv6.</td>
         /// </tr>
         /// <tr>
         ///   <td><see cref="Protocol.Web"/></td><td>Ignored</td><td>URL</td>
@@ -173,7 +173,7 @@ public interface INetworkLoggerSettings : ILoggerSettings
         ///   <see cref="Port"/> is set to zero.</li>
         ///   <li>The port number is taken from property <see cref="Port"/> if no port is included in the URL and 
         ///   property <see cref="Port"/> is not set to zero.</li>
-        ///   <li>The port number is taken from the URL and if property <see cref="Port"/> is not set to zero.</li>
+        ///   <li>The port number is taken from the URL and if property <see cref="Port"/> is set to zero.</li>
         ///   <li>The port number is taken from property <see cref="Port"/> if it is not set to zero and the port 
         ///   number in the URL is different from value of property <see cref="Port"/>.</li>
         ///   </ul>
@@ -194,7 +194,8 @@ public interface INetworkLoggerSettings : ILoggerSettings
         /// Gets or sets the target port.
         /// </summary>
         /// <remarks>
-        /// This property defines the port on which the target computer is listened to.
+        /// This property defines the port on which the target computer is listening 
+        /// for logging requests.
         /// </remarks>
         /// <value>
         /// The target port to be used.
@@ -358,7 +359,7 @@ public interface INetworkLoggerSettings : ILoggerSettings
         /// </para>
         /// <para>
         /// Attention, any client connection is closed automatically if this property is set to 
-        /// <c>false</c> OR a message already ends with a zero termination! Otherwise the client 
+        /// <c>false</c> OR a message does not already end with a zero termination! Otherwise the client 
         /// connection is kept open.
         /// </para>
         /// <para>
@@ -394,6 +395,32 @@ public interface INetworkLoggerSettings : ILoggerSettings
         /// </value>
         Int32 Timeout { get; set; }
 
+        /// <summary>
+        /// Gets and set the HTTP request method to be used.
+        /// </summary>
+        /// <remarks>
+        /// This property allows to change the the HTTP request method to be used. For 
+        /// the moment the method value is only used together with WEB requests!
+        /// </remarks>
+        /// <value>
+        /// The HTTP request method to use, e.g. POST, PUT or any other valid WEB request 
+        /// method. The default is POST.
+        /// </value>
+        String Method { get; set; }
+
+        /// <summary>
+        /// Gets and set the HTTP request content type to be used.
+        /// </summary>
+        /// <remarks>
+        /// This property allows to change the the HTTP request content type to be used. 
+        /// For the moment the content value is only used together with WEB requests!
+        /// </remarks>
+        /// <value>
+        /// The HTTP request content type to use, e.g. application/json, application/xml 
+        /// or any other valid WEB request content type. The default is application/json.
+        /// </value>
+        String Content { get; set; }
+
         #endregion
     }
 }

code/src/Plexdata.LogWriter.Network/Internals/Sockets/WebClientSocket.cs

@@ -107,11 +107,9 @@ public Boolean Connect()
 
             try
             {
-                // Method "POST" in conjunction with "application/json" is used
-                // for GELF requests, but might be used also for other requests.
                 this.client = this.factory.Create<IClientFacade>(
                     this.BuildRemoteUri(this.settings.Host, this.settings.Port),
-                    "POST", "application/json", this.settings.Timeout);
+                    this.settings.Method, this.settings.Content, this.settings.Timeout);
 
                 return true;
             }

code/src/Plexdata.LogWriter.Network/Settings/NetworkLoggerSettings.cs

@@ -124,11 +124,27 @@ public class NetworkLoggerSettings : LoggerSettings, INetworkLoggerSettings
         /// The default timeout value.
         /// </summary>
         /// <remarks>
-        /// The default timeout value is set to 100000 milliseconds (100 seconds) 
+        /// The default timeout value is set to <c>100000</c> milliseconds (100 seconds) 
         /// and has been taken from official Microsoft documentation.
         /// </remarks>
         private static readonly Int32 DefaultTimeout = 100000;
 
+        /// <summary>
+        /// The default method value.
+        /// </summary>
+        /// <remarks>
+        /// The default method value is set to <c>POST</c>.
+        /// </remarks>
+        private static readonly String DefaultMethod = "POST";
+
+        /// <summary>
+        /// The default content type.
+        /// </summary>
+        /// <remarks>
+        /// The default content type is set to <c>application/json</c>.
+        /// </remarks>
+        private static readonly String DefaultContent = "application/json";
+
         #endregion
 
         #region Private fields
@@ -223,6 +239,24 @@ public class NetworkLoggerSettings : LoggerSettings, INetworkLoggerSettings
         /// </remarks>
         private Int32 timeout;
 
+        /// <summary>
+        /// This field holds the method value to be used.
+        /// </summary>
+        /// <remarks>
+        /// The value of <see cref="NetworkLoggerSettings.DefaultMethod"/> 
+        /// is used as initial value.
+        /// </remarks>
+        private String method;
+
+        /// <summary>
+        /// This field holds the content value to be used.
+        /// </summary>
+        /// <remarks>
+        /// The value of <see cref="NetworkLoggerSettings.DefaultContent"/> 
+        /// is used as initial value.
+        /// </remarks>
+        private String content;
+
         #endregion
 
         #region Construction
@@ -254,6 +288,8 @@ public NetworkLoggerSettings()
             this.Maximum = NetworkLoggerSettings.DefaultMaximum;
             this.Termination = NetworkLoggerSettings.DefaultTermination;
             this.Timeout = NetworkLoggerSettings.DefaultTimeout;
+            this.Method = NetworkLoggerSettings.DefaultMethod;
+            this.Content = NetworkLoggerSettings.DefaultContent;
         }
 
         /// <summary>
@@ -459,6 +495,40 @@ public Int32 Timeout
             }
         }
 
+        /// <inheritdoc />
+        public String Method
+        {
+            get
+            {
+                return this.method;
+            }
+            set
+            {
+                if (this.method != value)
+                {
+                    this.method = value;
+                    base.RaisePropertyChanged(nameof(this.Method));
+                }
+            }
+        }
+
+        /// <inheritdoc />
+        public String Content
+        {
+            get
+            {
+                return this.content;
+            }
+            set
+            {
+                if (this.Content != value)
+                {
+                    this.content = value;
+                    base.RaisePropertyChanged(nameof(this.Content));
+                }
+            }
+        }
+
         #endregion
 
         #region Protected Methods
@@ -496,6 +566,8 @@ protected override void LoadSettings(ILoggerSettingsSection configuration)
             this.Maximum = base.GetValue(section[nameof(this.Maximum)], NetworkLoggerSettings.DefaultMaximum);
             this.Termination = base.GetValue(section[nameof(this.Termination)], NetworkLoggerSettings.DefaultTermination);
             this.Timeout = base.GetValue(section[nameof(this.Timeout)], NetworkLoggerSettings.DefaultTimeout);
+            this.Method = base.GetValue(section[nameof(this.Method)], NetworkLoggerSettings.DefaultMethod);
+            this.Content = base.GetValue(section[nameof(this.Content)], NetworkLoggerSettings.DefaultContent);
         }
 
         #endregion

code/src/Plexdata.LogWriter.Testing.Helper/Plexdata.LogWriter.Testing.Helper.csproj

@@ -73,6 +73,10 @@
       <Project>{726C7B51-8A48-4008-A47D-0B8467B9887F}</Project>
       <Name>Plexdata.LogWriter.Mail</Name>
     </ProjectReference>
+    <ProjectReference Include="..\Plexdata.LogWriter.Network\Plexdata.LogWriter.Network.csproj">
+      <Project>{FF61AF1E-E0D3-425F-B5C4-8EC9BA573AC6}</Project>
+      <Name>Plexdata.LogWriter.Network</Name>
+    </ProjectReference>
     <ProjectReference Include="..\Plexdata.LogWriter.Persistent\Plexdata.LogWriter.Persistent.csproj">
       <Project>{B38DA898-A77E-4988-BEA0-5E69839D1499}</Project>
       <Name>Plexdata.LogWriter.Persistent</Name>