Class TestMetricCollector

Thread-safe listener that captures metric measurements in memory.

public sealed class TestMetricCollector : ITestScenarioResource, IDisposable

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

Creates a bounded collector, optionally restricted to exact meter names.

public TestMetricCollector(TimeProvider? timeProvider = null, IEnumerable<string>? meterNames = null, int maximumMeasurements = 1000)

timeProvider TimeProvider: The clock used for measurement timestamps, or null to use System. The provider is retained but not owned or disposed.
meterNames IEnumerable<string>: Exact, case-sensitive meter names to capture, or null or an empty sequence to capture every meter. The sequence is enumerated immediately and duplicates are ignored.
maximumMeasurements int: The positive maximum number of measurements retained. The default is 1,000; when the bound is exceeded, the oldest measurements are discarded first.

Gets the number of currently captured measurements.

public int Count { get; }

Gets a stable copy of captured measurements in recording order.

public IReadOnlyList<TestMetricMeasurement> Measurements { get; }

IReadOnlyList<TestMetricMeasurement>: A newly allocated snapshot in recording order. The caller may retain the list. Measurements can contain unredacted tag values with sensitive or mutable data.

Captures the current state before a failed scenario is cleaned up.

public ValueTask<object?> CaptureDiagnosticsAsync(CancellationToken cancellationToken = default)

cancellationToken CancellationToken: Cancels diagnostic collection for this resource. The default token does not request cancellation. A thrown exception, including cancellation, is recorded as a diagnostic capture failure so cleanup can continue.

ValueTask<object>: A serializable diagnostic value, or null when the resource has no state to report. Ownership remains with the resource unless its implementation states otherwise.

Requests measurements from enabled observable instruments.

public void CollectObservableMeasurements()

This synchronously invokes enabled observable-instrument callbacks and appends the values they report. Callback exceptions propagate to the caller.

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

Removes every captured measurement and returns this collector.

public TestMetricCollector Reset()

TestMetricCollector: This collector, for chaining. Its listener, filters, clock, and maximum remain unchanged.

Clears mutable state before and after a scenario.

public ValueTask ResetAsync(CancellationToken cancellationToken = default)

cancellationToken CancellationToken: Cancels this reset attempt. The default token does not request cancellation. The factory continues resetting the remaining registered resources and reports all reset failures together.

ValueTask: A task that completes when the resource has finished resetting its state.

Starts a fluent assertion chain over captured measurements.

public TestMetricCollectorAssertions Should()

TestMetricCollectorAssertions: A new assertion object that reads this collector's current snapshots.