Add XML docs required by CommentChecker fixes
All checks were successful
NuGet Package Publish / nuget (push) Successful in 1m13s

This commit is contained in:
Joseph Doherty
2026-02-23 04:39:25 -05:00
parent cce24fa8f3
commit 6c4714f666
15 changed files with 444 additions and 15 deletions

View File

@@ -57,6 +57,9 @@ public class SurrealLogStorageBenchmarks
private string _contextNumericKeyQueryValue = string.Empty;
private int _contextNumericValueQueryValue;
/// <summary>
/// Initializes the benchmark environment and seeds the dataset.
/// </summary>
[GlobalSetup]
public async Task GlobalSetupAsync()
{
@@ -97,6 +100,9 @@ public class SurrealLogStorageBenchmarks
$"RocksDB size: {sizeBytes / (1024d * 1024d):F2} MiB ({sizeBytes:N0} bytes). Path: {_databasePath}");
}
/// <summary>
/// Handles benchmark teardown for surreal log storage scenarios.
/// </summary>
[GlobalCleanup]
public Task GlobalCleanupAsync()
{
@@ -104,6 +110,9 @@ public class SurrealLogStorageBenchmarks
return Task.CompletedTask;
}
/// <summary>
/// Queries the latest log rows by context identifier.
/// </summary>
[Benchmark(Description = "Query by contextId (latest 200 rows)")]
public async Task QueryByContextIdAsync()
{
@@ -117,6 +126,9 @@ public class SurrealLogStorageBenchmarks
new Dictionary<string, object?> { ["contextId"] = _contextIdQueryValue });
}
/// <summary>
/// Queries the latest rows by logger and timestamp range.
/// </summary>
[Benchmark(Description = "Query by loggerName + timestamp range (latest 200 rows)")]
public async Task QueryByLoggerAndTimestampAsync()
{
@@ -137,6 +149,9 @@ public class SurrealLogStorageBenchmarks
});
}
/// <summary>
/// Queries rows by logger and context key/value pairs.
/// </summary>
[Benchmark(Description = "Query by loggerName + timestamp + arbitrary context string key/value")]
public async Task QueryByLoggerTimestampAndContextKeyAsync()
{
@@ -169,6 +184,9 @@ public class SurrealLogStorageBenchmarks
});
}
/// <summary>
/// Queries rows by logger and numeric context key/value pairs.
/// </summary>
[Benchmark(Description = "Query by loggerName + timestamp + arbitrary context number key/value")]
public async Task QueryByLoggerTimestampAndNumericContextKeyAsync()
{
@@ -201,6 +219,9 @@ public class SurrealLogStorageBenchmarks
});
}
/// <summary>
/// Reports RocksDB size for the seeded benchmark database.
/// </summary>
[Benchmark(Description = "RocksDB size (bytes)")]
public long GetDatabaseFileSizeBytes()
{