Class InstrumentationTimer

Namespace

Xping.Sdk.Core.Common

Assembly

Xping.Sdk.Core.dll

This class provides a set utilities that can be used to log data related to code execution time.

public sealed class InstrumentationTimer : IInstrumentation, IDisposable

Inheritance

object

InstrumentationTimer

Implements

IInstrumentation

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Examples

using (var log = InstrumentationTimer())
{
    // start of the code for which to measure execution time
    // end of the code
    Console.WriteLine($"Code started at {log.StartTime} and took {log.ElapsedTime.TotalMilliseconds} [ms] to run. 
}

Constructors

InstrumentationTimer(Action<InstrumentationTimer>?, bool)

Initializes a new instance of the InstrumentationTimer class.

public InstrumentationTimer(Action<InstrumentationTimer>? callback = null, bool startStopwatch = true)

Parameters

callback Action<InstrumentationTimer>

An optional callback action that will be invoked when the instance is disposed.

startStopwatch bool

A flag indicating whether to start the stopwatch automatically.

Properties

ElapsedMilliseconds

Gets the total elapsed time measured by the current instaince, in milliseconds.

public long ElapsedMilliseconds { get; }

Property Value

long

ElapsedTicks

Gets the total elapsed time measured by the current instance, in timer ticks.

public long ElapsedTicks { get; }

Property Value

long

ElapsedTime

Gets the total elapsed time measured by the current instance.

public TimeSpan ElapsedTime { get; }

Property Value

TimeSpan

IsRunning

Gets a value indicating whether the stopwatch timer is running.

public bool IsRunning { get; }

Property Value

bool

StartTime

Gets the time that the associated stopwatch was started.

public DateTime StartTime { get; }

Property Value

DateTime

Methods

Dispose()

Releases the resources used by the InstrumentationTimer instance.

public void Dispose()

Remarks

This method stops the stopwatch and invokes the callback action if provided.

Restart()

Stops time measurement, resets the elapsed time to zero and start time to current time and starts measuring.

public void Restart()