Improve XML documentation coverage across src modules and sync generated analysis artifacts.

This commit is contained in:
Joseph Doherty
2026-03-14 03:56:58 -04:00
parent ba0d65317a
commit 46ead5ea9f
152 changed files with 2821 additions and 11284 deletions

View File

@@ -7,12 +7,20 @@ public sealed class JszHandler
private readonly NatsServer _server;
private readonly NatsOptions _options;
/// <summary>
/// Creates a JetStream monitoring response builder bound to server runtime state.
/// </summary>
/// <param name="server">Running server instance exposing JetStream counters and IDs.</param>
/// <param name="options">Server options containing JetStream capacity configuration.</param>
public JszHandler(NatsServer server, NatsOptions options)
{
_server = server;
_options = options;
}
/// <summary>
/// Builds a point-in-time <c>/jsz</c> style response from current server state.
/// </summary>
public JszResponse Build()
{
return new JszResponse
@@ -38,33 +46,43 @@ public sealed class JszHandler
public sealed class JszResponse
{
/// <summary>Server identifier for the node producing this response.</summary>
[JsonPropertyName("server_id")]
public string ServerId { get; set; } = string.Empty;
/// <summary>UTC timestamp when this monitoring snapshot was generated.</summary>
[JsonPropertyName("now")]
public DateTime Now { get; set; }
/// <summary>Whether JetStream is enabled on this server.</summary>
[JsonPropertyName("enabled")]
public bool Enabled { get; set; }
/// <summary>JetStream memory usage in bytes.</summary>
[JsonPropertyName("memory")]
public ulong Memory { get; set; }
/// <summary>JetStream file-storage usage in bytes.</summary>
[JsonPropertyName("storage")]
public ulong Storage { get; set; }
/// <summary>Number of JetStream streams currently hosted.</summary>
[JsonPropertyName("streams")]
public int Streams { get; set; }
/// <summary>Number of JetStream consumers currently hosted.</summary>
[JsonPropertyName("consumers")]
public int Consumers { get; set; }
/// <summary>Total number of JetStream API requests handled.</summary>
[JsonPropertyName("api_total")]
public ulong ApiTotal { get; set; }
/// <summary>Total number of JetStream API requests that returned errors.</summary>
[JsonPropertyName("api_errors")]
public ulong ApiErrors { get; set; }
/// <summary>Configured JetStream resource limits and storage directory.</summary>
[JsonPropertyName("config")]
public JetStreamConfig Config { get; set; } = new();
}