Simple .NET tool for recording and reporting performance for multipe steps
Install the PerformanceCounter NuGet Package
dotnet add package Whojoo.PerformanceCounter
An example usage could be like the following, taking from one of the samples:
app.MapGet("/test", async (ILogger<Program> logger) =>
{
// Create the counter, this automatically starts the counter and will log to Information
var performanceCounter = PerformanceCounterFactory.Start(logger);
// Record without returning a result
performanceCounter.RecordStep("SyncRecordNoResult", () =>
{
foreach (var step in Enumerable.Range(1, 1_000_000))
{
var foo = int.MaxValue - step;
}
});
// Record and take the result which could be used at a later step if required
var recordSyncResult = performanceCounter.RecordStep("SyncRecordWithResult", () =>
{
var returnResult = int.MaxValue;
foreach (var step in Enumerable.Range(1, 1_000_000))
{
returnResult -= step;
}
return returnResult;
});
// Supports async methods as well
await performanceCounter.RecordStepAsync("AsyncRecordNoResult", async () =>
{
await Task.Delay(TimeSpan.FromMilliseconds(500));
});
var recordAsyncResult = await performanceCounter.RecordStepAsync(
"AsyncRecordWithResult",
async () =>
{
await Task.Delay(TimeSpan.FromMilliseconds(500));
return 500;
});
// Report() to report all the performance details in a single structure log message.
performanceCounter.Report();
return recordAsyncResult + recordSyncResult;
});This produces the following result in the Console:
info: Program[0]
Reporting performance counter PerformanceTest
- Step SyncRecordNoResult: 8.8065 ms
- Step SyncRecordWithResult: 5.4439 ms
- Step AsyncRecordNoResult: 500.6646 ms
- Step AsyncRecordWithResult: 501.8499 ms
- Total elapsed: 1016,7649 ms
And the following structured logging: