Cleanup code

phnx47 · phnx47 · commit 9c7a8d872a52 · 2017-05-09T19:36:57.000+03:00
diff --git a/src/Prometheus.Client.MetricServer/BaseMetricServer.cs b/src/Prometheus.Client.MetricServer/BaseMetricServer.cs
@@ -3,11 +3,20 @@
 
 namespace Prometheus.Client.MetricServer
 {
-    public abstract class MetricHandler 
+    /// <summary>
+    ///     Base Abstract MetricSever
+    /// </summary>
+    public abstract class BaseMetricServer
     {
+        /// <summary>
+        ///     CollectorRegistry
+        /// </summary>
         protected readonly ICollectorRegistry Registry;
 
-        protected MetricHandler(IEnumerable<IOnDemandCollector> standardCollectors = null,
+        /// <summary>
+        ///     Constructor
+        /// </summary>
+        protected BaseMetricServer(IEnumerable<IOnDemandCollector> standardCollectors = null,
             ICollectorRegistry registry = null)
         {
             Registry = registry ?? CollectorRegistry.Instance;
@@ -19,6 +28,5 @@ protected MetricHandler(IEnumerable<IOnDemandCollector> standardCollectors = nul
 
             CollectorRegistry.Instance.RegisterOnDemandCollectors(standardCollectors);
         }
-
     }
-}
+}
diff --git a/src/Prometheus.Client.MetricServer/IMetricServer.cs b/src/Prometheus.Client.MetricServer/IMetricServer.cs
@@ -1,5 +1,8 @@
 ﻿namespace Prometheus.Client.MetricServer
 {
+    /// <summary>
+    ///     MetricSever
+    /// </summary>
     public interface IMetricServer
     {
         /// <summary>
diff --git a/src/Prometheus.Client.MetricServer/MetricServer.HttpListener.cs b/src/Prometheus.Client.MetricServer/MetricServer.HttpListener.cs
@@ -6,26 +6,40 @@
 
 namespace Prometheus.Client.MetricServer
 {
-    public class MetricServer : MetricHandler, IMetricServer
+    /// <summary>
+    ///     MetricSever based of HttpListener
+    /// </summary>
+    public class MetricServer : BaseMetricServer, IMetricServer
     {
         private readonly HttpListener _httpListener = new HttpListener();
 
+        /// <summary>
+        ///     Constructor
+        /// </summary>
         public MetricServer(int port, bool useHttps = false)
             : this("+", port, Consts.DefaultUrl, null, null, useHttps)
         {
         }
 
+        /// <summary>
+        ///     Constructor
+        /// </summary>
         public MetricServer(string host, int port, bool useHttps = false)
             : this(host, port, Consts.DefaultUrl, null, null, useHttps)
         {
-
         }
 
+        /// <summary>
+        ///     Constructor
+        /// </summary>
         public MetricServer(string host, int port, string url, bool useHttps = false)
             : this(host, port, url, null, null, useHttps)
         {
         }
 
+        /// <summary>
+        ///     Constructor
+        /// </summary>
         public MetricServer(string hostname, int port, string url, IEnumerable<IOnDemandCollector> standardCollectors = null, ICollectorRegistry registry = null, bool useHttps = false)
             : base(standardCollectors, registry)
         {
@@ -57,7 +71,6 @@ public void Start()
                 }
 
                 response.Close();
-
             }, null);
         }
 
diff --git a/src/Prometheus.Client.MetricServer/MetricServer.Kestrel.cs b/src/Prometheus.Client.MetricServer/MetricServer.Kestrel.cs
@@ -12,28 +12,43 @@
 
 namespace Prometheus.Client.MetricServer
 {
-    public class MetricServer : MetricHandler, IMetricServer
+
+    /// <summary>
+    ///     MetricSever based of Kestrel
+    /// </summary>
+    public class MetricServer : BaseMetricServer, IMetricServer
     {
         private readonly X509Certificate2 _certificate;
         private readonly string _hostAddress;
         private IWebHost _host;
 
+        /// <summary>
+        ///     Constructor
+        /// </summary>
         public MetricServer(int port, bool useHttps = false)
             : this("+", port, Consts.DefaultUrl, null, null, null, useHttps)
         {
         }
 
+        /// <summary>
+        ///     Constructor
+        /// </summary>
         public MetricServer(string host, int port, bool useHttps = false)
             : this(host, port, Consts.DefaultUrl, null, null, null, useHttps)
         {
-
         }
 
+        /// <summary>
+        ///     Constructor
+        /// </summary>
         public MetricServer(string host, int port, string url, bool useHttps = false)
             : this(host, port, url, null, null, null, useHttps)
         {
         }
 
+        /// <summary>
+        ///     Constructor
+        /// </summary>
         public MetricServer(string hostname, int port, string url, IEnumerable<IOnDemandCollector> standardCollectors = null, ICollectorRegistry registry = null, X509Certificate2 certificate = null, bool useHttps = false)
             : base(standardCollectors, registry)
         {
@@ -46,6 +61,9 @@ public MetricServer(string hostname, int port, string url, IEnumerable<IOnDemand
         }
 
 
+        /// <summary>
+        ///     Server is Running?
+        /// </summary>
         public bool IsRunning => _host != null;
 
         /// <inheritdoc />
diff --git a/src/Prometheus.Client.MetricServer/Prometheus.Client.MetricServer.csproj b/src/Prometheus.Client.MetricServer/Prometheus.Client.MetricServer.csproj
@@ -15,6 +15,8 @@
     <PackageLicenseUrl>https://opensource.org/licenses/MIT</PackageLicenseUrl>
     <RepositoryType>git</RepositoryType>
     <RepositoryUrl>https://github.com/phnx47/Prometheus.MetricServer</RepositoryUrl>
+    <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
   </PropertyGroup>
 
   <ItemGroup>

Original file line number	Diff line number	Diff line change
`@@ -3,11 +3,20 @@`
`3`	`3`
`4`	`4`	`namespace Prometheus.Client.MetricServer`
`5`	`5`	`{`
`6`		`- public abstract class MetricHandler`
	`6`	`+ /// <summary>`
	`7`	`+ /// Base Abstract MetricSever`
	`8`	`+ /// </summary>`
	`9`	`+ public abstract class BaseMetricServer`
`7`	`10`	`{`
	`11`	`+ /// <summary>`
	`12`	`+ /// CollectorRegistry`
	`13`	`+ /// </summary>`
`8`	`14`	`protected readonly ICollectorRegistry Registry;`
`9`	`15`
`10`		`- protected MetricHandler(IEnumerable<IOnDemandCollector> standardCollectors = null,`
	`16`	`+ /// <summary>`
	`17`	`+ /// Constructor`
	`18`	`+ /// </summary>`
	`19`	`+ protected BaseMetricServer(IEnumerable<IOnDemandCollector> standardCollectors = null,`
`11`	`20`	`ICollectorRegistry registry = null)`
`12`	`21`	`{`
`13`	`22`	`Registry = registry ?? CollectorRegistry.Instance;`
`@@ -19,6 +28,5 @@ protected MetricHandler(IEnumerable<IOnDemandCollector> standardCollectors = nul`
`19`	`28`
`20`	`29`	`CollectorRegistry.Instance.RegisterOnDemandCollectors(standardCollectors);`
`21`	`30`	`}`
`22`		`-`
`23`	`31`	`}`
`24`		`-}`
	`32`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,8 @@`
`1`	`1`	`namespace Prometheus.Client.MetricServer`
`2`	`2`	`{`
	`3`	`+ /// <summary>`
	`4`	`+ /// MetricSever`
	`5`	`+ /// </summary>`
`3`	`6`	`public interface IMetricServer`
`4`	`7`	`{`
`5`	`8`	`/// <summary>`
Original file line number	Diff line number	Diff line change
`@@ -6,26 +6,40 @@`
`6`	`6`
`7`	`7`	`namespace Prometheus.Client.MetricServer`
`8`	`8`	`{`
`9`		`- public class MetricServer : MetricHandler, IMetricServer`
	`9`	`+ /// <summary>`
	`10`	`+ /// MetricSever based of HttpListener`
	`11`	`+ /// </summary>`
	`12`	`+ public class MetricServer : BaseMetricServer, IMetricServer`
`10`	`13`	`{`
`11`	`14`	`private readonly HttpListener _httpListener = new HttpListener();`
`12`	`15`
	`16`	`+ /// <summary>`
	`17`	`+ /// Constructor`
	`18`	`+ /// </summary>`
`13`	`19`	`public MetricServer(int port, bool useHttps = false)`
`14`	`20`	`: this("+", port, Consts.DefaultUrl, null, null, useHttps)`
`15`	`21`	`{`
`16`	`22`	`}`
`17`	`23`
	`24`	`+ /// <summary>`
	`25`	`+ /// Constructor`
	`26`	`+ /// </summary>`
`18`	`27`	`public MetricServer(string host, int port, bool useHttps = false)`
`19`	`28`	`: this(host, port, Consts.DefaultUrl, null, null, useHttps)`
`20`	`29`	`{`
`21`		`-`
`22`	`30`	`}`
`23`	`31`
	`32`	`+ /// <summary>`
	`33`	`+ /// Constructor`
	`34`	`+ /// </summary>`
`24`	`35`	`public MetricServer(string host, int port, string url, bool useHttps = false)`
`25`	`36`	`: this(host, port, url, null, null, useHttps)`
`26`	`37`	`{`
`27`	`38`	`}`
`28`	`39`
	`40`	`+ /// <summary>`
	`41`	`+ /// Constructor`
	`42`	`+ /// </summary>`
`29`	`43`	`public MetricServer(string hostname, int port, string url, IEnumerable<IOnDemandCollector> standardCollectors = null, ICollectorRegistry registry = null, bool useHttps = false)`
`30`	`44`	`: base(standardCollectors, registry)`
`31`	`45`	`{`
`@@ -57,7 +71,6 @@ public void Start()`
`57`	`71`	`}`
`58`	`72`
`59`	`73`	`response.Close();`
`60`		`-`
`61`	`74`	`}, null);`
`62`	`75`	`}`
`63`	`76`
Original file line number	Diff line number	Diff line change
`@@ -12,28 +12,43 @@`
`12`	`12`
`13`	`13`	`namespace Prometheus.Client.MetricServer`
`14`	`14`	`{`
`15`		`- public class MetricServer : MetricHandler, IMetricServer`
	`15`	`+`
	`16`	`+ /// <summary>`
	`17`	`+ /// MetricSever based of Kestrel`
	`18`	`+ /// </summary>`
	`19`	`+ public class MetricServer : BaseMetricServer, IMetricServer`
`16`	`20`	`{`
`17`	`21`	`private readonly X509Certificate2 _certificate;`
`18`	`22`	`private readonly string _hostAddress;`
`19`	`23`	`private IWebHost _host;`
`20`	`24`
	`25`	`+ /// <summary>`
	`26`	`+ /// Constructor`
	`27`	`+ /// </summary>`
`21`	`28`	`public MetricServer(int port, bool useHttps = false)`
`22`	`29`	`: this("+", port, Consts.DefaultUrl, null, null, null, useHttps)`
`23`	`30`	`{`
`24`	`31`	`}`
`25`	`32`
	`33`	`+ /// <summary>`
	`34`	`+ /// Constructor`
	`35`	`+ /// </summary>`
`26`	`36`	`public MetricServer(string host, int port, bool useHttps = false)`
`27`	`37`	`: this(host, port, Consts.DefaultUrl, null, null, null, useHttps)`
`28`	`38`	`{`
`29`		`-`
`30`	`39`	`}`
`31`	`40`
	`41`	`+ /// <summary>`
	`42`	`+ /// Constructor`
	`43`	`+ /// </summary>`
`32`	`44`	`public MetricServer(string host, int port, string url, bool useHttps = false)`
`33`	`45`	`: this(host, port, url, null, null, null, useHttps)`
`34`	`46`	`{`
`35`	`47`	`}`
`36`	`48`
	`49`	`+ /// <summary>`
	`50`	`+ /// Constructor`
	`51`	`+ /// </summary>`
`37`	`52`	`public MetricServer(string hostname, int port, string url, IEnumerable<IOnDemandCollector> standardCollectors = null, ICollectorRegistry registry = null, X509Certificate2 certificate = null, bool useHttps = false)`
`38`	`53`	`: base(standardCollectors, registry)`
`39`	`54`	`{`
`@@ -46,6 +61,9 @@ public MetricServer(string hostname, int port, string url, IEnumerable<IOnDemand`
`46`	`61`	`}`
`47`	`62`
`48`	`63`
	`64`	`+ /// <summary>`
	`65`	`+ /// Server is Running?`
	`66`	`+ /// </summary>`
`49`	`67`	`public bool IsRunning => _host != null;`
`50`	`68`
`51`	`69`	`/// <inheritdoc />`