Class MetricRecorder

constructor

• new MetricRecorder(idOrOptions?: string | MetricRecorderOptions): MetricRecorder

  Parameters

  • OptionalidOrOptions: string | MetricRecorderOptions

  Returns MetricRecorder

Readonlyid

ReadonlypreferredOperation

size

• get size(): number

  Number of recorded steps.

  Returns number

accumulate

• accumulate<R>(
      fn: (acc: R, entry: StepMetrics, key: string) => R,
      initial: R,
      keys?: ReadonlySet<string>,
  ): R

  Accumulate: reduce steps up to a slider position (progressive view).

  Type Parameters

  • R

  Parameters

  • fn: (acc: R, entry: StepMetrics, key: string) => R
  • initial: R
  • Optionalkeys: ReadonlySet<string>

  Returns R

aggregate

• aggregate<R>(fn: (acc: R, entry: StepMetrics, key: string) => R, initial: R): R

  Aggregate: reduce ALL steps to a single value (dashboards, totals).

  Type Parameters

  • R

  Parameters

  • fn: (acc: R, entry: StepMetrics, key: string) => R
  • initial: R

  Returns R

clear

• clear(): void

  Clear all state — called by executor before each run().

  Returns void

getByKey

• getByKey(runtimeStageId: string): StepMetrics | undefined

  Translate: per-step metrics by runtimeStageId.

  Parameters

  • runtimeStageId: string

  Returns StepMetrics | undefined

getMap

• getMap(): ReadonlyMap<string, StepMetrics>

  All per-step metrics as a read-only Map (insertion-ordered).

  Returns ReadonlyMap<string, StepMetrics>

getMetrics

• getMetrics(): AggregatedMetrics

  Aggregated metrics — computes totals on the fly from per-step data (backward compatible).

  Returns AggregatedMetrics

getStageMetrics

• getStageMetrics(stageName: string): StageMetrics | undefined

  Get aggregated metrics for a specific stage name (backward compatible).

  Parameters

  • stageName: string

  Returns StageMetrics | undefined

onCommit

• onCommit(event: CommitEvent): void

  Parameters

  • event: CommitEvent

  Returns void

onPause

• onPause(event: PauseEvent): void

  Parameters

  • event: PauseEvent

  Returns void

onRead

• onRead(event: ReadEvent): void

  Parameters

  • event: ReadEvent

  Returns void

onStageEnd

• onStageEnd(event: StageEvent): void

  Parameters

  • event: StageEvent

  Returns void

onStageStart

• onStageStart(event: StageEvent): void

  Parameters

  • event: StageEvent

  Returns void

onWrite

• onWrite(event: WriteEvent): void

  Parameters

  • event: WriteEvent

  Returns void

reset

• reset(): void

  Alias for clear() (backward compat).

  Returns void

toSnapshot

• toSnapshot(): {
      data: {
          grandTotal: number;
          numericField: string;
          steps: Record<string, unknown>;
          totalCommits: number;
          totalDuration: number;
          totalPauses: number;
          totalReads: number;
          totalWrites: number;
      };
      description: string;
      name: string;
      preferredOperation: RecorderOperation;
  }

  Expose collected data for inclusion in executor.getSnapshot().recorders.

  Returns {
      data: {
          grandTotal: number;
          numericField: string;
          steps: Record<string, unknown>;
          totalCommits: number;
          totalDuration: number;
          totalPauses: number;
          totalReads: number;
          totalWrites: number;
      };
      description: string;
      name: string;
      preferredOperation: RecorderOperation;
  }

values

• values(): StepMetrics[]

  All per-step metrics (insertion-ordered).

  Returns StepMetrics[]