Interface IPerformance

Namespace

Selenium.WebDriver.BiDi.Cdp.Performance

Assembly

Selenium.WebDriver.BiDi.Cdp.dll

public interface IPerformance

Properties

Metrics

Current values of the metrics.

IEventSource<MetricsEventArgs> Metrics { get; }

Property Value

IEventSource<MetricsEventArgs>

Remarks

Event args (MetricsEventArgs):

• Metrics - Current values of the metrics.
• Title - Timestamp title.

Methods

DisableAsync(string?, CancellationToken)

Disable collecting and reporting metrics.

Task<DisableResult> DisableAsync(string? session = null, CancellationToken cancellationToken = default)

Parameters

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<DisableResult>

A task representing the asynchronous operation, containing a DisableResult.

EnableAsync(string?, string?, CancellationToken)

Enable collecting and reporting metrics.

Task<EnableResult> EnableAsync(string? timeDomain = null, string? session = null, CancellationToken cancellationToken = default)

Parameters

timeDomain string

Time domain to use for collecting and reporting duration metrics.

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<EnableResult>

A task representing the asynchronous operation, containing a EnableResult.

GetMetricsAsync(string?, CancellationToken)

Retrieve current values of run-time metrics.

Task<GetMetricsResult> GetMetricsAsync(string? session = null, CancellationToken cancellationToken = default)

Parameters

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<GetMetricsResult>

A task representing the asynchronous operation, containing a GetMetricsResult.

SetTimeDomainAsync(string, string?, CancellationToken)

Sets time domain to use for collecting and reporting duration metrics. Note that this must be called before enabling metrics collection. Calling this method while metrics collection is enabled returns an error.

[Experimental("BIDICDP001")]
[Obsolete]
Task<SetTimeDomainResult> SetTimeDomainAsync(string timeDomain, string? session = null, CancellationToken cancellationToken = default)

Parameters

timeDomain string

Time domain

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<SetTimeDomainResult>

A task representing the asynchronous operation, containing a SetTimeDomainResult.