Skip to main content

BenchResult

@webda/bench

Interface: BenchResult

Defined in: packages/bench/src/result.ts:135

Result of one scenario run with one set of parameters

Properties​

backend​

backend: string

Defined in: packages/bench/src/result.ts:147

Backend name: MemoryStore, PostgresStore...

checks​

checks: Record<string, string | number | boolean>

Defined in: packages/bench/src/result.ts:199

Correctness values: lost, duplicated, finalCounter...

durationMs​

durationMs: number

Defined in: packages/bench/src/result.ts:183

Measured duration, in ms

emulated​

emulated: boolean

Defined in: packages/bench/src/result.ts:171

The backend is an emulator (localstack, GCP emulators): numbers are for regression tracking only

env​

env: BenchEnv

Defined in: packages/bench/src/result.ts:219

Environment

errors​

errors: number

Defined in: packages/bench/src/result.ts:179

Failed operations

failures​

failures: string[]

Defined in: packages/bench/src/result.ts:203

Failed correctness checks

latency​

latency: LatencySummary

Defined in: packages/bench/src/result.ts:191

Latency of the successful operations

mode​

mode: "closed" | "open" | "custom"

Defined in: packages/bench/src/result.ts:167

How the load was generated

  • closed: N workers waiting for each operation, measures throughput
  • open: operations started at a fixed rate, latency measured from the scheduled start (no coordinated omission)
  • custom: the scenario measures itself

notes​

notes: string[]

Defined in: packages/bench/src/result.ts:211

Free-form notes: first error messages, skipped variants...

ops​

ops: number

Defined in: packages/bench/src/result.ts:175

Successful operations

params​

params: BenchParams

Defined in: packages/bench/src/result.ts:155

Parameters of the run: concurrency, docSize...

profile​

profile: string

Defined in: packages/bench/src/result.ts:159

Profile used

resources​

resources: ResourceSummary

Defined in: packages/bench/src/result.ts:195

Process resources

scenario​

scenario: string

Defined in: packages/bench/src/result.ts:151

Scenario name, prefixed by the suite: store.get, queue.consume...

schemaVersion​

schemaVersion: number

Defined in: packages/bench/src/result.ts:139

Format version, see BENCH_SCHEMA_VERSION

serviceMetrics?​

optional serviceMetrics?: Record<string, number>

Defined in: packages/bench/src/result.ts:215

Webda metrics of the service under test, delta over the scenario

suite​

suite: string

Defined in: packages/bench/src/result.ts:143

Suite: store, queue, pubsub, blog...

throughput​

throughput: number

Defined in: packages/bench/src/result.ts:187

Successful operations per second

timestamp​

timestamp: string

Defined in: packages/bench/src/result.ts:223

ISO date of the run

unstable​

unstable: boolean

Defined in: packages/bench/src/result.ts:207

More than 1% of errors or a failed check: the numbers are not reliable