Class default

A timespan metric.

Timespans are used to make a measurement of how much time is spent in a particular task.

Hierarchy

default

Index

Constructors

Properties

Methods

cancel setRawNanos start stop testGetNumRecordedErrors testGetValue

Constructors

constructor

new default(meta: CommonMetricData, timeUnit: string): default
Parameters
- meta: CommonMetricData
- timeUnit: string
Returns default
- Defined in src/core/metrics/types/timespan.ts:289

Properties

`Private` #inner

#inner: InternalTimespanMetricType

Methods

cancel

cancel(): void
Aborts a previous start() call.

No error is recorded if no start() was called.

Returns void
- Defined in src/core/metrics/types/timespan.ts:318

setRawNanos

setRawNanos(elapsed: number): void
Explicitly sets the timespan value.

This API should only be used if your library or application requires recording times in a way that can not make use of start/stop.

Care should be taken using this if the ping lifetime might contain more than one timespan measurement. To be safe, this function should generally be followed by sending a custom ping containing the timespan.
Parameters
- elapsed: number
  
  The elapsed time to record, in nanoseconds.
Returns void
- Defined in src/core/metrics/types/timespan.ts:335

start

start(): void
Starts tracking time for the provided metric.

This records an error if it's already tracking time (i.e. start was already called with no corresponding stop(). In which case the original start time will be preserved.

Returns void
- Defined in src/core/metrics/types/timespan.ts:300

stop

stop(): void
Stops tracking time for the provided metric. Sets the metric to the elapsed time.

This will record an error if no start() was called.

Returns void
- Defined in src/core/metrics/types/timespan.ts:309

testGetNumRecordedErrors

testGetNumRecordedErrors(errorType: string, ping?: string): Promise<number>
Test-only API

Returns the number of errors recorded for the given metric.

Returns
the number of errors recorded for the metric.
Parameters
- errorType: string
  
  The type of the error recorded.
- ping: string = ...
  
  represents the name of the ping to retrieve the metric for. Defaults to the first value in sendInPings.
Returns Promise<number>
- Defined in src/core/metrics/types/timespan.ts:364

testGetValue

testGetValue(ping?: string): Promise<undefined | number>
Test-only API.**

Gets the currently stored value as a number.

This doesn't clear the stored value.

Returns
The value found in storage or undefined if nothing was found.
Parameters
- ping: string = ...
  
  the ping from which we want to retrieve this metrics value from. Defaults to the first value in sendInPings.
Returns Promise<undefined | number>
- Defined in src/core/metrics/types/timespan.ts:350

Generated using TypeDoc