Class PerformanceTimer

Manual performance timer for complex operations.

Index

Constructors

constructor

new PerformanceTimer(
    operationName: string,
    logger: {
        debug: (msg: string, ctx?: Record<string, unknown>) => void;
        error: (msg: string, err?: Error, ctx?: Record<string, unknown>) => void;
        info: (msg: string, ctx?: Record<string, unknown>) => void;
        trace: (msg: string, ctx?: Record<string, unknown>) => void;
        warn: (msg: string, ctx?: Record<string, unknown>) => void;
    },
    context?: Record<string, unknown>,
): PerformanceTimer
Create a new performance timer.
Parameters
- operationName: string
  Human-readable name for the operation being timed
- logger: {
      debug: (msg: string, ctx?: Record<string, unknown>) => void;
      error: (msg: string, err?: Error, ctx?: Record<string, unknown>) => void;
      info: (msg: string, ctx?: Record<string, unknown>) => void;
      trace: (msg: string, ctx?: Record<string, unknown>) => void;
      warn: (msg: string, ctx?: Record<string, unknown>) => void;
  }
  Logger instance for recording timing information
  - debug: (msg: string, ctx?: Record<string, unknown>) => void
    Debug level logging
  - error: (msg: string, err?: Error, ctx?: Record<string, unknown>) => void
    Error level logging
  - info: (msg: string, ctx?: Record<string, unknown>) => void
    Info level logging
  - trace: (msg: string, ctx?: Record<string, unknown>) => void
    Trace level logging
  - warn: (msg: string, ctx?: Record<string, unknown>) => void
    Warning level logging
- Optionalcontext: Record<string, unknown>
  Optional context information to include in logs
Returns PerformanceTimer
- Defined in src/services/logging/performanceLogger.ts:322

Properties

`Private`checkpoints

checkpoints: { memory: MemorySnapshot; name: string; time: number }[] = []

List of checkpoints recorded during operation.

Type Declaration

memory: MemorySnapshot
Memory snapshot at checkpoint
name: string
Checkpoint name
time: number
Time when checkpoint was recorded (milliseconds)

`Private` `Optional`context

context?: Record<string, unknown>

Optional context information to include in logs

`Private`logger

logger: {
    debug: (msg: string, ctx?: Record<string, unknown>) => void;
    error: (msg: string, err?: Error, ctx?: Record<string, unknown>) => void;
    info: (msg: string, ctx?: Record<string, unknown>) => void;
    trace: (msg: string, ctx?: Record<string, unknown>) => void;
    warn: (msg: string, ctx?: Record<string, unknown>) => void;
}

Logger instance for recording timing information

Type Declaration

debug: (msg: string, ctx?: Record<string, unknown>) => void
Debug level logging
error: (msg: string, err?: Error, ctx?: Record<string, unknown>) => void
Error level logging
info: (msg: string, ctx?: Record<string, unknown>) => void
Info level logging
trace: (msg: string, ctx?: Record<string, unknown>) => void
Trace level logging
warn: (msg: string, ctx?: Record<string, unknown>) => void
Warning level logging

`Private`operationName

operationName: string

Human-readable name for the operation being timed

`Private` `Optional`startMemory

startMemory?: MemorySnapshot

Initial memory snapshot.

`Private` `Optional`startTime

startTime?: number

Start time in milliseconds.

Methods

`Private`calculateMemoryDelta

calculateMemoryDelta(start: MemorySnapshot, end: MemorySnapshot): MemoryDelta
Private
Calculate memory usage delta between two snapshots.
Parameters
- start: MemorySnapshot
  Starting memory snapshot
- end: MemorySnapshot
  Ending memory snapshot
Returns MemoryDelta
Memory delta with human-readable formatted values
- Defined in src/services/logging/performanceLogger.ts:461

`Private`categorizePerformance

categorizePerformance(durationMs: number): string
Private
Categorize performance based on duration in milliseconds.
Parameters
- durationMs: number
  Duration in milliseconds
Returns string
Performance category: 'fast', 'normal', 'slow', or 'very_slow'
- Defined in src/services/logging/performanceLogger.ts:480

checkpoint

checkpoint(name?: string): void
Add a checkpoint with optional name. Records current time and memory snapshot.
Parameters
- Optionalname: string
  Optional name for the checkpoint
Returns void
void

Throws
Error if timer has not been started
- Defined in src/services/logging/performanceLogger.ts:365

end

end(status?: "success" | "failure" | "cancelled"): void
End the timer and log final results. Logs total duration, checkpoint summary, and memory delta. Resets the timer after logging.
Parameters
- status: "success" | "failure" | "cancelled" = "success"
  Operation status: 'success', 'failure', or 'cancelled' (default: 'success')
Returns void
void

Throws
Error if timer has not been started
- Defined in src/services/logging/performanceLogger.ts:394

`Private`formatBytes

formatBytes(bytes: number): string
Private
Format bytes into human-readable format with sign and unit.
Parameters
- bytes: number
  Byte count to format
Returns string
Formatted string with sign ('+' or '-'), value, and unit (B, KB, MB, GB)
- Defined in src/services/logging/performanceLogger.ts:500

`Private`getMemorySnapshot

getMemorySnapshot(): MemorySnapshot
Private
Get current memory usage snapshot.

Returns MemorySnapshot
Current process memory usage snapshot
- Defined in src/services/logging/performanceLogger.ts:443

start

start(): void
Start the timer and initialize memory tracking. Must be called before using checkpoint() or end().

Returns void
void
- Defined in src/services/logging/performanceLogger.ts:345

Class PerformanceTimer

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

debug: (msg: string, ctx?: Record<string, unknown>) => void

error: (msg: string, err?: Error, ctx?: Record<string, unknown>) => void

info: (msg: string, ctx?: Record<string, unknown>) => void

trace: (msg: string, ctx?: Record<string, unknown>) => void

warn: (msg: string, ctx?: Record<string, unknown>) => void

Returns PerformanceTimer

Properties

Privatecheckpoints

Type Declaration

memory: MemorySnapshot

name: string

time: number

Private Optionalcontext

Privatelogger

Type Declaration

debug: (msg: string, ctx?: Record<string, unknown>) => void

error: (msg: string, err?: Error, ctx?: Record<string, unknown>) => void

info: (msg: string, ctx?: Record<string, unknown>) => void

trace: (msg: string, ctx?: Record<string, unknown>) => void

warn: (msg: string, ctx?: Record<string, unknown>) => void

PrivateoperationName

Private OptionalstartMemory

Private OptionalstartTime

Methods

PrivatecalculateMemoryDelta

Parameters

Returns MemoryDelta

PrivatecategorizePerformance

Parameters

Returns string

checkpoint

Parameters

Returns void

Throws

end

Parameters

Returns void

Throws

PrivateformatBytes

Parameters

Returns string

PrivategetMemorySnapshot

Returns MemorySnapshot

start

Returns void

Settings

On This Page

`Private`checkpoints

`Private` `Optional`context

`Private`logger

`Private`operationName

`Private` `Optional`startMemory

`Private` `Optional`startTime

`Private`calculateMemoryDelta

`Private`categorizePerformance

`Private`formatBytes

`Private`getMemorySnapshot