Skip to content

Commit 964da5e

Browse files
committed
improve options summary comments
1 parent a2ed1a2 commit 964da5e

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

src/PrometheusOptions.cs

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,40 @@
1-
using System;
21
using System.Text;
32
using Prometheus.Client.Collectors;
43

54
namespace Prometheus.Client.AspNetCore;
65

76
/// <summary>
8-
/// Options for Prometheus
7+
/// Configuration options for Prometheus metrics middleware.
98
/// </summary>
109
public class PrometheusOptions
1110
{
1211
/// <summary>
13-
/// Url, default = "/metrics"
12+
/// The endpoint path for metrics. Default is "/metrics".
1413
/// </summary>
1514
public string MapPath { get; set; } = Defaults.MapPath;
1615

1716
/// <summary>
18-
/// When specified only allow access to metrics on this port, otherwise return 404
17+
/// Port restriction for metrics endpoint.
1918
/// </summary>
2019
public int? Port { get; set; }
2120

2221
/// <summary>
23-
/// CollectorRegistry instance.
22+
/// The <see cref="ICollectorRegistry"/> instance to use for metric collection.
2423
/// </summary>
2524
public ICollectorRegistry CollectorRegistry { get; set; }
2625

2726
/// <summary>
28-
/// Use default collectors
27+
/// Whether to register default system metric collectors. Default is <c>true</c>.
2928
/// </summary>
3029
public bool UseDefaultCollectors { get; set; } = true;
3130

3231
/// <summary>
33-
/// Charset of text response.
32+
/// The text encoding for response content.
3433
/// </summary>
3534
public Encoding ResponseEncoding { get; set; }
3635

3736
/// <summary>
38-
/// Metric prefix for Default collectors
37+
/// Metric name prefix for default collectors.
3938
/// </summary>
4039
public string MetricPrefixName { get; set; } = string.Empty;
4140
}

0 commit comments

Comments
 (0)