Merge pull request #150 from prom-client-net/improve-xml-doc-summaries

improve xml documentation

Author: phnx47

README.md

@@ -6,9 +6,9 @@
 [![codecov](https://img.shields.io/codecov/c/github/prom-client-net/prom-client-metricpusher?logo=codecov&style=flat-square)](https://app.codecov.io/gh/prom-client-net/prom-client-metricpusher)
 [![license](https://img.shields.io/github/license/prom-client-net/prom-client-metricpusher?style=flat-square)](https://github.com/prom-client-net/prom-client-metricpusher/blob/main/LICENSE)
 
-## PushGateway
+## Pushgateway
 
-Sometimes when it is not possible to pull e.g. - nodes behind LB or there is a worker like daemon or windows service that does not have HTTP endpoint still there is way to push your metrics to PushGateaway server that you can install from [here](https://github.com/prometheus/pushgateway/releases).
+Sometimes when it is not possible to pull e.g. - nodes behind LB or there is a worker like daemon or windows service that does not have HTTP endpoint still there is way to push your metrics to Pushgateway server that you can install from [here](https://github.com/prometheus/pushgateway/releases).
 
 ## Install
 
@@ -20,7 +20,7 @@ dotnet add package Prometheus.Client.MetricPusher
 
 [Examples](https://github.com/prom-client-net/prom-examples)
 
-One push. You can use Timer for regularly push to PushGateway:
+One push. You can use Timer for regularly push to Pushgateway:
 
 ```c#
 var pusher = new MetricPusher(new MetricPusherOptions

src/IMetricPushServer.cs

@@ -1,19 +1,22 @@
 namespace Prometheus.Client.MetricPusher;
 
+/// <summary>
+/// Interface for metric push server that periodically pushes metrics.
+/// </summary>
 public interface IMetricPushServer
 {
     /// <summary>
-    ///     Server is Running?
+    /// Get a value indicating whether the server is currently running.
     /// </summary>
     bool IsRunning { get; }
 
     /// <summary>
-    ///     Start Metric Push Server
+    /// Start the metric push server.
     /// </summary>
     void Start();
 
     /// <summary>
-    ///     Stop Metric Push Server
+    /// Stop the metric push server.
     /// </summary>
     void Stop();
 }

src/IMetricPusher.cs

@@ -3,12 +3,12 @@
 namespace Prometheus.Client.MetricPusher;
 
 /// <summary>
-///     Service for Push Gateway
+/// Interface for pushing metrics to Prometheus Pushgateway.
 /// </summary>
 public interface IMetricPusher
 {
     /// <summary>
-    ///     Push metrics to single pushgateway endpoint
+    /// Push metrics to the configured Pushgateway endpoint.
     /// </summary>
     Task PushAsync();
 }

src/MetricPushServer.cs

@@ -5,21 +5,37 @@
 
 namespace Prometheus.Client.MetricPusher;
 
+/// <summary>
+/// Server that periodically pushes metrics using configured pushers.
+/// </summary>
 public class MetricPushServer(IMetricPusher[] metricPushers, TimeSpan pushInterval) : IMetricPushServer
 {
     private CancellationTokenSource _cts;
     private Task _task;
 
+    /// <summary>
+    /// Initialize a new instance of the <see cref="MetricPushServer"/> class with a single pusher.
+    /// </summary>
+    /// <param name="metricPusher">The <see cref="IMetricPusher"/> instance.</param>
     public MetricPushServer(IMetricPusher metricPusher)
         : this([metricPusher])
     {
     }
 
+    /// <summary>
+    /// Initialize a new instance of the <see cref="MetricPushServer"/> class with a single pusher and interval.
+    /// </summary>
+    /// <param name="metricPusher">The <see cref="IMetricPusher"/> instance.</param>
+    /// <param name="pushInterval">The interval between pushes.</param>
     public MetricPushServer(IMetricPusher metricPusher, TimeSpan pushInterval)
         : this([metricPusher], pushInterval)
     {
     }
 
+    /// <summary>
+    /// Initialize a new instance of the <see cref="MetricPushServer"/> class with multiple pushers.
+    /// </summary>
+    /// <param name="metricPushers">The array of <see cref="IMetricPusher"/> instances.</param>
     public MetricPushServer(IMetricPusher[] metricPushers)
         : this(metricPushers, TimeSpan.FromMilliseconds(1000))
     {

src/MetricPusher.cs

@@ -7,13 +7,19 @@
 
 namespace Prometheus.Client.MetricPusher;
 
+/// <summary>
+/// Implementation of metric pusher for Prometheus Pushgateway.
+/// </summary>
 public class MetricPusher : IMetricPusher, IDisposable
 {
     private readonly HttpClient _httpClient;
     private readonly bool _isOwnHttpClient;
     private readonly ICollectorRegistry _collectorRegistry;
     private readonly Uri _targetUri;
 
+    /// <summary>
+    /// Get the target URI for Pushgateway endpoint.
+    /// </summary>
     public Uri TargetUri => _targetUri;
 
     public MetricPusher(MetricPusherOptions options)

src/MetricPusherOptions.cs

@@ -4,19 +4,43 @@
 
 namespace Prometheus.Client.MetricPusher;
 
+/// <summary>
+/// Configuration options for the metric pusher.
+/// </summary>
 public class MetricPusherOptions
 {
+    /// <summary>
+    /// The <see cref="ICollectorRegistry"/> instance to use for metric collection.
+    /// </summary>
     public ICollectorRegistry CollectorRegistry { get; set; }
 
+    /// <summary>
+    /// The Pushgateway endpoint URL.
+    /// </summary>
     public string Endpoint { get; set; }
 
+    /// <summary>
+    /// The job name for metrics.
+    /// </summary>
     public string Job { get; set; }
 
+    /// <summary>
+    /// The instance name for metrics.
+    /// </summary>
     public string Instance { get; set; }
 
+    /// <summary>
+    /// Additional labels to include with metrics.
+    /// </summary>
     public IEnumerable<KeyValuePair<string, string>> AdditionalLabels { get; set; }
 
+    /// <summary>
+    /// Additional HTTP headers to include in requests.
+    /// </summary>
     public IEnumerable<KeyValuePair<string, string>> AdditionalHeaders { get; set; }
 
+    /// <summary>
+    /// The HTTP client to use for requests.
+    /// </summary>
     public HttpClient HttpClient { get; set; }
 }

src/Prometheus.Client.MetricPusher.csproj

@@ -1,6 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
-    <Description>Push metrics to PushGateaway for Prometheus.Client</Description>
+    <Description>Push metrics to Pushgateaway for Prometheus.Client</Description>
     <TargetFrameworks>net462;netstandard2.0;net8.0</TargetFrameworks>
     <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
     <RepositoryUrl>https://github.com/prom-client-net/prom-client-metricpusher</RepositoryUrl>

tests/MetricPusherIntegrationTests.cs

@@ -8,7 +8,7 @@
 
 namespace Prometheus.Client.MetricPusher.Tests;
 
-public class MetricPusherIntegrationTests(PushGatewayFixture fixture, ITestOutputHelper output) : IClassFixture<PushGatewayFixture>
+public class MetricPusherIntegrationTests(PushgatewayFixture fixture, ITestOutputHelper output) : IClassFixture<PushgatewayFixture>
 {
     private readonly string _endpoint = fixture.GetEndpoint();
     private readonly IMetricFactory _metricFactory = new MetricFactory(new CollectorRegistry());

tests/PushGatewayFixture.cs renamed to tests/PushgatewayFixture.cs

@@ -6,7 +6,7 @@
 
 namespace Prometheus.Client.MetricPusher.Tests;
 
-public class PushGatewayFixture : IAsyncLifetime
+public class PushgatewayFixture : IAsyncLifetime
 {
     private readonly IContainer _container = new ContainerBuilder()
         .WithImage("prom/pushgateway")