Class PerfTracing

Namespace

Ranorex.Core.Tracing

Assembly

Ranorex.Core.dll

Controls performance tracing settings for various Ranorex subsystems.

public static class PerfTracing

Inheritance

object

PerfTracing

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

ActiveTracers

The currently active performance tracers.

public static PerfTracers ActiveTracers { get; }

Property Value

PerfTracers

PreviousInterval

The most recent interval tracked by PerfTracing

public static IPerfInterval PreviousInterval { get; }

Property Value

IPerfInterval

Methods

Setup(ITraceWriter, PerfTracers)

Setup and activate performance tracing using a custom trace writer.

public static void Setup(ITraceWriter customWriter, PerfTracers tracers)

Parameters

customWriter ITraceWriter

A custom trace writer implementing ITraceWriter.

tracers PerfTracers

The tracers to activate.

SetupCsv(PerfTracers, string, string)

Setup and activate performance tracing using a CSV file.

public static void SetupCsv(PerfTracers tracers, string baseDir = null, string csvSeparator = ",")

Parameters

tracers PerfTracers

The tracers to activate.

baseDir string

The base directory for the trace files.

csvSeparator string

The separator character to use for CSV output.

TraceKeyboardInput(IPerfInterval, IReportMetadata, string, Duration)

Traces performance information related to a keyboard input action.

public static void TraceKeyboardInput(IPerfInterval interval, IReportMetadata reportMetadata, string type, Duration pressTime)

Parameters

interval IPerfInterval

The performance interval to trace.

reportMetadata IReportMetadata

Report metadata related to to this input action (e.g. a RepoItemInfo or RepoGenBaseFolder.

type string

The type of input action taken (e.g. press, up, down, sequence, ..)

pressTime Duration

The key press time configured for this action.

TraceMisc(IPerfInterval, string, string)

Traces performance information related to a generic action or event.

public static void TraceMisc(IPerfInterval interval, string type, string extra)

Parameters

interval IPerfInterval

The performance interval to trace.

type string

The type of action or event traced.

extra string

Extra information pertaining to this event or action.

TraceMouseInput(IPerfInterval, IReportMetadata, string, MouseButtons, int, Duration)

Traces performance information related to a mouse input action.

public static void TraceMouseInput(IPerfInterval interval, IReportMetadata reportMetadata, string type, MouseButtons buttons, int repeats, Duration moveTime)

Parameters

interval IPerfInterval

The performance interval to trace.

reportMetadata IReportMetadata

Report metadata related to to this input action (e.g. a RepoItemInfo or RepoGenBaseFolder.

type string

The type of input action taken (e.g. click, down, move, ..)

buttons MouseButtons

The mouse buttons involved in the input action.

repeats int

The number of repeats for this action (e.g. two for a double-click)

moveTime Duration

The mouse move time configured for this action.

TraceRepoFolder(IPerfInterval, RepoGenBaseFolder, Duration, int, bool)

Traces performance information related to a repository folder.

public static void TraceRepoFolder(IPerfInterval interval, RepoGenBaseFolder folder, Duration actualSearchTime, int iters, bool success)

Parameters

interval IPerfInterval

The performance interval to trace.

folder RepoGenBaseFolder

The repository folder to trace.

actualSearchTime Duration

The actual time spent searching for folder.

iters int

Number of iterations needed for finding the folder.

success bool

Whether the search operation was a success or not.

TraceRepoItem(IPerfInterval, RepoItemInfo, Duration, int, bool)

Traces performance information related to a repository item.

public static void TraceRepoItem(IPerfInterval interval, RepoItemInfo item, Duration actualSearchTime, int iters, bool success)

Parameters

interval IPerfInterval

The performance interval to trace.

item RepoItemInfo

The repository item info to trace.

actualSearchTime Duration

The actual time spent searching for item.

iters int

Number of iterations needed for finding the item.

success bool

Whether the search operation was a success or not.