Class MetricsTimer

Helper class for timing operations and recording metrics

Index

Constructors

Methods

cancelled error success timeout

Constructors

constructor

new MetricsTimer(
    handler: MetricsHandler,
    operation: OperationType,
    metadata?: Record<string, string | number | boolean>,
): MetricsTimer
Parameters
- handler: MetricsHandler
- operation: OperationType
- Optionalmetadata: Record<string, string | number | boolean>
Returns MetricsTimer
- Defined in metrics.ts:367

Methods

cancelled

cancelled(
err?: Error,
additionalMetadata?: Record<string, string | number | boolean>,
): number
Record cancellation and return duration
Parameters
- Optionalerr: Error
- OptionaladditionalMetadata: Record<string, string | number | boolean>
Returns number
- Defined in metrics.ts:402

error

error(
err: Error,
additionalMetadata?: Record<string, string | number | boolean>,
): number
Record error and return duration
Parameters
- err: Error
- OptionaladditionalMetadata: Record<string, string | number | boolean>
Returns number
- Defined in metrics.ts:388

success

success(additionalMetadata?: Record<string, string | number | boolean>): number
Record success and return duration
Parameters
- OptionaladditionalMetadata: Record<string, string | number | boolean>
Returns number
- Defined in metrics.ts:381

timeout

timeout(
err?: Error,
additionalMetadata?: Record<string, string | number | boolean>,
): number
Record timeout and return duration
Parameters
- Optionalerr: Error
- OptionaladditionalMetadata: Record<string, string | number | boolean>
Returns number
- Defined in metrics.ts:395